Skip to content

Commit 232c626

Browse files
committed
docs: Add a link to OpenAPI docs
1 parent 9d6ab17 commit 232c626

File tree

3 files changed

+24
-13
lines changed

3 files changed

+24
-13
lines changed

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Specifically, you can send the AI API a message (or conversation of messages) an
1111
your Cube representative to have it enabled for your account.
1212
</WarningBox>
1313

14+
See [AI API reference][ref-ref-ai-api] for the list of supported API endpoinsts.
15+
1416
## Configuration
1517

1618
While the AI API is in preview, your Cube account team will enable and configure it for you.
@@ -217,4 +219,7 @@ deployment. See below for required variables by provider (required unless noted)
217219
#### OpenAI
218220

219221
- `OPENAI_MODEL` - An OpenAI chat model ID, for example `gpt-4o`
220-
- `OPENAI_API_KEY` - An OpenAI API key (we recommend creating a service account for the AI API)
222+
- `OPENAI_API_KEY` - An OpenAI API key (we recommend creating a service account for the AI API)
223+
224+
225+
[ref-ref-ai-api]: /reference/ai-api

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

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,16 @@ data applications, including but not limited to the following ones:
1616
Often, the REST API is used to enable [embedded analytics][cube-ea] and
1717
[real-time analytics][cube-rta] use cases.
1818

19+
See [REST API reference][ref-ref-rest-api] for the list of supported API endpoinsts.
20+
Also, check [query format][ref-rest-query-format] for details about query syntax.
21+
22+
<InfoBox>
23+
24+
You can find a mostly complete OpenAPI documentation for the REST API in the
25+
linked [`openspec.yml` file][gh-cube-openspec] that you can use with tools like Swagger.
26+
27+
</InfoBox>
28+
1929
<InfoBox>
2030

2131
If you've chosen [GraphQL][graphql] as a query language for your front-end
@@ -24,10 +34,9 @@ provides.
2434

2535
</InfoBox>
2636

27-
Under the hood, REST API also provides endpoints for [GraphQL
28-
API][ref-graphql-api] and [Orchestration API][ref-orchestration-api]. However,
29-
they target specific use cases and are not usually considered part of the REST
30-
API.
37+
REST API also provides endpoints for [GraphQL API][ref-graphql-api] and
38+
[Orchestration API][ref-orchestration-api]. However, they target specific use
39+
cases and are not considered part of the REST API.
3140

3241
## Example request
3342

@@ -84,10 +93,6 @@ curl \
8493
http://localhost:4000/cubejs-api/v1/meta | jq
8594
```
8695

87-
Check [query format][ref-rest-query-format] for details about supported queries.
88-
Also, check [REST API reference][ref-ref-rest-api] for the list of supported API
89-
endpoints.
90-
9196
## Configuration
9297

9398
REST API is enabled by default and secured using [API scopes][self-api-scopes]
@@ -291,3 +296,4 @@ example, the following query will retrieve rows 101-200 from the `Orders` cube:
291296
[self-cors]: #configuration-cors
292297
[ref-ref-rest-api]: /reference/rest-api
293298
[link-jq-utility]: https://jqlang.github.io/jq/
299+
[gh-cube-openspec]: https://github.com/cube-js/cube/blob/master/packages/cubejs-api-gateway/openspec.yml

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ but not limited to the following ones:
2020
Often, the SQL API is used to enable internal or self-serve [business
2121
intelligence][cube-bi-use-case] use cases.
2222

23+
See [SQL API reference][ref-ref-sql-api] for the list of supported SQL commands,
24+
functions, and operators. Also, check [query format][ref-sql-query-format] for
25+
details about supported queries.
26+
2327
<InfoBox>
2428

2529
Please use [this GitHub issue](https://github.com/cube-js/cube/issues/3906) to
@@ -78,10 +82,6 @@ WHERE table_schema = 'public';
7882
\d
7983
```
8084

81-
Check [query format][ref-sql-query-format] for details about supported queries.
82-
Also, check [SQL API reference][ref-ref-sql-api] for the list of supported SQL
83-
commands, functions, and operators.
84-
8585
## Fundamentals
8686

8787
In the SQL API, each cube or view from the [data model][ref-data-model-concepts]

0 commit comments

Comments
 (0)