mirror of
https://github.com/mailscope/kumomta.git
synced 2026-09-06 02:28:56 +00:00
Wez Furlong
0b87c020b4
Adds `/api-docs/openapi.json` and `/rapidoc` endpoints to both kumod and tsa-daemon. The former exposes the subset of the API that is expressable in the openapi schema as a json file that can be imported into other tools. The latter is a single-page web app that consumes the former to provide an interactive API explorer. We're using rapidoc for this, because I happen to think it looks nicest and easiest to use, and we can integrate it into the docs fairly nicely. Which leads in nicely to say: I've integrated a read-only version of rapidoc into the docs, and it even detects and adjusts to the selected light/dark mode. The `docs/update-openapi.sh` extracts the openapi.json data from kumod and tsa-daemon and outputs to the correct place in the docs directory structure to enable this. refs: https://github.com/KumoCorp/kumomta/issues/96
9 lines
416 B
Bash
Executable File
9 lines
416 B
Bash
Executable File
#!/bin/sh
|
|
# This script updates the snapshot of the openapi specs for our
|
|
# various services, so that the mkdocs build can consume them
|
|
# to render the docs in the docs.
|
|
# It needs to be run manually after changing anything to do with the
|
|
# HTTP APIs.
|
|
./target/debug/kumod --dump-openapi-spec > docs/reference/kumod.openapi.json
|
|
./target/debug/tsa-daemon --dump-openapi-spec > docs/reference/tsa-daemon.openapi.json
|