summaryrefslogtreecommitdiffstats
path: root/openapi/generate_openapi.py
Commit message (Collapse)AuthorAgeFilesLines
* openAPI: also handle `export` statement in the scriptsBenjamin Tissoires2019-05-141-1/+1
| | | | | | The files are actually modules, not plain scripts, and thus we are allowed to use `export`. Without `parseModule`, the script would silently fail when parsing `export.js` and the export function will not be present.
* openapi: make the code python 3.5 compatibleBenjamin Tissoires2019-01-181-68/+72
| | | | | | | | | | It is common to use Ubuntu 16.04 to build snaps. For example, the official docker container to build snaps is using this old distribution. However, Ubuntu 16.04 ships Python 3.5.X which is not compatible with the f-strings in generate_openapi.py. This is sad, because we need to use the `.format()` syntax to make it compatible.
* Add OpenAPI description of the REST APIBenjamin Tissoires2019-01-181-0/+911
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.