mirror of https://github.com/wekan/wekan.git synced 2025-09-22 01:50:48 +02:00

History

Benjamin Tissoires ae30b1220a openapi: better handle nested schemas there is a 2 levels schemas in profile.notifications. The code previously assumed we could only have one level, and so was not producing the correct UsersProfileNotifications. Fix that by being more generic in the way we retrieve the nested subschemas.	2021-04-27 10:44:27 +02:00
..
generate_openapi.py	openapi: better handle nested schemas	2021-04-27 10:44:27 +02:00
README.md	- More whitelabeling.	2019-03-21 20:27:21 +02:00

Benjamin Tissoires ae30b1220a openapi: better handle nested schemas

there is a 2 levels schemas in profile.notifications.

The code previously assumed we could only have one level, and so was not
producing the correct UsersProfileNotifications.

Fix that by being more generic in the way we retrieve the nested
subschemas.

2021-04-27 10:44:27 +02:00

generate_openapi.py

openapi: better handle nested schemas

2021-04-27 10:44:27 +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