Skip to content

Commit 46b070b

Browse files
gurusainathgurusainath
committed
dev: issue-types api documentation
1 parent 6772ef3 commit 46b070b

File tree

22 files changed

+576
-40
lines changed

22 files changed

+576
-40
lines changed

‎api-reference/issue-types/options/add.mdx‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: Add
3+
description: description
4+
api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issue-properties/{property_id}/options/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required></ParamField>
10+
<ParamField path="project_id" type="string" required></ParamField>
11+
<ParamField path="property_id" type="string" required></ParamField>
12+
13+
### Body
14+
15+
<ParamField body="name" type="string" required></ParamField>
16+
<ParamField body="description" type="string"></ParamField>
17+
<ParamField body="is_default" type="boolean"></ParamField>
18+
<ParamField body="is_active" type="boolean"></ParamField>
19+
<ParamField body="parent" type="string"></ParamField>

‎api-reference/issue-types/options/delete.mdx‎

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

‎api-reference/issue-types/options/get-detail.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Get by id
3+
description: description
4+
api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issue-properties/{property_id}/options/{option_id}/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required></ParamField>
10+
<ParamField path="project_id" type="string" required></ParamField>
11+
<ParamField path="property_id" type="string" required></ParamField>
12+
<ParamField path="option_id" type="string" required></ParamField>

‎api-reference/issue-types/options/list.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: List
3+
description: description
4+
api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issue-properties/{property_id}/options/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required></ParamField>
10+
<ParamField path="project_id" type="string" required></ParamField>
11+
<ParamField path="property_id" type="string" required></ParamField>

‎api-reference/issue-types/options/overview.mdx‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Overview
3+
description: Description
4+
---
5+
6+
```http
7+
POST /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-properties/:property_id/options/
8+
GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-properties/:property_id/options/
9+
GET /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-properties/:property_id/options/:option_id/
10+
PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-properties/:property_id/options/:option_id/
11+
DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/issue-properties/:property_id/options/:option_id/
12+
```
13+
14+
### Label Object
15+
16+
- `workspace` _uuid_
17+
18+
The workspace which the issue is part of auto generated from backend
19+
20+
- `project` _uuid_
21+
22+
The project which the issue is part of auto generated from backend
23+
24+
- `created_at` , `updated_at` timestamp
25+
26+
Timestamp of the issue when it was created and when it was last updated.
27+
28+
- `created_by` & `updated_by`
29+
30+
This values are auto saved and represent the id of the user that created or the updated the project.
31+
32+
- `external_id` & `external_source`
33+
34+
This values are auto saved and represent the id of the user that created or the updated the project.
35+
36+
<ResponseExample>
37+
38+
```json JSON
39+
{
40+
"id": "51a869d1-f612-4315-ac91-ffef3e96c20e",
41+
"created_at": "2024-10-23T07:44:42.883820Z",
42+
"updated_at": "2024-10-23T07:44:42.883855Z",
43+
"deleted_at": null,
44+
"name": "issue property option 3",
45+
"sort_order": 10000.0,
46+
"description": "issue property option 3 description",
47+
"logo_props": {},
48+
"is_active": true,
49+
"is_default": false,
50+
"external_source": null,
51+
"external_id": null,
52+
"created_by": "9d6d1ecd-bf73-4169-80c8-7dee79b217f4",
53+
"updated_by": "9d6d1ecd-bf73-4169-80c8-7dee79b217f4",
54+
"workspace": "70b6599f-9313-4c0d-b5c0-406a13a05647",
55+
"project": "03a9bf56-84f4-4afe-b232-9400eb9b7b6b",
56+
"property": "f962febb-98bc-43ca-8bfb-8012e4d54dae",
57+
"parent": null
58+
}
59+
```
60+
61+
</ResponseExample>

‎api-reference/issue-types/options/update.mdx‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Update
3+
description: description
4+
api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issue-properties/{property_id}/options/{option_id}/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required></ParamField>
10+
<ParamField path="project_id" type="string" required></ParamField>
11+
<ParamField path="property_id" type="string" required></ParamField>
12+
<ParamField path="option_id" type="string" required></ParamField>
13+
14+
### Body
15+
16+
<ParamField body="name" type="string" required></ParamField>
17+
<ParamField body="description" type="string"></ParamField>
18+
<ParamField body="is_default" type="boolean"></ParamField>
19+
<ParamField body="is_active" type="boolean"></ParamField>
20+
<ParamField body="parent" type="string"></ParamField>

‎api-reference/issue-types/properties/add.mdx‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Add
3+
description: description
4+
api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required></ParamField>
10+
<ParamField path="project_id" type="string" required></ParamField>
11+
<ParamField path="type_id" type="string" required></ParamField>
12+
13+
### Body
14+
15+
<ParamField body="display_name" type="string" required></ParamField>
16+
<ParamField body="description" type="string"></ParamField>
17+
<ParamField body="property_type" type="string"></ParamField>
18+
<ParamField body="relation_type" type="string"></ParamField>
19+
<ParamField body="default_value" type="string[]"></ParamField>
20+
<ParamField body="validation_rules" type="object"></ParamField>
21+
<ParamField body="is_required" type="boolean"></ParamField>
22+
<ParamField body="is_active" type="boolean"></ParamField>
23+
<ParamField body="is_multi" type="boolean"></ParamField>

‎api-reference/issue-types/properties/delete.mdx‎

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

‎api-reference/issue-types/properties/get-detail.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Get by id
3+
description: description
4+
api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/{property_id}/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required></ParamField>
10+
<ParamField path="project_id" type="string" required></ParamField>
11+
<ParamField path="type_id" type="string" required></ParamField>
12+
<ParamField path="property_id" type="string" required></ParamField>

‎api-reference/issue-types/properties/list.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: List
3+
description: description
4+
api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issue-types/{type_id}/issue-properties/
5+
---
6+
7+
### Path parameters
8+
9+
<ParamField path="workspace_slug" type="string" required></ParamField>
10+
<ParamField path="project_id" type="string" required></ParamField>
11+
<ParamField path="type_id" type="string" required></ParamField>

0 commit comments

Comments
 (0)