-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add example schema to start dev
- Loading branch information
1 parent
fc54104
commit 986bc2c
Showing
2 changed files
with
25 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |