From 986bc2c3db173bb73b11053a5be4d9c624684171 Mon Sep 17 00:00:00 2001 From: Adan Toscano Date: Wed, 13 Sep 2023 14:56:45 +0200 Subject: [PATCH] feat: add example schema to start dev --- CONTRIBUTING.md | 2 +- example.yaml | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 example.yaml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1aa8410..6029c7c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,7 +52,7 @@ npm run build To execute the application run: ```bash -npm start -- -i input/file.yaml +npm start -- -i example.yaml ``` ### Clean diff --git a/example.yaml b/example.yaml new file mode 100644 index 0000000..dd88679 --- /dev/null +++ b/example.yaml @@ -0,0 +1,24 @@ +openapi: 3.1.0 +info: + title: Sample API + description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML. + version: 0.1.9 +servers: + - url: http://api.example.com/v1 + description: Optional server description, e.g. Main (production) server + - url: http://staging-api.example.com + description: Optional server description, e.g. Internal staging server for testing +paths: + /users: + get: + summary: Returns a list of users. + description: Optional extended description in CommonMark or HTML. + responses: + '200': # status code + description: A JSON array of user names + content: + application/json: + schema: + type: array + items: + type: string