Skip to content

Commit 31117ab

Browse files
committed
refactor:update docs types
1 parent fcf7185 commit 31117ab

File tree

201 files changed

+2111
-1608
lines changed

Some content is hidden

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

201 files changed

+2111
-1608
lines changed

docs/api-reference/assets/create-user-asset-upload.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ const data = await response.json();
153153

154154
</ResponsePanel>
155155

156+
156157
</div>
157158

158159
</div>

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,7 @@ const data = await response.json();
177177

178178
</ResponsePanel>
179179

180+
180181
</div>
181182

182183
</div>

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This performs a soft delete by marking the asset as deleted and updating the use
2727

2828
<ApiParam name="asset_id" type="string" :required="true">
2929

30-
The unique identifier of the asset.
30+
Asset ID
3131

3232
</ApiParam>
3333

@@ -92,6 +92,7 @@ No response body.
9292

9393
</ResponsePanel>
9494

95+
9596
</div>
9697

9798
</div>

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ const data = await response.json();
105105

106106
</ResponsePanel>
107107

108+
108109
</div>
109110

110111
</div>

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Mark user asset as uploaded
2424

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

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

2929
</ApiParam>
3030

@@ -130,6 +130,7 @@ No response body.
130130

131131
</ResponsePanel>
132132

133+
133134
</div>
134135

135136
</div>

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ No response body.
121121

122122
</ResponsePanel>
123123

124+
124125
</div>
125126

126127
</div>

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Create a customer property
3-
description: Create a customer property via Plane API. HTTP POST request format, required fields, and example responses.
4-
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
3+
description: Create a customer property via Plane API. HTTP request format, parameters, scopes, and example responses for create a customer property.
4+
keywords: plane, plane api, rest api, api integration, customer, create a customer property
55
---
66

77
# Create a customer property
@@ -14,7 +14,7 @@ keywords: plane, plane api, rest api, api integration, customers, crm, customer
1414
<div class="api-two-column">
1515
<div class="api-left">
1616

17-
Creates a new customer property definition in a workspace.
17+
Create a new customer property in the specified workspace.
1818

1919
<div class="params-section">
2020

@@ -153,7 +153,6 @@ Updated by.
153153

154154
</div>
155155

156-
157156
</div>
158157

159158
<div class="api-right">

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Create a customer request
3-
description: Create a customer request via Plane API. HTTP POST request format, required fields, and example responses.
4-
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
3+
description: Create a customer request via Plane API. HTTP request format, parameters, scopes, and example responses for create a customer request.
4+
keywords: plane, plane api, rest api, api integration, customer, create a customer request
55
---
66

77
# Create a customer request
@@ -14,23 +14,23 @@ keywords: plane, plane api, rest api, api integration, customers, crm, customer
1414
<div class="api-two-column">
1515
<div class="api-left">
1616

17-
Creates a new request for a customer.
17+
Create a new request for the specified customer.
1818

1919
<div class="params-section">
2020

2121
### Path Parameters
2222

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

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

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`.
27+
The unique identifier of the customer.
2828

2929
</ApiParam>
3030

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

33-
The unique identifier for the customer.
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

@@ -84,7 +84,6 @@ Work item ids.
8484

8585
</div>
8686

87-
8887
</div>
8988

9089
<div class="api-right">
@@ -94,7 +93,7 @@ Work item ids.
9493

9594
```bash
9695
curl -X POST \
97-
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/{customer_id}/requests/" \
96+
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/requests/" \
9897
-H "X-API-Key: $PLANE_API_KEY" \
9998
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
10099
-H "Content-Type: application/json" \
@@ -116,7 +115,7 @@ curl -X POST \
116115
import requests
117116

118117
response = requests.post(
119-
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/{customer_id}/requests/",
118+
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/requests/",
120119
headers={"X-API-Key": "your-api-key"},
121120
json={
122121
"name": "Example Name",
@@ -135,7 +134,7 @@ print(response.json())
135134
<template #javascript>
136135

137136
```javascript
138-
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/customers/{customer_id}/requests/", {
137+
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/requests/", {
139138
method: "POST",
140139
headers: {
141140
"X-API-Key": "your-api-key",

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Create a customer
3-
description: Create a customer via Plane API. HTTP POST request format, required fields, and example responses.
4-
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
3+
description: Create a customer via Plane API. HTTP request format, parameters, scopes, and example responses for create a customer.
4+
keywords: plane, plane api, rest api, api integration, customer, create a customer
55
---
66

77
# Create a customer
@@ -14,7 +14,7 @@ keywords: plane, plane api, rest api, api integration, customers, crm, customer
1414
<div class="api-two-column">
1515
<div class="api-left">
1616

17-
Creates a new customer in a workspace.
17+
Create a new customer in the specified workspace.
1818

1919
<div class="params-section">
2020

@@ -144,7 +144,6 @@ Logo asset.
144144

145145
</div>
146146

147-
148147
</div>
149148

150149
<div class="api-right">

docs/api-reference/customer/delete-customer-property.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Delete a customer property
3-
description: Delete a customer property via Plane API. HTTP DELETE request for removing resources.
4-
keywords: plane, plane api, rest api, api integration, customers, crm, customer management
3+
description: Delete a customer property via Plane API. HTTP request format, parameters, scopes, and example responses for delete a customer property.
4+
keywords: plane, plane api, rest api, api integration, customer, delete a customer property
55
---
66

77
# Delete a customer property
@@ -14,23 +14,23 @@ keywords: plane, plane api, rest api, api integration, customers, crm, customer
1414
<div class="api-two-column">
1515
<div class="api-left">
1616

17-
Permanently deletes a customer property definition from a workspace. This action cannot be undone.
17+
Permanently delete a customer property from the workspace.
1818

1919
<div class="params-section">
2020

2121
### Path Parameters
2222

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

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

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`.
27+
The unique identifier of the resource.
2828

2929
</ApiParam>
3030

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

33-
The unique identifier for the customer property.
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

@@ -45,7 +45,6 @@ The unique identifier for the customer property.
4545

4646
</div>
4747

48-
4948
</div>
5049

5150
<div class="api-right">
@@ -55,7 +54,7 @@ The unique identifier for the customer property.
5554

5655
```bash
5756
curl -X DELETE \
58-
"https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/{property_id}/" \
57+
"https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/property-uuid/" \
5958
-H "X-API-Key: $PLANE_API_KEY" \
6059
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN"
6160
```
@@ -67,7 +66,7 @@ curl -X DELETE \
6766
import requests
6867

6968
response = requests.delete(
70-
"https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/{property_id}/",
69+
"https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/property-uuid/",
7170
headers={"X-API-Key": "your-api-key"}
7271
)
7372
print(response.status_code)
@@ -77,7 +76,7 @@ print(response.status_code)
7776
<template #javascript>
7877

7978
```javascript
80-
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/{property_id}/", {
79+
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/customer-properties/property-uuid/", {
8180
method: "DELETE",
8281
headers: {
8382
"X-API-Key": "your-api-key"

0 commit comments

Comments
 (0)