The Open Source kanban (built with Meteor). Keep variable/table/field names camelCase. For translations, only add Pull Request changes to wekan/i18n/en.i18n.json , other translations are done at https://transifex.com/wekan/wekan only.

real-time javascript foss meteor docker-image wekan kanban sandstorm snapcraft

History

Benjamin Tissoires ebe39771a6 openapi: actually catch the error when esprima fails at parsing the file `39f8a138d7` added a try/except around esprima to catch any hard error from the parsing, but the returned value was not checked. We now have the file models/exportExcel.js which gives us an unexpected symbol on line 3 (not sure why it is not happy), but that fails the generation of the doc entirely. Fixes #3884 Signed-off-by: Benjamin Tissoires <benjamin.tissoires@gmail.com>	4 years ago
..
README.md	- More whitelabeling.	6 years ago
generate_openapi.py	openapi: actually catch the error when esprima fails at parsing the file	4 years ago

Benjamin Tissoires ebe39771a6 openapi: actually catch the error when esprima fails at parsing the file

39f8a138d7 added a try/except around esprima to catch any hard error
from the parsing, but the returned value was not checked.

We now have the file models/exportExcel.js which gives us an unexpected
symbol on line 3 (not sure why it is not happy), but that fails the
generation of the doc entirely.

Fixes #3884

Signed-off-by: Benjamin Tissoires <benjamin.tissoires@gmail.com>

4 years ago

README.md - More whitelabeling. 6 years ago

generate_openapi.py openapi: actually catch the error when esprima fails at parsing the file 4 years ago

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