Skip to content

Commit 9ea2d66

Browse files
danciaclaradanciaclara
authored
Merge pull request #254 from makeplane/chore-upate_variable_desctipions
[DOCSW-615] chore: upate variable desctipions
2 parents 6bfbf86 + e52d13e commit 9ea2d66

File tree

207 files changed

+2690
-2309
lines changed

Some content is hidden

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

207 files changed

+2690
-2309
lines changed

‎docs/api-reference/assets/create-workspace-asset-upload.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, assets, create workspace
88

99
<div class="api-endpoint-badge">
1010
<span class="method post">POST</span>
11-
<span class="path">/api/v1/workspaces/{slug}/assets/</span>
11+
<span class="path">/api/v1/workspaces/{workspace_slug}/assets/</span>
1212
</div>
1313

1414
<div class="api-two-column">
@@ -22,9 +22,9 @@ Generate presigned URL for generic asset upload
2222

2323
<div class="params-list">
2424

25-
<ApiParam name="slug" type="string" :required="true">
25+
<ApiParam name="workspace_slug" type="string" :required="true">
2626

27-
Workspace slug
27+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
2828

2929
</ApiParam>
3030

‎docs/api-reference/assets/delete-user-asset.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ Asset ID
5151

5252
```bash
5353
curl -X DELETE \
54-
"https://api.plane.so/api/v1/assets/user-assets/550e8400-e29b-41d4-a716-446655440002/" \
54+
"https://api.plane.so/api/v1/assets/user-assets/asset-uuid/" \
5555
-H "X-API-Key: $PLANE_API_KEY" \
56-
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
56+
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN"
5757
```
5858

5959
</template>
@@ -63,7 +63,7 @@ curl -X DELETE \
6363
import requests
6464

6565
response = requests.delete(
66-
"https://api.plane.so/api/v1/assets/user-assets/550e8400-e29b-41d4-a716-446655440002/",
66+
"https://api.plane.so/api/v1/assets/user-assets/asset-uuid/",
6767
headers={"X-API-Key": "your-api-key"}
6868
)
6969
print(response.status_code)
@@ -73,7 +73,7 @@ print(response.status_code)
7373
<template #javascript>
7474

7575
```javascript
76-
const response = await fetch("https://api.plane.so/api/v1/assets/user-assets/550e8400-e29b-41d4-a716-446655440002/", {
76+
const response = await fetch("https://api.plane.so/api/v1/assets/user-assets/asset-uuid/", {
7777
method: "DELETE",
7878
headers: {
7979
"X-API-Key": "your-api-key",

‎docs/api-reference/assets/get-workspace-asset.md‎

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, assets, get workspace ass
88

99
<div class="api-endpoint-badge">
1010
<span class="method get">GET</span>
11-
<span class="path">/api/v1/workspaces/{slug}/assets/{asset_id}/</span>
11+
<span class="path">/api/v1/workspaces/{workspace_slug}/assets/{asset_id}/</span>
1212
</div>
1313

1414
<div class="api-two-column">
@@ -24,13 +24,13 @@ Get presigned URL for asset download
2424

2525
<ApiParam name="asset_id" type="string" :required="true">
2626

27-
Asset id.
27+
The unique identifier of the asset.
2828

2929
</ApiParam>
3030

31-
<ApiParam name="slug" type="string" :required="true">
31+
<ApiParam name="workspace_slug" type="string" :required="true">
3232

33-
Workspace slug
33+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
3434

3535
</ApiParam>
3636

@@ -54,9 +54,9 @@ Workspace slug
5454

5555
```bash
5656
curl -X GET \
57-
"https://api.plane.so/api/v1/workspaces/my-workspace/assets/550e8400-e29b-41d4-a716-446655440002/" \
57+
"https://api.plane.so/api/v1/workspaces/my-workspace/assets/asset-uuid/" \
5858
-H "X-API-Key: $PLANE_API_KEY" \
59-
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
59+
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN"
6060
```
6161

6262
</template>
@@ -66,7 +66,7 @@ curl -X GET \
6666
import requests
6767

6868
response = requests.get(
69-
"https://api.plane.so/api/v1/workspaces/my-workspace/assets/550e8400-e29b-41d4-a716-446655440002/",
69+
"https://api.plane.so/api/v1/workspaces/my-workspace/assets/asset-uuid/",
7070
headers={"X-API-Key": "your-api-key"}
7171
)
7272
print(response.json())
@@ -76,15 +76,12 @@ print(response.json())
7676
<template #javascript>
7777

7878
```javascript
79-
const response = await fetch(
80-
"https://api.plane.so/api/v1/workspaces/my-workspace/assets/550e8400-e29b-41d4-a716-446655440002/",
81-
{
82-
method: "GET",
83-
headers: {
84-
"X-API-Key": "your-api-key",
85-
},
86-
}
87-
);
79+
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/assets/asset-uuid/", {
80+
method: "GET",
81+
headers: {
82+
"X-API-Key": "your-api-key",
83+
},
84+
});
8885
const data = await response.json();
8986
```
9087

‎docs/api-reference/assets/update-user-asset.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Additional attributes to update for the asset
6363

6464
```bash
6565
curl -X PATCH \
66-
"https://api.plane.so/api/v1/assets/user-assets/550e8400-e29b-41d4-a716-446655440002/" \
66+
"https://api.plane.so/api/v1/assets/user-assets/asset-uuid/" \
6767
-H "X-API-Key: $PLANE_API_KEY" \
6868
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
6969
-H "Content-Type: application/json" \
@@ -84,7 +84,7 @@ curl -X PATCH \
8484
import requests
8585

8686
response = requests.patch(
87-
"https://api.plane.so/api/v1/assets/user-assets/550e8400-e29b-41d4-a716-446655440002/",
87+
"https://api.plane.so/api/v1/assets/user-assets/asset-uuid/",
8888
headers={"X-API-Key": "your-api-key"},
8989
json={
9090
"attributes": {
@@ -102,7 +102,7 @@ print(response.status_code)
102102
<template #javascript>
103103

104104
```javascript
105-
const response = await fetch("https://api.plane.so/api/v1/assets/user-assets/550e8400-e29b-41d4-a716-446655440002/", {
105+
const response = await fetch("https://api.plane.so/api/v1/assets/user-assets/asset-uuid/", {
106106
method: "PATCH",
107107
headers: {
108108
"X-API-Key": "your-api-key",

‎docs/api-reference/assets/update-workspace-asset.md‎

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, assets, update workspace
88

99
<div class="api-endpoint-badge">
1010
<span class="method patch">PATCH</span>
11-
<span class="path">/api/v1/workspaces/{slug}/assets/{asset_id}/</span>
11+
<span class="path">/api/v1/workspaces/{workspace_slug}/assets/{asset_id}/</span>
1212
</div>
1313

1414
<div class="api-two-column">
@@ -24,13 +24,13 @@ Update generic asset after upload completion
2424

2525
<ApiParam name="asset_id" type="string" :required="true">
2626

27-
Asset ID
27+
The unique identifier of the asset.
2828

2929
</ApiParam>
3030

31-
<ApiParam name="slug" type="string" :required="true">
31+
<ApiParam name="workspace_slug" type="string" :required="true">
3232

33-
Workspace slug
33+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
3434

3535
</ApiParam>
3636

@@ -69,7 +69,7 @@ Whether the asset has been successfully uploaded
6969

7070
```bash
7171
curl -X PATCH \
72-
"https://api.plane.so/api/v1/workspaces/my-workspace/assets/550e8400-e29b-41d4-a716-446655440002/" \
72+
"https://api.plane.so/api/v1/workspaces/my-workspace/assets/asset-uuid/" \
7373
-H "X-API-Key: $PLANE_API_KEY" \
7474
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
7575
-H "Content-Type: application/json" \
@@ -85,7 +85,7 @@ curl -X PATCH \
8585
import requests
8686

8787
response = requests.patch(
88-
"https://api.plane.so/api/v1/workspaces/my-workspace/assets/550e8400-e29b-41d4-a716-446655440002/",
88+
"https://api.plane.so/api/v1/workspaces/my-workspace/assets/asset-uuid/",
8989
headers={"X-API-Key": "your-api-key"},
9090
json={
9191
"is_uploaded": true
@@ -98,19 +98,16 @@ print(response.status_code)
9898
<template #javascript>
9999

100100
```javascript
101-
const response = await fetch(
102-
"https://api.plane.so/api/v1/workspaces/my-workspace/assets/550e8400-e29b-41d4-a716-446655440002/",
103-
{
104-
method: "PATCH",
105-
headers: {
106-
"X-API-Key": "your-api-key",
107-
"Content-Type": "application/json",
108-
},
109-
body: JSON.stringify({
110-
is_uploaded: true,
111-
}),
112-
}
113-
);
101+
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/assets/asset-uuid/", {
102+
method: "PATCH",
103+
headers: {
104+
"X-API-Key": "your-api-key",
105+
"Content-Type": "application/json",
106+
},
107+
body: JSON.stringify({
108+
is_uploaded: true,
109+
}),
110+
});
114111
console.log(response.status);
115112
```
116113

‎docs/api-reference/customer/add-customer-property.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, customer, create a custom
88

99
<div class="api-endpoint-badge">
1010
<span class="method post">POST</span>
11-
<span class="path">/api/v1/workspaces/{slug}/customer-properties/</span>
11+
<span class="path">/api/v1/workspaces/{workspace_slug}/customer-properties/</span>
1212
</div>
1313

1414
<div class="api-two-column">
@@ -22,9 +22,9 @@ Create a new customer property in the specified workspace.
2222

2323
<div class="params-list">
2424

25-
<ApiParam name="slug" type="string" :required="true">
25+
<ApiParam name="workspace_slug" type="string" :required="true">
2626

27-
Slug.
27+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
2828

2929
</ApiParam>
3030

‎docs/api-reference/customer/add-customer-request.md‎

Lines changed: 20 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, customer, create a custom
88

99
<div class="api-endpoint-badge">
1010
<span class="method post">POST</span>
11-
<span class="path">/api/v1/workspaces/{slug}/customers/{customer_id}/requests/</span>
11+
<span class="path">/api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/</span>
1212
</div>
1313

1414
<div class="api-two-column">
@@ -24,13 +24,13 @@ Create a new request for the specified customer.
2424

2525
<ApiParam name="customer_id" type="string" :required="true">
2626

27-
Customer id.
27+
The unique identifier of the customer.
2828

2929
</ApiParam>
3030

31-
<ApiParam name="slug" type="string" :required="true">
31+
<ApiParam name="workspace_slug" type="string" :required="true">
3232

33-
Slug.
33+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
3434

3535
</ApiParam>
3636

@@ -93,7 +93,7 @@ Work item ids.
9393

9494
```bash
9595
curl -X POST \
96-
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/requests/" \
96+
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/requests/" \
9797
-H "X-API-Key: $PLANE_API_KEY" \
9898
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
9999
-H "Content-Type: application/json" \
@@ -115,7 +115,7 @@ curl -X POST \
115115
import requests
116116

117117
response = requests.post(
118-
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/requests/",
118+
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/requests/",
119119
headers={"X-API-Key": "your-api-key"},
120120
json={
121121
"name": "Example Name",
@@ -134,23 +134,20 @@ print(response.json())
134134
<template #javascript>
135135

136136
```javascript
137-
const response = await fetch(
138-
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/requests/",
139-
{
140-
method: "POST",
141-
headers: {
142-
"X-API-Key": "your-api-key",
143-
"Content-Type": "application/json",
144-
},
145-
body: JSON.stringify({
146-
name: "Example Name",
147-
description: "example-value",
148-
description_html: "<p>Example content</p>",
149-
link: "https://example.com/resource",
150-
work_item_ids: ["550e8400-e29b-41d4-a716-446655440000"],
151-
}),
152-
}
153-
);
137+
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/requests/", {
138+
method: "POST",
139+
headers: {
140+
"X-API-Key": "your-api-key",
141+
"Content-Type": "application/json",
142+
},
143+
body: JSON.stringify({
144+
name: "Example Name",
145+
description: "example-value",
146+
description_html: "<p>Example content</p>",
147+
link: "https://example.com/resource",
148+
work_item_ids: ["550e8400-e29b-41d4-a716-446655440000"],
149+
}),
150+
});
154151
const data = await response.json();
155152
```
156153

‎docs/api-reference/customer/add-customer.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, customer, create a custom
88

99
<div class="api-endpoint-badge">
1010
<span class="method post">POST</span>
11-
<span class="path">/api/v1/workspaces/{slug}/customers/</span>
11+
<span class="path">/api/v1/workspaces/{workspace_slug}/customers/</span>
1212
</div>
1313

1414
<div class="api-two-column">
@@ -22,9 +22,9 @@ Create a new customer in the specified workspace.
2222

2323
<div class="params-list">
2424

25-
<ApiParam name="slug" type="string" :required="true">
25+
<ApiParam name="workspace_slug" type="string" :required="true">
2626

27-
Slug.
27+
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
2828

2929
</ApiParam>
3030

0 commit comments

Comments
 (0)