Commit message (Collapse) | Author | Age | Files | Lines | |
---|---|---|---|---|---|
* | Add OpenAPI description of the REST API | Benjamin Tissoires | 2019-01-18 | 1 | -0/+27 |
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. |