Skip to content

Commit 131599d

Browse files
Prashant-SuryaPrashant-Surya
committed
docs: restructure API docs and update Work Item terminology
- Add Users and Stickies API documentation - Add Initiatives, Teamspaces and Pages API documentation - Add Customers, Customer Requests and Properties API documentation - Update WorkItemTypes: replace "Issue" with "Work Item", fix endpoints - Reorganize navigation: nest related APIs under parent groups - Ensure consistent "Work Item" terminology across all docs
1 parent 8139982 commit 131599d

File tree

123 files changed

+3165
-414
lines changed

Some content is hidden

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

123 files changed

+3165
-414
lines changed

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

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: Add customer property
3+
description: Creates a new customer property definition
4+
api: POST /api/v1/workspaces/{workspace-slug}/customer-properties/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
10+
11+
### Body
12+
13+
<ParamField body="name" type="string">
14+
Name of the property
15+
</ParamField>
16+
17+
<ParamField body="display_name" type="string">
18+
Display name of the property
19+
</ParamField>
20+
21+
<ParamField body="description" type="string">
22+
Description of the property
23+
</ParamField>
24+
25+
<ParamField body="property_type" type="string">
26+
Type of the property
27+
</ParamField>
28+
29+
<ParamField body="relation_type" type="string">
30+
Relation type of the property
31+
</ParamField>
32+
33+
<ParamField body="is_required" type="boolean">
34+
Whether the property is required
35+
</ParamField>
36+
37+
<ParamField body="is_multi" type="boolean">
38+
Whether the property supports multiple values
39+
</ParamField>
40+
41+
<ParamField body="is_active" type="boolean">
42+
Whether the property is active
43+
</ParamField>
44+
45+
<ParamField body="sort_order" type="number">
46+
Sort order for the property
47+
</ParamField>
48+
49+
<ParamField body="default_value" type="string[]">
50+
Default values for the property
51+
</ParamField>
52+
53+
<ParamField body="settings" type="object">
54+
Settings for the property
55+
</ParamField>
56+
57+
<ParamField body="validation_rules" type="object">
58+
Validation rules for the property
59+
</ParamField>
60+
61+
<ParamField body="logo_props" type="object">
62+
Logo properties for the property
63+
</ParamField>
64+
65+
<ParamField body="external_source" type="string">
66+
External source identifier
67+
</ParamField>
68+
69+
<ParamField body="external_id" type="string">
70+
External ID from the external source
71+
</ParamField>
72+

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
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/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
10+
11+
<ParamField path="customer_id" type="string" required></ParamField>
12+
13+
### Body
14+
15+
<ParamField body="title" type="string">
16+
Title of the request
17+
</ParamField>
18+
19+
<ParamField body="description" type="string">
20+
Description of the request
21+
</ParamField>
22+

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Add customer
3+
description: Creates a new customer in a workspace
4+
api: POST /api/v1/workspaces/{workspace-slug}/customers/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
10+
11+
### Body
12+
13+
<ParamField body="name" type="string">
14+
Name of the customer
15+
</ParamField>
16+
17+
<ParamField body="email" type="string">
18+
Email address of the customer
19+
</ParamField>
20+

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Delete customer property
3+
description: Deletes a customer property definition
4+
api: DELETE /api/v1/workspaces/{workspace-slug}/customer-properties/{property_id}/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
10+
11+
<ParamField path="property_id" type="string" required></ParamField>
12+

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
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}/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
10+
11+
<ParamField path="customer_id" type="string" required></ParamField>
12+
13+
<ParamField path="request_id" type="string" required></ParamField>
14+

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Delete customer
3+
description: Deletes a customer
4+
api: DELETE /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
10+
11+
<ParamField path="customer_id" type="string" required></ParamField>
12+

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Get customer details
3+
description: Gets the details of a customer
4+
api: GET /api/v1/workspaces/{workspace-slug}/customers/{customer_id}/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
10+
11+
<ParamField path="customer_id" type="string" required></ParamField>
12+

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
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}/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
10+
11+
<ParamField path="property_id" type="string" required></ParamField>
12+

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
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}/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
10+
11+
<ParamField path="customer_id" type="string" required></ParamField>
12+
13+
<ParamField path="property_id" type="string" required></ParamField>
14+

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
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}/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
10+
11+
<ParamField path="customer_id" type="string" required></ParamField>
12+
13+
<ParamField path="request_id" type="string" required></ParamField>
14+

0 commit comments

Comments
 (0)