Skip to content

Commit e259f00

Browse files
committed
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/<version>/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 <tamal@appscode.com>
1 parent b72eb22 commit e259f00

3 files changed

Lines changed: 8 additions & 3 deletions

File tree

docs/platform/api/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ marketplace webhook service is a separate listener rooted at `/marketplace/api/v
2929

3030
A machine-readable [OpenAPI 3.0.3 specification](../api/openapi.yaml) of this API is
3131
also available (`openapi.yaml`) — load it into any OpenAPI tool (Swagger UI, Redoc,
32-
`openapi-generator`) to explore the API or generate a client. A self-contained
33-
Swagger UI viewer (`api.html`, with the spec inlined) is available at the repository
34-
root.
32+
`openapi-generator`) to explore the API or generate a client. A self-contained,
33+
interactive [Swagger UI viewer](../api/reference/) (with the spec inlined) is also
34+
published for this release — open it to browse and try every endpoint in the browser.
3535

3636
## Overview
3737

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Interactive API Reference
3+
type: swagger
4+
layout: single
5+
---

0 commit comments

Comments
 (0)