From 758d0dc781ca099daf9628cca4a9c39676df5078 Mon Sep 17 00:00:00 2001 From: Jilles van Gurp Date: Wed, 1 Apr 2026 20:43:25 +0200 Subject: [PATCH] docs: add Redoc API reference for hub spec --- content/open-location-hub/_index.md | 4 +- .../open-location-hub/docs/api-reference.md | 8 +++ layouts/_default/redoc.html | 53 +++++++++++++++++++ 3 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 content/open-location-hub/docs/api-reference.md create mode 100644 layouts/_default/redoc.html diff --git a/content/open-location-hub/_index.md b/content/open-location-hub/_index.md index 50ccd64..8f1e9f3 100644 --- a/content/open-location-hub/_index.md +++ b/content/open-location-hub/_index.md @@ -13,7 +13,7 @@ It is the integration-layer counterpart to Open Location Stack's mapping work: o The current repository is still evolving quickly, but the intended direction is already clear: a production-grade, open source hub that teams can run, extend, adapt, and integrate without being locked into vendor-specific middleware. -The software documentation for the current implementation is published at [Open Location Hub Docs](/open-location-hub/docs/). That section is generated from the repository's `docs/` directory and is intended to stay aligned with the code as the project evolves. +The software documentation for the current implementation is published at [Open Location Hub Docs](/open-location-hub/docs/). The REST contract is available as an interactive [API Reference](/open-location-hub/docs/api-reference/). ## Business value @@ -98,6 +98,8 @@ If you care about interoperable RTLS infrastructure, now is the right time to ge [Browse the generated docs](/open-location-hub/docs/) +[Open the API reference](/open-location-hub/docs/api-reference/) + [Learn about Floor Plan Editor](/floor-plan-editor/) [View the repository on GitHub](https://github.com/Open-Location-Stack/open-location-hub) diff --git a/content/open-location-hub/docs/api-reference.md b/content/open-location-hub/docs/api-reference.md new file mode 100644 index 0000000..1e83ae0 --- /dev/null +++ b/content/open-location-hub/docs/api-reference.md @@ -0,0 +1,8 @@ +--- +title: "API Reference" +description: "Interactive OpenAPI reference for the Open Location Hub REST contract." +draft: false +layout: "redoc" +spec_url: "https://raw.githubusercontent.com/Open-Location-Stack/open-location-hub/main/specifications/openapi/omlox-hub.v0.yaml" +github_url: "https://github.com/Open-Location-Stack/open-location-hub/blob/main/specifications/openapi/omlox-hub.v0.yaml" +--- diff --git a/layouts/_default/redoc.html b/layouts/_default/redoc.html new file mode 100644 index 0000000..915759a --- /dev/null +++ b/layouts/_default/redoc.html @@ -0,0 +1,53 @@ +{{ define "main" }} +
+
+

{{ .Title }}

+ {{ with .Description }} +

{{ . }}

+ {{ end }} + +
+ +
+
+
+
+ + + +{{ end }}