Skip to content

Commit a461580

Browse files
feat: v2 migration
1 parent 52b030e commit a461580

File tree

166 files changed

+2442
-9826
lines changed

Some content is hidden

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

166 files changed

+2442
-9826
lines changed

README.md

Lines changed: 0 additions & 64 deletions
This file was deleted.
Lines changed: 59 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,9 @@
11
---
22
title: Cycle
3-
pageTitle: Cycle | Plane
4-
description:
53
---
6-
7-
{% col-2 %}
8-
{% list %}
94
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.
105

11-
To transfer issues of one cycle to another, the payload should be sent in the below format
12-
13-
```
14-
{
15-
"new_cycle_id": "2380ce13-1cc4-4f67-9f57-a2b7686886d7"
16-
}
17-
```
18-
19-
{% /list %}
20-
21-
{% list %}
22-
23-
```
6+
```http
247
POST /api/v1/workspaces/:slug/projects/:project_id/cycles/
258
GET /api/v1/workspaces/:slug/projects/:project_id/cycles/
269
GET /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/
@@ -29,66 +12,66 @@ DELETE /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/
2912
POST /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/transfer-issues/
3013
```
3114

32-
{% /list %}
33-
{% /col-2 %}
34-
35-
## Cycle Object
36-
37-
{% col-2 %}
38-
{% list %}
39-
**Attributes**
40-
41-
- `name` string (required)
42-
43-
Name of the cycle
44-
45-
- `description` string
46-
47-
Description of the cycle
48-
49-
- `start_date` date
50-
51-
Start date of the cycle
52-
53-
- `end_date` date
54-
55-
End date of the cycle
56-
57-
- `created_at` _timestamp_
5815

59-
The timestamp of the time when the project was created
60-
61-
- `updated_at` _timestamp_
62-
63-
The timestamp of the time when the project was last updated
64-
65-
- `view_props`
66-
67-
It store the filters and the display properties selected by the user to visualize the issues in the module
68-
69-
- `sort_order`
70-
71-
It gives the position of the module at which it should be displayed
72-
73-
- `created_by` , `updated_by` _uuid_
74-
75-
These values are auto saved and represent the id of the user that created or the updated the
76-
77-
- `Project` uuid
78-
79-
It contains projects uuid which is automatically saved.
80-
81-
- `Workspace` uuid
82-
83-
It contains workspace uuid which is automatically saved
84-
85-
- `owned_by` uuid
16+
To transfer issues of one cycle to another, the payload should be sent in the below format
17+
```
18+
{
19+
"new_cycle_id": "2380ce13-1cc4-4f67-9f57-a2b7686886d7"
20+
}
21+
```
8622

87-
{% /list %}
23+
### Cycle Object
8824

89-
{% list %}
25+
**Attributes**
9026

91-
```
27+
* `name` string (required)
28+
29+
Name of the cycle
30+
31+
* `description` string
32+
33+
Description of the cycle
34+
35+
* `start_date` date
36+
37+
Start date of the cycle
38+
39+
* `end_date` date
40+
41+
End date of the cycle
42+
43+
* `created_at` _timestamp_
44+
45+
The timestamp of the time when the project was created
46+
47+
* `updated_at` _timestamp_
48+
49+
The timestamp of the time when the project was last updated
50+
51+
* `view_props`
52+
53+
It store the filters and the display properties selected by the user to visualize the issues in the module
54+
55+
* `sort_order`
56+
57+
It gives the position of the module at which it should be displayed
58+
59+
* `created_by` , `updated_by` _uuid_
60+
61+
These values are auto saved and represent the id of the user that created or the updated the
62+
63+
* `Project` uuid
64+
65+
It contains projects uuid which is automatically saved.
66+
67+
* `Workspace` uuid
68+
69+
It contains workspace uuid which is automatically saved
70+
71+
* `owned_by` uuid
72+
73+
<ResponseExample>
74+
```json JSON
9275
{
9376
"id": "50ebc791-65e4-4b4d-a164-3b4e529e55a5",
9477
"created_at": "2023-11-19T12:18:14.900078Z",
@@ -105,7 +88,6 @@ POST /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/transfer-i
10588
"workspace": "c467e125-59e3-44ec-b5ee-f9c1e138c611",
10689
"owned_by": "0649cb9d-05c8-4ef4-8e8b-d108ccddd42c"
10790
}
108-
```
10991

110-
{% /list %}
111-
{% /col-2 %}
92+
```
93+
</ResponseExample>
Lines changed: 42 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,58 @@
11
---
22
title: Cycle Issue
3-
pageTitle: Cycle Issue | Plane
4-
description:
53
---
6-
7-
{% col-2 %}
8-
{% list %}
94
It contains all the list of issues which are inside in a cycle.
5+
```http
6+
POST /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/cycle-issues/
7+
GET /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/cycle-issues/
8+
DELETE /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/cycle-issues/:issue_id/
9+
```
1010

1111
For creating a cycle issue, the payload should be sent in the below format.
12-
1312
```
1413
{
1514
"issues": ["d7a45e13-be2a-4942-aa15-b82c2cf244d0","d23wefadf-dafADfadfadfqeqerqer"]
1615
}
1716
```
18-
{% /list %}
1917

20-
{% list %}
18+
### Cycle Issue Object
2119

22-
```
23-
POST /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/cycle-issues/
24-
GET /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/cycle-issues/
25-
DELETE /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/cycle-issues/:issue_id/
26-
```
27-
28-
{% /list %}
29-
{% /col-2 %}
30-
31-
## Cycle Issue Object
32-
33-
{% col-2 %}
34-
{% list %}
3520
**Attributes**
3621

37-
- `sub_issues_count`
38-
39-
It tells the count of sub issues of the issue
40-
41-
- `created_at` _timestamp_
42-
43-
The timestamp of the time when the project was created
44-
45-
- `updated_at` _timestamp_
46-
47-
The timestamp of the time when the project was last updated
48-
49-
- `created_by` , `updated_by` _uuid_
50-
51-
These values are auto saved and represent the id of the user that created or updated the module
52-
53-
- `Project` uuid
54-
55-
It contains projects uuid which is automatically saved.
56-
57-
- `Workspace` uuid
58-
59-
It contains workspace uuid which is automatically saved
60-
61-
- `cycle` uuid
62-
63-
Cycle id of which the issue belongs to
64-
65-
- `issue` uuid
66-
67-
Issue id of the issue
68-
69-
{% /list %}
70-
71-
{% list %}
72-
73-
```
22+
* `sub_issues_count`
23+
24+
It tells the count of sub issues of the issue
25+
26+
* `created_at` _timestamp_
27+
28+
The timestamp of the time when the project was created
29+
30+
* `updated_at` _timestamp_
31+
32+
The timestamp of the time when the project was last updated
33+
34+
* `created_by` , `updated_by` _uuid_
35+
36+
These values are auto saved and represent the id of the user that created or updated the module
37+
38+
* `Project` uuid
39+
40+
It contains projects uuid which is automatically saved.
41+
42+
* `Workspace` uuid
43+
44+
It contains workspace uuid which is automatically saved
45+
46+
* `cycle` uuid
47+
48+
Cycle id of which the issue belongs to
49+
50+
* `issue` uuid
51+
52+
Issue id of the issue
53+
54+
<ResponseExample>
55+
```json JSON
7456
[
7557
{
7658
"id": "81686eba-bd63-4fd1-b628-b08ecdb1db06",
@@ -85,7 +67,7 @@ DELETE /api/v1/workspaces/:slug/projects/:project_id/cycles/:cycle_id/cycle-issu
8567
"issue": "2f9f16f7-604c-43d3-adb1-5466ade808aa"
8668
}
8769
]
70+
8871
```
72+
</ResponseExample>
8973

90-
{% /list %}
91-
{% /col-2 %}

0 commit comments

Comments
 (0)