From a03fef3d33271bc7b2666ecd918d03496ea4ecdf Mon Sep 17 00:00:00 2001
From: Shaun Struwig <41984034+Blargian@users.noreply.github.com>
Date: Tue, 25 Nov 2025 11:37:27 +0100
Subject: [PATCH 1/4] Add ClickStack reference docs
---
package.json | 2 +-
sidebars.js | 5 +++++
2 files changed, 6 insertions(+), 1 deletion(-)
diff --git a/package.json b/package.json
index 5a410f750d6..d1699cf39eb 100644
--- a/package.json
+++ b/package.json
@@ -13,7 +13,7 @@
"docusaurus": "docusaurus",
"copy-clickhouse-repo-docs": "bash scripts/copy-clickhouse-repo-docs.sh",
"serve": "docusaurus serve",
- "build-swagger": "yarn redocly build-docs https://api.clickhouse.cloud/v1 --output build/cloud/manage/api/swagger.html",
+ "build-swagger": "yarn redocly build-docs https://api.clickhouse.cloud/v1 --output build/cloud/manage/api/swagger.html && yarn redocly build-docs https://raw.githubusercontent.com/hyperdxio/hyperdx/refs/heads/main/packages/api/openapi.json --output build/clickstack/api-reference/index.html",
"prep-from-local": "bash ./scripts/copy-clickhouse-repo-docs.sh -l $1",
"autogenerate-settings": "bash ./scripts/settings/autogenerate-settings.sh",
"autogenerate-table-of-contents": "bash ./scripts/autogenerate-table-of-contents.sh",
diff --git a/sidebars.js b/sidebars.js
index 90aae3e2c8c..ea83342ae17 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -1694,6 +1694,11 @@ const sidebars = {
dirName: "use-cases/observability/clickstack/integration-examples",
},
]
+ },
+ {
+ type: "link",
+ label: "API reference",
+ href: "/clickstack/api-reference",
}
]
},
From fe19fb23b3dd217d4ff06bbab9ef46cf6f8c6ea7 Mon Sep 17 00:00:00 2001
From: Shaun Struwig <41984034+Blargian@users.noreply.github.com>
Date: Tue, 25 Nov 2025 11:52:37 +0100
Subject: [PATCH 2/4] update sidebar
---
sidebars.js | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/sidebars.js b/sidebars.js
index ea83342ae17..7d347d059f4 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -1698,7 +1698,7 @@ const sidebars = {
{
type: "link",
label: "API reference",
- href: "/clickstack/api-reference",
+ href: "https://clickhouse.com/docs/clickstack/api-reference",
}
]
},
From 4d093b43a451316c9333d9995f4730a29a6c4bbb Mon Sep 17 00:00:00 2001
From: Shaun Struwig <41984034+Blargian@users.noreply.github.com>
Date: Tue, 25 Nov 2025 14:20:00 +0100
Subject: [PATCH 3/4] add landing page to redirect to OpenAPI spec
---
.../observability/clickstack/api-reference.md | 15 +++++++++++++++
sidebars.js | 6 +-----
2 files changed, 16 insertions(+), 5 deletions(-)
create mode 100644 docs/use-cases/observability/clickstack/api-reference.md
diff --git a/docs/use-cases/observability/clickstack/api-reference.md b/docs/use-cases/observability/clickstack/api-reference.md
new file mode 100644
index 00000000000..1f45f04bca0
--- /dev/null
+++ b/docs/use-cases/observability/clickstack/api-reference.md
@@ -0,0 +1,15 @@
+---
+slug: /use-cases/observability/clickstack/api-reference
+title: 'API reference'
+pagination_prev: null
+pagination_next: null
+description: 'Landing page for ClickStack API reference docs'
+doc_type: 'landing-page'
+---
+
+import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';
+import {Button} from "@clickhouse/click-ui/bundled";
+
+
+
+For API reference docs, please visit [this page](/docs/clickstack/api-reference)
diff --git a/sidebars.js b/sidebars.js
index 7d347d059f4..db1f825be99 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -1695,11 +1695,7 @@ const sidebars = {
},
]
},
- {
- type: "link",
- label: "API reference",
- href: "https://clickhouse.com/docs/clickstack/api-reference",
- }
+ "use-cases/observability/clickstack/api-reference"
]
},
],
From a62a5892e2d7c5d6c94b5243434f1e44a8b2e92d Mon Sep 17 00:00:00 2001
From: Shaun Struwig <41984034+Blargian@users.noreply.github.com>
Date: Tue, 25 Nov 2025 14:46:03 +0100
Subject: [PATCH 4/4] fix link
---
docs/use-cases/observability/clickstack/api-reference.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/use-cases/observability/clickstack/api-reference.md b/docs/use-cases/observability/clickstack/api-reference.md
index 1f45f04bca0..5aa98ed9a20 100644
--- a/docs/use-cases/observability/clickstack/api-reference.md
+++ b/docs/use-cases/observability/clickstack/api-reference.md
@@ -12,4 +12,4 @@ import {Button} from "@clickhouse/click-ui/bundled";
-For API reference docs, please visit [this page](/docs/clickstack/api-reference)
+For API reference docs, please visit [this page](https://www.clickhouse.com/docs/clickstack/api-reference)