From e259f005c6465542d50985089308b359a71cdd37 Mon Sep 17 00:00:00 2001 From: Tamal Saha Date: Tue, 14 Jul 2026 15:38:44 +0600 Subject: [PATCH] docs(platform): publish versioned interactive API reference (Swagger UI) Move the generated api.html into a leaf bundle under docs/platform/api/reference/ so the aggregator copies it into each versioned docs tree. A tiny index.md stub routes it through a raw-passthrough layout (type: swagger) that serves the self-contained Swagger UI verbatim at /docs/platform//api/reference/. Link it from the API README's OpenAPI paragraph (not the sidebar). Requires the companion layouts/swagger/single.html in the website repo. Signed-off-by: Tamal Saha --- docs/platform/api/README.md | 6 +++--- api.html => docs/platform/api/reference/api.html | 0 docs/platform/api/reference/index.md | 5 +++++ 3 files changed, 8 insertions(+), 3 deletions(-) rename api.html => docs/platform/api/reference/api.html (100%) create mode 100644 docs/platform/api/reference/index.md diff --git a/docs/platform/api/README.md b/docs/platform/api/README.md index e819f24..5c72220 100644 --- a/docs/platform/api/README.md +++ b/docs/platform/api/README.md @@ -29,9 +29,9 @@ marketplace webhook service is a separate listener rooted at `/marketplace/api/v A machine-readable [OpenAPI 3.0.3 specification](../api/openapi.yaml) of this API is also available (`openapi.yaml`) — load it into any OpenAPI tool (Swagger UI, Redoc, -`openapi-generator`) to explore the API or generate a client. A self-contained -Swagger UI viewer (`api.html`, with the spec inlined) is available at the repository -root. +`openapi-generator`) to explore the API or generate a client. A self-contained, +interactive [Swagger UI viewer](../api/reference/) (with the spec inlined) is also +published for this release — open it to browse and try every endpoint in the browser. ## Overview diff --git a/api.html b/docs/platform/api/reference/api.html similarity index 100% rename from api.html rename to docs/platform/api/reference/api.html diff --git a/docs/platform/api/reference/index.md b/docs/platform/api/reference/index.md new file mode 100644 index 0000000..8b37144 --- /dev/null +++ b/docs/platform/api/reference/index.md @@ -0,0 +1,5 @@ +--- +title: Interactive API Reference +type: swagger +layout: single +---