Skip to content

Commit 1d10321

Browse files
authored
Merge pull request #4789 from Blargian/swagger_hyperdx
ClickStack: add ClickStack reference docs (attempt 3)
2 parents 4698586 + a62a589 commit 1d10321

File tree

3 files changed

+18
-2
lines changed

3 files changed

+18
-2
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
slug: /use-cases/observability/clickstack/api-reference
3+
title: 'API reference'
4+
pagination_prev: null
5+
pagination_next: null
6+
description: 'Landing page for ClickStack API reference docs'
7+
doc_type: 'landing-page'
8+
---
9+
10+
import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';
11+
import {Button} from "@clickhouse/click-ui/bundled";
12+
13+
<CloudNotSupportedBadge/>
14+
15+
For API reference docs, please visit [this page](https://www.clickhouse.com/docs/clickstack/api-reference)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"docusaurus": "docusaurus",
1414
"copy-clickhouse-repo-docs": "bash scripts/copy-clickhouse-repo-docs.sh",
1515
"serve": "docusaurus serve",
16-
"build-swagger": "yarn redocly build-docs https://api.clickhouse.cloud/v1 --output build/cloud/manage/api/swagger.html",
16+
"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",
1717
"prep-from-local": "bash ./scripts/copy-clickhouse-repo-docs.sh -l $1",
1818
"autogenerate-settings": "bash ./scripts/settings/autogenerate-settings.sh",
1919
"autogenerate-table-of-contents": "bash ./scripts/autogenerate-table-of-contents.sh",

sidebars.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1694,7 +1694,8 @@ const sidebars = {
16941694
dirName: "use-cases/observability/clickstack/integration-examples",
16951695
},
16961696
]
1697-
}
1697+
},
1698+
"use-cases/observability/clickstack/api-reference"
16981699
]
16991700
},
17001701
],

0 commit comments

Comments
 (0)