Skip to content

Commit 0a64175

Browse files
danciaclaradanciaclara
committed
review fixes
1 parent 131599d commit 0a64175

File tree

185 files changed

+2353
-1885
lines changed

Some content is hidden

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

185 files changed

+2353
-1885
lines changed

‎api-reference/customer/add-customer-property.mdx‎

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,74 @@
11
---
2-
title: Add customer property
3-
description: Creates a new customer property definition
4-
api: POST /api/v1/workspaces/{workspace-slug}/customer-properties/
2+
title: Create a customer property
3+
description: Creates a new customer property definition in a workspace.
4+
api: POST /api/v1/workspaces/{workspace_slug}/customer-properties/
55
---
66

7-
### Path parameters
7+
## Path parameters
88

9-
<ParamField path="workspace-slug" type="string" required></ParamField>
9+
<ParamField path="workspace_slug" type="string" required>
10+
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`.
11+
</ParamField>
1012

11-
### Body
13+
## Body parameters
1214

1315
<ParamField body="name" type="string">
14-
Name of the property
16+
Name of the property.
1517
</ParamField>
1618

1719
<ParamField body="display_name" type="string">
18-
Display name of the property
20+
Display name of the property.
1921
</ParamField>
2022

2123
<ParamField body="description" type="string">
22-
Description of the property
24+
Description of the property.
2325
</ParamField>
2426

2527
<ParamField body="property_type" type="string">
26-
Type of the property
28+
Type of the property.
2729
</ParamField>
2830

2931
<ParamField body="relation_type" type="string">
30-
Relation type of the property
32+
Relation type of the property.
3133
</ParamField>
3234

3335
<ParamField body="is_required" type="boolean">
34-
Whether the property is required
36+
Whether the property is required.
3537
</ParamField>
3638

3739
<ParamField body="is_multi" type="boolean">
38-
Whether the property supports multiple values
40+
Whether the property supports multiple values.
3941
</ParamField>
4042

4143
<ParamField body="is_active" type="boolean">
42-
Whether the property is active
44+
Whether the property is active.
4345
</ParamField>
4446

4547
<ParamField body="sort_order" type="number">
46-
Sort order for the property
48+
Sort order for the property.
4749
</ParamField>
4850

4951
<ParamField body="default_value" type="string[]">
50-
Default values for the property
52+
Default values for the property.
5153
</ParamField>
5254

5355
<ParamField body="settings" type="object">
54-
Settings for the property
56+
Settings for the property.
5557
</ParamField>
5658

5759
<ParamField body="validation_rules" type="object">
58-
Validation rules for the property
60+
Validation rules for the property.
5961
</ParamField>
6062

6163
<ParamField body="logo_props" type="object">
62-
Logo properties for the property
64+
Logo properties for the property.
6365
</ParamField>
6466

6567
<ParamField body="external_source" type="string">
66-
External source identifier
68+
External source identifier.
6769
</ParamField>
6870

6971
<ParamField body="external_id" type="string">
70-
External ID from the external source
72+
External ID from the external source.
7173
</ParamField>
7274

‎api-reference/customer/add-customer-request.mdx‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,26 @@
11
---
2-
title: Add customer request
3-
description: Creates a new request for a customer
4-
api: POST /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/requests/
2+
title: Create a customer request
3+
description: Creates a new request for a customer.
4+
api: POST /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/
55
---
66

7-
### Path parameters
7+
## Path parameters
88

9-
<ParamField path="workspace-slug" type="string" required></ParamField>
9+
<ParamField path="workspace_slug" type="string" required>
10+
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`.
11+
</ParamField>
1012

11-
<ParamField path="customer_id" type="string" required></ParamField>
13+
<ParamField path="customer_id" type="string" required>
14+
The unique identifier for the customer.
15+
</ParamField>
1216

13-
### Body
17+
## Body parameters
1418

1519
<ParamField body="title" type="string">
16-
Title of the request
20+
Title of the request.
1721
</ParamField>
1822

1923
<ParamField body="description" type="string">
20-
Description of the request
24+
Description of the request.
2125
</ParamField>
2226

‎api-reference/customer/add-customer.mdx‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
---
2-
title: Add customer
3-
description: Creates a new customer in a workspace
4-
api: POST /api/v1/workspaces/{workspace-slug}/customers/
2+
title: Create a customer
3+
description: Creates a new customer in a workspace.
4+
api: POST /api/v1/workspaces/{workspace_slug}/customers/
55
---
66

7-
### Path parameters
7+
## Path parameters
88

9-
<ParamField path="workspace-slug" type="string" required></ParamField>
9+
<ParamField path="workspace_slug" type="string" required>
10+
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`.
11+
</ParamField>
1012

11-
### Body
13+
## Body parameters
1214

1315
<ParamField body="name" type="string">
14-
Name of the customer
16+
Name of the customer.
1517
</ParamField>
1618

1719
<ParamField body="email" type="string">
18-
Email address of the customer
20+
Email address of the customer.
1921
</ParamField>
2022

‎api-reference/customer/delete-customer-property.mdx‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
---
2-
title: Delete customer property
3-
description: Deletes a customer property definition
4-
api: DELETE /api/v1/workspaces/{workspace-slug}/customer-properties/{property_id}/
2+
title: Delete a customer property
3+
description: Permanently deletes a customer property definition from a workspace. This action cannot be undone.
4+
api: DELETE /api/v1/workspaces/{workspace_slug}/customer-properties/{property_id}/
55
---
66

7-
### Path parameters
7+
## Path parameters
88

9-
<ParamField path="workspace-slug" type="string" required></ParamField>
9+
<ParamField path="workspace_slug" type="string" required>
10+
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`.
11+
</ParamField>
1012

11-
<ParamField path="property_id" type="string" required></ParamField>
13+
<ParamField path="property_id" type="string" required>
14+
The unique identifier for the customer property.
15+
</ParamField>
1216

‎api-reference/customer/delete-customer-request.mdx‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
---
2-
title: Delete customer request
3-
description: Deletes a customer request
4-
api: DELETE /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/requests/{request_id}/
2+
title: Delete a customer request
3+
description: Permanently deletes a customer request. This action cannot be undone.
4+
api: DELETE /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/{request_id}/
55
---
66

7-
### Path parameters
7+
## Path parameters
88

9-
<ParamField path="workspace-slug" type="string" required></ParamField>
9+
<ParamField path="workspace_slug" type="string" required>
10+
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`.
11+
</ParamField>
1012

11-
<ParamField path="customer_id" type="string" required></ParamField>
13+
<ParamField path="customer_id" type="string" required>
14+
The unique identifier for the customer.
15+
</ParamField>
1216

13-
<ParamField path="request_id" type="string" required></ParamField>
17+
<ParamField path="request_id" type="string" required>
18+
The unique identifier for the request.
19+
</ParamField>
1420

‎api-reference/customer/delete-customer.mdx‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
---
2-
title: Delete customer
3-
description: Deletes a customer
4-
api: DELETE /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/
2+
title: Delete a customer
3+
description: Permanently deletes a customer from a workspace. This action cannot be undone.
4+
api: DELETE /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/
55
---
66

7-
### Path parameters
7+
## Path parameters
88

9-
<ParamField path="workspace-slug" type="string" required></ParamField>
9+
<ParamField path="workspace_slug" type="string" required>
10+
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`.
11+
</ParamField>
1012

11-
<ParamField path="customer_id" type="string" required></ParamField>
13+
<ParamField path="customer_id" type="string" required>
14+
The unique identifier for the customer.
15+
</ParamField>
1216

‎api-reference/customer/get-customer-detail.mdx‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
---
2-
title: Get customer details
3-
description: Gets the details of a customer
4-
api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/
2+
title: Retrieve a customer
3+
description: Retrieves the details of an existing customer by its ID.
4+
api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/
55
---
66

7-
### Path parameters
7+
## Path parameters
88

9-
<ParamField path="workspace-slug" type="string" required></ParamField>
9+
<ParamField path="workspace_slug" type="string" required>
10+
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`.
11+
</ParamField>
1012

11-
<ParamField path="customer_id" type="string" required></ParamField>
13+
<ParamField path="customer_id" type="string" required>
14+
The unique identifier for the customer.
15+
</ParamField>
1216

‎api-reference/customer/get-customer-property-detail.mdx‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
---
2-
title: Get customer property details
3-
description: Gets the details of a customer property definition
4-
api: GET /api/v1/workspaces/{workspace-slug}/customer-properties/{property_id}/
2+
title: Retrieve a customer property
3+
description: Retrieves the details of an existing customer property definition by its ID.
4+
api: GET /api/v1/workspaces/{workspace_slug}/customer-properties/{property_id}/
55
---
66

7-
### Path parameters
7+
## Path parameters
88

9-
<ParamField path="workspace-slug" type="string" required></ParamField>
9+
<ParamField path="workspace_slug" type="string" required>
10+
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`.
11+
</ParamField>
1012

11-
<ParamField path="property_id" type="string" required></ParamField>
13+
<ParamField path="property_id" type="string" required>
14+
The unique identifier for the customer property.
15+
</ParamField>
1216

‎api-reference/customer/get-customer-property-value.mdx‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
---
2-
title: Get customer property value
3-
description: Gets a specific property value for a customer
4-
api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/property-values/{property_id}/
2+
title: Retrieve a customer property value
3+
description: Retrieves a specific property value for a customer by property ID.
4+
api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/property-values/{property_id}/
55
---
66

7-
### Path parameters
7+
## Path parameters
88

9-
<ParamField path="workspace-slug" type="string" required></ParamField>
9+
<ParamField path="workspace_slug" type="string" required>
10+
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`.
11+
</ParamField>
1012

11-
<ParamField path="customer_id" type="string" required></ParamField>
13+
<ParamField path="customer_id" type="string" required>
14+
The unique identifier for the customer.
15+
</ParamField>
1216

13-
<ParamField path="property_id" type="string" required></ParamField>
17+
<ParamField path="property_id" type="string" required>
18+
The unique identifier for the customer property.
19+
</ParamField>
1420

‎api-reference/customer/get-customer-request-detail.mdx‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
---
2-
title: Get customer request details
3-
description: Gets the details of a customer request
4-
api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/requests/{request_id}/
2+
title: Retrieve a customer request
3+
description: Retrieves the details of an existing customer request by its ID.
4+
api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/{request_id}/
55
---
66

7-
### Path parameters
7+
## Path parameters
88

9-
<ParamField path="workspace-slug" type="string" required></ParamField>
9+
<ParamField path="workspace_slug" type="string" required>
10+
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`.
11+
</ParamField>
1012

11-
<ParamField path="customer_id" type="string" required></ParamField>
13+
<ParamField path="customer_id" type="string" required>
14+
The unique identifier for the customer.
15+
</ParamField>
1216

13-
<ParamField path="request_id" type="string" required></ParamField>
17+
<ParamField path="request_id" type="string" required>
18+
The unique identifier for the request.
19+
</ParamField>
1420

0 commit comments

Comments
 (0)