0 Fork 1

mirror of https://github.com/wekan/wekan.git synced 2026-11-05 09:40:20 -05:00

Files

T

Lauri OjansivuandClaude Opus 4.8 b4bbf2480a Add ICS import REST API + OpenAPI + api.py example (#6323 )

Expose the iCalendar (.ics) import as a REST endpoint
POST /api/boards/:boardId/swimlanes/:swimlaneId/lists/:listId/ics (body { ics })
that reuses the shared import logic, requires board write access, and returns
{ created, cardIds }. Document it in the OpenAPI spec (openapi/extra_paths.yml,
spliced into public/api/wekan.yml) and add an 'importics' example command to
api.py. Note the new endpoint in the ChangeLog.

Note: OAUTH2_LOGOUT_ENDPOINT (the only new env var in the Upcoming changelog) is
already present in all deployment configs (Dockerfile, docker-compose.yml,
snap-src/bin/config, start-wekan.sh/.bat); rebuild-wekan.sh/.bat are dev-run
scripts with no OAUTH2 section, so nothing was added there.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

2026-06-20 20:58:36 +03:00

extra_paths.yml

Add ICS import REST API + OpenAPI + api.py example (#6323 )

2026-06-20 20:58:36 +03:00

generate_openapi.py

Fix duplicate mapping keys in generated OpenAPI spec breaking API docs

2026-06-19 16:09:16 +03: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