Skip to content

Commit 8fb14f0

Browse files
committed
docs: Specify where one can find API credentials
1 parent 15afec1 commit 8fb14f0

File tree

5 files changed

+14
-10
lines changed

5 files changed

+14
-10
lines changed

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ While the AI API is in preview, your Cube account team will enable and configure
1717

1818
If you wish to enable or disable the AI API on a specific Cube deployment, you may do so by going to "Settings" in the Cube Cloud sidebar, then "Configuration", and then toggling the "AI API" configuration flag switch.
1919

20-
To find your AI API base URL, go to "Settings" in the Cube Cloud sidebar, then "Connections and APIs"
20+
To find your AI API endpoint in Cube Cloud, go to the <Btn>Overview</Btn> page,
21+
click <Btn>API credentials</Btn>, and choose the <Btn>AI API</Btn> tab.
2122

2223
## Getting Started
2324

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

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,10 @@ and [CORS][ref-cors]. To disallow access to GraphQL API, disable the `graphql`
3939
scope, e.g., by setting the `CUBEJS_DEFAULT_API_SCOPES` environment variable to
4040
`meta,data`.
4141

42-
## Getting started
42+
To find your GraphQL API endpoint in Cube Cloud, go to the <Btn>Overview</Btn>
43+
page, click <Btn>API credentials</Btn>, and choose the <Btn>GraphQL API</Btn> tab.
4344

44-
First, ensure you're running Cube v0.28.58 or later. Then start the project
45-
locally in development mode, and navigate to `http://localhost:4000/` in your
46-
browser. After generating data models and running query you should see the
47-
GraphiQL interface if you click 'GraphiQL' button. If you click the 'Docs'
48-
button in the top-right, you can explore the introspected schema.
45+
## Getting started
4946

5047
As an example, let's use the `orders` cube from the example eCommerce database:
5148

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ While the MDX API is in preview, your Cube account team will enable and configur
2828

2929
If you wish to enable or disable the MDX API on a specific Cube deployment, you may do so by going to "Settings" in the Cube Cloud sidebar, then "Configuration", and then toggling the "Enable MDX API" configuration flag switch.
3030

31-
To find your MDX API's credentials along with XMLA endpoint, go to "Settings" in the Cube Cloud sidebar, then "Connections and APIs"
31+
To find your MDX API credentials and the XMLA endpoint in Cube Cloud, go to the
32+
<Btn>Overview</Btn> page, click <Btn>API credentials</Btn>, and choose the
33+
<Btn>AI API</Btn> tab.
3234

3335
## Using MDX API with Excel
3436

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,9 @@ endpoints.
9393
REST API is enabled by default and secured using [API scopes][self-api-scopes]
9494
and [CORS][self-cors].
9595

96+
To find your REST API endpoint in Cube Cloud, go to the <Btn>Overview</Btn>
97+
page, click <Btn>API credentials</Btn>, and choose the <Btn>REST API</Btn> tab.
98+
9699
### Base path
97100

98101
By default, all REST API endpoints are prefixed with a base path of

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,9 @@ an [example request](#example-request).
181181

182182
### Cube Cloud
183183

184-
**SQL API is enabled by default.** You can find credentials for the SQL API on
185-
the <Btn>Overview</Btn> page by clicking <Btn>Connect to SQL API</Btn>.
184+
**SQL API is enabled by default.** To find your SQL API endpoint and credentials
185+
in Cube Cloud, go to the <Btn>Overview</Btn> page, click <Btn>API credentials</Btn>,
186+
and choose the <Btn>SQL API</Btn> tab.
186187

187188
By default, the SQL API is enabled on port 5432, the user name is `cube`, and
188189
a random string is generated for the password. You can customize these with

0 commit comments

Comments
 (0)