0 Fork 1

mirror of https://github.com/wekan/wekan.git synced 2026-11-05 15:45:01 -05:00

Files

T

History

Lauri Ojansivu 582a22c291 Fix GitHub code scanning code-quality findings.

Real faults: a card's original-position description formatted a promise
because it did not await the history; the attachment swipe distances and
two drag-scroll locals were undeclared globals; a file that cannot be read
during a GridFS upload left the upload open; api.py called exit() instead of
sys.exit(); a rules test redefined a property and a security-log test kept
an unreachable branch. Also 31 missing semicolons, unused imports in the
card details, exporters and attachment API, unused Python imports, and
comments on empty except clauses. The list-sync scanner test cut its source
at the last Meteor.startup, which the new index startup of #6855 had moved.

Thanks to GitHub CodeQL and xet7 !

2026-11-02 14:15:02 +02:00

extra_paths.yml

Add REST API for Board Settings / Board View, and OpenAPI blocks for the card settings routes.

2026-09-11 21:18:35 +03:00

generate_openapi.py

Fix GitHub code scanning code-quality findings.

2026-11-02 14:15:02 +02:00

README.md

feat: enhance API documentation and add board-related endpoints

2025-06-23 20:01:38 +00: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 v7.92 > ../public/api/wekan.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