Created
November 14, 2022 14:43
-
-
Save syntaxaire/9e584c63ac4ce71c7eda882a4d6837dc to your computer and use it in GitHub Desktop.
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
{ | |
"openapi": "3.0.0", | |
"info": { | |
"title": "API Documentation", | |
"description": "Test documentation", | |
"contact": { | |
"name": "Support", | |
"email": "[email protected]" | |
}, | |
"version": "v4", | |
"x-logo": { | |
"url": "https://example.com/logo.png" | |
} | |
}, | |
"servers": [ | |
{ | |
"url": "https://app.example.com/api/v4", | |
"description": "Server" | |
} | |
], | |
"paths": { | |
"/things/{id}/download.json": { | |
"get": { | |
"tags": [ | |
"Things" | |
], | |
"summary": "Download the Thing", | |
"operationId": "Thing#download", | |
"description": "Download the completed Thing", | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"description": "The unique identifier for the Thing", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int64" | |
} | |
} | |
], | |
"responses": { | |
"303": { | |
"description": "See Other" | |
}, | |
"400": { | |
"description": "Bad Request", | |
"content": { | |
"application/json": {} | |
} | |
}, | |
"401": { | |
"description": "Unauthorized", | |
"content": { | |
"application/json": {} | |
} | |
}, | |
"404": { | |
"description": "Not Found", | |
"content": { | |
"application/json": {} | |
} | |
}, | |
"429": { | |
"description": "Too Many Requests", | |
"content": { | |
"application/json": {} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"tags": [ | |
{ | |
"name": "Things", | |
"description": "A bunch of things" | |
} | |
] | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment