8 Commits (431d884e8371dfbce6d151493044ffcd2a92d10d)

Author	SHA1	Message	Date
Benjamin Tissoires	431d884e83	openapi: fix jsdoc/operation matching ... The script was considering that the operation associated to a jsdoc was declared on the line just after the end of the jsdoc. Turns out that adding new lines makes the code clearer, but the python script was then ignoring some jsdocs. Change the behaviour to consider that the jsdoc associated with an operation is the last one declared after the end of the previous operation. Fixes #3169	6 years ago
Benjamin Tissoires	3f059ec1e0	generate_openapi: fix enums when they are declared as const ... Fixes: #2781	6 years ago
Benjamin Tissoires	8cb3974eff	generate_openapi: print a more useful error ... ...when we can not parse a SchemaProperty	6 years ago
Benjamin Tissoires	7d62d0920c	generate_openapi: add a little bit more verbosity when we get an Error	6 years ago
Benjamin Tissoires	b787854289	generate_openapi.py: use the logging module ... Instead of dealing with custom writes to stderr, it's always better to rely on standard libraries.	6 years ago
Benjamin Tissoires	1eea102f26	openAPI: also handle `export` statement in the scripts ... 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.	7 years ago
Benjamin Tissoires	8be7eec2ca	openapi: make the code python 3.5 compatible ... 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.	7 years ago
Benjamin Tissoires	49d3eb5a3f	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.	7 years ago