wekan

Commit Graph

Author	SHA1	Message	Date
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

Author

SHA1

Message

Date

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

1 Commits (acc44935179cda665454d450ec246377f41f5afb)