Skip to content

Commit

Permalink
feat: add example schema to start dev
Browse files Browse the repository at this point in the history
  • Loading branch information
adantoscano committed Sep 13, 2023
1 parent fc54104 commit 986bc2c
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
24 changes: 24 additions & 0 deletions example.yaml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 986bc2c

Please # to comment.