Skip to content

Commit 49e1899

Browse files
srinivaspendemsrinivaspendem
authored
Merge pull request #131 from makeplane/minor-fixes
Clarified workspace slug
2 parents 49c97c7 + ef5c907 commit 49e1899

Some content is hidden

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

66 files changed

+171
-171
lines changed

‎api-reference/cycle-issue/add-cycle-issue.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
22
title: Add cycle issue
33
description: Adds an issue in a cycle
4-
api: POST /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/
4+
api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/
55
---
66

77
### Path parameters
88

9-
<ParamField path="slug" type="string" required></ParamField>
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
1010

1111
<ParamField path="project_id" type="string" required></ParamField>
1212

1313
<ParamField path="cycle_id" type="string" required></ParamField>
1414

1515
### Body
1616

17-
<ParamField body="issues" type="list" required>
17+
<ParamField body="issues" type="string[]" required>
1818
It expects a list of issue ids
1919
</ParamField>

‎api-reference/cycle-issue/delete-cycle-issue.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Delete cycle issue
33
description: Deletes an issue in a cycle
4-
api: DELETE /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}
4+
api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}
55
---
66

77
### Path parameters
88

9-
<ParamField path="slug" type="string" required></ParamField>
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
1010

1111
<ParamField path="project_id" type="string" required></ParamField>
1212

‎api-reference/cycle-issue/list-cycle-issues.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: List cycle issues
33
description: Gets all the issues in a cycle
4-
api: GET /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/
4+
api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/
55
---
66

77
### Path parameters
88

9-
<ParamField path="slug" type="string" required></ParamField>
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
1010

1111
<ParamField path="project_id" type="string" required></ParamField>
1212

‎api-reference/cycle-issue/overview.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ title: Overview
55
It contains all the list of issues which are inside a cycle.
66

77
```http
8-
POST /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/cycle-issues/
9-
GET /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/cycle-issues/
10-
DELETE /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/cycle-issues/:issue_id/
8+
POST /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/cycle-issues/
9+
GET /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/cycle-issues/
10+
DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/cycle-issues/:issue_id/
1111
```
1212

1313
For creating a cycle issue, the payload should be sent in the below format.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Add cycle
33
description: Adds a cycle in a project
4-
api: POST /api/v1/workspaces/{slug}/projects/{project_id}/cycles/
4+
api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/
55
---
66

77
### Path parameters
88

9-
<ParamField path="slug" type="string" required></ParamField>
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
1010

1111
<ParamField path="project_id" type="string" required></ParamField>
1212

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Delete cycle
33
description: Deletes a cycle
4-
api: DELETE /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}
4+
api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}
55
---
66

77
### Path parameters
88

9-
<ParamField path="slug" type="string" required></ParamField>
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
1010

1111
<ParamField path="project_id" type="string" required></ParamField>
1212

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Get cycle details
33
description: Gets the details of a cycle
4-
api: GET /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}
4+
api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}
55
---
66

77
### Path parameters
88

9-
<ParamField path="slug" type="string" required></ParamField>
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
1010

1111
<ParamField path="project_id" type="string" required></ParamField>
1212

‎api-reference/cycle/list-cycles.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: List cycles
33
description: Gets all the cycles in a project
4-
api: GET /api/v1/workspaces/{slug}/projects/{project_id}/cycles/
4+
api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/
55
---
66

77
### Path parameters
88

9-
<ParamField path="slug" type="string" required></ParamField>
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
1010

1111
<ParamField path="project_id" type="string" required></ParamField>

‎api-reference/cycle/overview.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ title: Overview
55
Cycles is a custom time period in which a team works to complete items on their backlog. At the end of the sprint, the team will usually have finished building and implementing a new version of their project or product.
66

77
```http
8-
POST /api/v1/workspaces/:slug/projects/:project_id/cycles/
9-
GET /api/v1/workspaces/:slug/projects/:project_id/cycles/
10-
GET /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/
11-
PATCH /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/
12-
DELETE /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/
13-
POST /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/transfer-issues/
8+
POST /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/
9+
GET /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/
10+
GET /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/
11+
PATCH /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/
12+
DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/
13+
POST /api/v1/workspaces/:workspace-slug/projects/:project_id/cycles/:cycle_id/transfer-issues/
1414
```
1515

1616
To transfer issues of one cycle to another, the payload should be sent in the below format

‎api-reference/cycle/update-cycle-detail.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Update cycle details
33
description: Updates the details of a cycle
4-
api: PATCH /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}
4+
api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/cycles/{cycle_id}
55
---
66

77
### Path parameters
88

9-
<ParamField path="slug" type="string" required></ParamField>
9+
<ParamField path="workspace-slug" type="string" required></ParamField>
1010

1111
<ParamField path="project_id" type="string" required></ParamField>
1212

0 commit comments

Comments
 (0)