mirror of https://github.com/wekan/wekan.git synced 2025-12-16 07:20:12 +01:00

History

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	2020-06-17 05:15:39 +02:00
..
generate_openapi.py	openapi: fix jsdoc/operation matching	2020-06-17 05:15:39 +02:00
README.md	- More whitelabeling.	2019-03-21 20:27:21 +02:00

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

2020-06-17 05:15:39 +02:00

generate_openapi.py

openapi: fix jsdoc/operation matching

2020-06-17 05:15:39 +02:00

README.md

- More whitelabeling.

2019-03-21 20:27:21 +02:00

README.md

OpenAPI tools and doc generation

Open API generation

This folder contains a script (generate_openapi.py) that extracts the REST API of Wekan and exports it under the OpenAPI 2.0 specification (Swagger 2.0).

dependencies

python3
esprima-python

calling the tool

python3 generate_openapi.py --release v1.65 > ../public/wekan_api.yml

Generating docs

Now that we have the OpenAPI, it's easy enough to convert the YAML file into some nice Markdown with shins and api2html, or even ReDoc:

api2html -c ../public/logo-header.png -o api.html ../public/wekan_api.yml

redoc-cli serve ../public/wekan_api.yml