diff options
| author | Benjamin Tissoires <benjamin.tissoires@redhat.com> | 2018-07-17 10:14:26 +0200 |
|---|---|---|
| committer | Benjamin Tissoires <benjamin.tissoires@redhat.com> | 2019-01-18 17:01:11 +0100 |
| commit | 49d3eb5a3f21fad1eb2952eb3da2f93c5c5d6272 (patch) | |
| tree | 63794ef5b81e5814387636563d4ae5d054269978 /models | |
| parent | 889aa6d65208db2f3f364cc37a29be9325fa186a (diff) | |
| download | wekan-49d3eb5a3f21fad1eb2952eb3da2f93c5c5d6272.tar.gz wekan-49d3eb5a3f21fad1eb2952eb3da2f93c5c5d6272.tar.bz2 wekan-49d3eb5a3f21fad1eb2952eb3da2f93c5c5d6272.zip | |
Add OpenAPI description of the REST API
The API is generated by a custom script that parses the models directory.
Once the API is generated, tools like https://editor.swagger.io/ or
Python bravado can parse the file and generate a language friendly API.
Note that the tool generate an OpenAPI 2.0 version because bravado
doesn't handle OpenAPI 3.0.
The script also parses the JSDoc with a custom parser to allow
customization of the description of the fields.
Diffstat (limited to 'models')
0 files changed, 0 insertions, 0 deletions