Skip to content

Commit 47a651c

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/, and registers an entry in the API sidebar. Also link it from the API Reference landing page. Requires the companion layouts/swagger/single.html in the website repo. Signed-off-by: Tamal Saha <tamal@appscode.com>
1 parent b72eb22 commit 47a651c

3 files changed

Lines changed: 21 additions & 0 deletions

File tree

docs/platform/api/_index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,11 @@ menu:
88
menu_name: docsplatform_{{.version}}
99
section_menu_id: api
1010
---
11+
12+
# API Reference
13+
14+
Browse the KubeDB Platform REST API by topic using the sections in the sidebar.
15+
16+
For a live, try-it-out view of every endpoint, open the
17+
[**Interactive API Reference**](../reference/) — a self-contained Swagger UI
18+
generated from the OpenAPI spec for this release.
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Interactive API Reference
3+
type: swagger
4+
layout: single
5+
menu:
6+
docsplatform_{{.version}}:
7+
identifier: api-reference-interactive
8+
name: Interactive API Reference
9+
parent: api
10+
weight: 5
11+
menu_name: docsplatform_{{.version}}
12+
section_menu_id: api
13+
---

0 commit comments

Comments
 (0)