Skip to content

Commit ce5425e

Browse files
authored
Reflect TypeDB Cloud renames in Docs (#928)
## What is the goal of this PR? We reflect the TypeDB Cloud rename of "organizations" to "teams" and "projects" to "spaces" in TypeDB Docs. ## What are the changes implemented in this PR? We update the content of the `cloud` documentation section to ensure that prose as well as API URLs are correct.
1 parent 72bab0d commit ce5425e

File tree

4 files changed

+61
-61
lines changed

4 files changed

+61
-61
lines changed

manual/modules/ROOT/pages/cloud/api/index.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ https://cloud.typedb.com/sign-up.
88

99
== Generate an API Token
1010

11-
1. Visit your https://cloud.typedb.com/?org_action=/settings[organization settings] page,
11+
1. Visit your https://cloud.typedb.com/?team_action=/settings[team settings] page,
1212
scroll to the API tokens section, and click "Generate API Token".
1313

14-
2. Give your API token a descriptive name, and appropriate access to your chosen project.
14+
2. Give your API token a descriptive name, and appropriate access to your chosen space.
1515
See the xref:{page-version}@manual::cloud/api/reference.adoc#accesslevels[API reference] for detailed access level info.
1616

1717
3. Generate your API token and copy the displayed client ID and client secret for later use when authenticating.
@@ -79,8 +79,8 @@ The response body will be your access token.
7979
====
8080
For security, your access token will expire after 1 hour.
8181
====
82-
. Make an API request to list clusters in the project you selected for your API token.
83-
The example below targets the `default` project in an organization called `my-org`.
82+
. Make an API request to list clusters in the space you selected for your API token.
83+
The example below targets the `default` space in an team called `my-team`.
8484
You will use the access token you generated in the previous step to authenticate this request.
8585
+
8686
[tabs]
@@ -90,7 +90,7 @@ curl::
9090
[source,console]
9191
----
9292
curl --request GET \
93-
--url https://cloud.typedb.com/api/org/ORG_ID/projects/PROJECT_ID/clusters \
93+
--url https://cloud.typedb.com/api/team/TEAM_ID/spaces/SPACE_ID/clusters \
9494
--header 'Authorization: Bearer {ACCESS-TOKEN}'
9595
----
9696
@@ -100,7 +100,7 @@ Python::
100100
----
101101
import requests
102102
103-
url = "https://cloud.typedb.com/api/org/my-org/projects/default/clusters"
103+
url = "https://cloud.typedb.com/api/team/my-team/spaces/default/clusters"
104104
105105
headers = {
106106
"Authorization": "Bearer {ACCESS-TOKEN}"
@@ -119,7 +119,7 @@ use reqwest;
119119
async fn main() -> Result<(), Box<dyn std::error::Error>> {
120120
let client = reqwest::Client::new();
121121
let resp = client
122-
.get("https://cloud.typedb.com/api/org/my-org/projects/default/clusters")
122+
.get("https://cloud.typedb.com/api/team/my-team/spaces/default/clusters")
123123
.header(reqwest::header::AUTHORIZATION, "Bearer {ACCESS-TOKEN}")
124124
.send().await;
125125
Ok(())
@@ -138,8 +138,8 @@ It will return information about the clusters in a JSON format, as below
138138
"isFree":true,
139139
"status":"running",
140140
"createdAt":1738256490070,
141-
"organizationID":"my-org",
142-
"projectID":"default",
141+
"teamID":"my-team",
142+
"spaceID":"default",
143143
"version":"3.0.6",
144144
"provider":"gcp",
145145
"region":"europe-west2",
@@ -157,7 +157,7 @@ It will return information about the clusters in a JSON format, as below
157157

158158
== Next Steps
159159

160-
Now that you know how to list the clusters in your project from the API,
160+
Now that you know how to list the clusters in your space from the API,
161161
you can explore TypeDB Cloud further, either through further API use or back on the website.
162162

163163
[cols-2]

0 commit comments

Comments
 (0)