Skip to content

Commit 60cff30

Browse files
authored
docs: Move API references (#9214)
* Move SQL API reference * Move REST API reference * Move GraphQL API reference * Move AI API reference * Move CLI command reference * Move JavaScript SDK reference
1 parent 448a37a commit 60cff30

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+197
-156
lines changed

docs/pages/guides/dbt.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ of the REST API.
353353
[ref-dimension-types]: /reference/data-model/types-and-formats#dimension-types
354354
[ref-data-graph]: /product/workspace/data-model#data-graph
355355
[ref-playground]: /product/workspace/playground
356-
[ref-rest-api-meta]: /reference/rest-api#v1meta
356+
[ref-rest-api-meta]: /product/apis-integrations/rest-api/reference#v1meta
357357

358358
[link-dbt-docs]: https://docs.getdbt.com/docs/build/projects
359359
[link-dbt-docs-structure]: https://docs.getdbt.com/guides/best-practices/how-we-structure/1-guide-overview#guide-structure-overview

docs/pages/guides/recipes/data-exploration/cast-numerics.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,5 +152,5 @@ you work with "safe integers".
152152
[link-js-numbers]: https://www.w3schools.com/js/js_numbers.asp
153153
[link-mdn-max-safe-integer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
154154

155-
[ref-cube-core]: /reference/frontend/cubejs-client-core
156-
[ref-cube-core-cast-numerics]: /reference/frontend/cubejs-client-core#loadmethodoptions
155+
[ref-cube-core]: http://localhost:3000/product/apis-integrations/javascript-sdk/reference/cubejs-client-core
156+
[ref-cube-core-cast-numerics]: http://localhost:3000/product/apis-integrations/javascript-sdk/reference/cubejs-client-core#loadmethodoptions

docs/pages/guides/recipes/data-exploration/drilldowns.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,6 @@ cubes:
9999
You can follow [this tutorial][blog-drilldown-api] to learn more about building
100100
a UI for drilldowns.
101101
102-
[ref-cube-client-ref-resultset-drilldown]: /reference/frontend/cubejs-client-core#drill-down
102+
[ref-cube-client-ref-resultset-drilldown]: /product/apis-integrations/javascript-sdk/reference/cubejs-client-core#drilldown
103103
[blog-drilldown-api]: https://cube.dev/blog/introducing-a-drill-down-table-api-in-cubejs/
104104
[ref-schema-ref-measures]: /reference/data-model/measures

docs/pages/guides/recipes/queries/getting-unique-values-for-a-field.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ dropdown on the dashboard:
9090

9191
In case we need to choose a dimension or render dropdowns for all dimensions, we
9292
can fetch the list of dimensions for all cubes from the
93-
[`/meta` endpoint](/reference/rest-api#v1meta):
93+
[`/meta` endpoint](/product/apis-integrations/rest-api/reference#v1meta):
9494

9595
```bash
9696
curl http://localhost:4000/cubejs-api/v1/meta

docs/pages/product/apis-integrations/ai-api.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Use the `runQuery` request parameter to have the AI API run the query and report
108108
}
109109
```
110110

111-
The response will be the same as above, followed by a second JSON object representing the response (see the [REST API reference](/reference/rest-api#v1load) for its format).
111+
The response will be the same as above, followed by a second JSON object representing the response (see the [REST API reference](/product/apis-integrations/rest-api/reference#v1load) for its format).
112112

113113
<InfoBox>
114114
Note that the response now contains two JSON objects separated by a newline
@@ -117,7 +117,7 @@ The response will be the same as above, followed by a second JSON object represe
117117

118118
#### 2. `/load`
119119

120-
Alternatively, you may take the generated `cube_query` from the response and then call the [REST API `/load` endpoint](/reference/rest-api#v1load) with it in the `/load` request body. This is recommended for advanced use-cases where you need more control over formatting, pagination, etc. or if you are adding the AI API to an existing Cube REST API implementation.
120+
Alternatively, you may take the generated `cube_query` from the response and then call the [REST API `/load` endpoint](/product/apis-integrations/rest-api/reference#v1load) with it in the `/load` request body. This is recommended for advanced use-cases where you need more control over formatting, pagination, etc. or if you are adding the AI API to an existing Cube REST API implementation.
121121

122122
### Error Handling
123123

@@ -262,4 +262,4 @@ deployment. See below for required variables by provider (required unless noted)
262262
- `OPENAI_API_KEY` - An OpenAI API key (we recommend creating a service account for the AI API)
263263

264264

265-
[ref-ref-ai-api]: /reference/ai-api
265+
[ref-ref-ai-api]: /product/apis-integrations/ai-api/reference
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
module.exports = {
22
"privacy-security": "Privacy and Security",
3+
"reference": "Reference"
34
};
File renamed without changes.

docs/pages/product/apis-integrations/graphql-api.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,10 +233,10 @@ to our query as follows:
233233
[ref-cors]: /product/apis-integrations/rest-api#configuration-cors
234234
[graphql]: https://graphql.org
235235
[cube-ea]: https://cube.dev/use-cases/embedded-analytics
236-
[ref-ref-graphql-api]: /reference/graphql-api
236+
[ref-ref-graphql-api]: /product/apis-integrations/graphql-api/reference
237237
[ref-websockets]: /product/apis-integrations/rest-api/real-time-data-fetch#web-sockets
238238
[ref-subscriptions]: /product/apis-integrations/rest-api/real-time-data-fetch#client-subscriptions
239239
[ref-compare-date-range]: /product/apis-integrations/queries#compare-date-range-query
240-
[ref-metadata]: /reference/rest-api#v1meta
241-
[ref-pivot-config]: /reference/frontend/cubejs-client-core#pivotconfig
240+
[ref-metadata]: /product/apis-integrations/rest-api/reference#v1meta
241+
[ref-pivot-config]: /product/apis-integrations/javascript-sdk/reference/cubejs-client-core#pivotconfig
242242
[ref-segments]: /reference/data-model/segments
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
"reference": "Reference"
3+
}

docs/pages/reference/graphql-api.mdx renamed to docs/pages/product/apis-integrations/graphql-api/reference.mdx

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
---
2-
redirect_from:
3-
- /backend/graphql
4-
---
5-
61
# GraphQL API reference
72

83
[GraphQL API][ref-graphql-api] supports the following requests and parameters.

0 commit comments

Comments
 (0)