Skip to content

Commit f011c18

Browse files
rename issues to work items in apis
1 parent cf7f22f commit f011c18

39 files changed

+753
-1138
lines changed

.openapi-generator/FILES

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ docs/GroupEnum.md
1818
docs/IntakeApi.md
1919
docs/IntakeIssue.md
2020
docs/IntakeIssueCreateRequest.md
21-
docs/IntakeIssueStatusEnum.md
21+
docs/IntakeWorkItemStatusEnum.md
2222
docs/Issue.md
2323
docs/IssueActivity.md
2424
docs/IssueAttachment.md
@@ -92,15 +92,15 @@ docs/ProjectWorklogSummary.md
9292
docs/ProjectsApi.md
9393
docs/PropertyTypeEnum.md
9494
docs/RelationTypeEnum.md
95-
docs/RetrieveIssueAttachment400Response.md
95+
docs/RetrieveWorkItemAttachment400Response.md
9696
docs/State.md
9797
docs/StateLite.md
9898
docs/StateRequest.md
9999
docs/StatesApi.md
100100
docs/TimezoneEnum.md
101101
docs/TransferCycleIssueRequestRequest.md
102-
docs/TransferCycleIssues200Response.md
103-
docs/TransferCycleIssues400Response.md
102+
docs/TransferCycleWorkItems200Response.md
103+
docs/TransferCycleWorkItems400Response.md
104104
docs/TypeEnum.md
105105
docs/UserAssetUploadRequest.md
106106
docs/UserLite.md
@@ -150,7 +150,7 @@ plane/models/get_workspace_members200_response_inner.py
150150
plane/models/group_enum.py
151151
plane/models/intake_issue.py
152152
plane/models/intake_issue_create_request.py
153-
plane/models/intake_issue_status_enum.py
153+
plane/models/intake_work_item_status_enum.py
154154
plane/models/issue.py
155155
plane/models/issue_activity.py
156156
plane/models/issue_attachment.py
@@ -220,14 +220,14 @@ plane/models/project_create_request.py
220220
plane/models/project_worklog_summary.py
221221
plane/models/property_type_enum.py
222222
plane/models/relation_type_enum.py
223-
plane/models/retrieve_issue_attachment400_response.py
223+
plane/models/retrieve_work_item_attachment400_response.py
224224
plane/models/state.py
225225
plane/models/state_lite.py
226226
plane/models/state_request.py
227227
plane/models/timezone_enum.py
228228
plane/models/transfer_cycle_issue_request_request.py
229-
plane/models/transfer_cycle_issues200_response.py
230-
plane/models/transfer_cycle_issues400_response.py
229+
plane/models/transfer_cycle_work_items200_response.py
230+
plane/models/transfer_cycle_work_items400_response.py
231231
plane/models/type_enum.py
232232
plane/models/user_asset_upload_request.py
233233
plane/models/user_lite.py

README.md

Lines changed: 33 additions & 33 deletions
Large diffs are not rendered by default.

docs/CyclesApi.md

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,27 @@ All URIs are relative to *https://api.plane.so*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**add_cycle_issues**](CyclesApi.md#add_cycle_issues) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ | Add Issues to Cycle
7+
[**add_cycle_work_items**](CyclesApi.md#add_cycle_work_items) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ | Add Work Items to Cycle
88
[**archive_cycle**](CyclesApi.md#archive_cycle) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/archive/ | Archive cycle
99
[**create_cycle**](CyclesApi.md#create_cycle) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/ | Create cycle
1010
[**delete_cycle**](CyclesApi.md#delete_cycle) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/ | Delete cycle
11-
[**delete_cycle_issue**](CyclesApi.md#delete_cycle_issue) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}/ | Delete cycle issue
11+
[**delete_cycle_work_item**](CyclesApi.md#delete_cycle_work_item) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}/ | Delete cycle work item
1212
[**list_archived_cycles**](CyclesApi.md#list_archived_cycles) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/archived-cycles/ | List archived cycles
13-
[**list_cycle_issues**](CyclesApi.md#list_cycle_issues) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ | List cycle issues
13+
[**list_cycle_work_items**](CyclesApi.md#list_cycle_work_items) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/ | List cycle work items
1414
[**list_cycles**](CyclesApi.md#list_cycles) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/ | List cycles
1515
[**retrieve_cycle**](CyclesApi.md#retrieve_cycle) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/ | Retrieve cycle
16-
[**retrieve_cycle_issue**](CyclesApi.md#retrieve_cycle_issue) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}/ | Retrieve cycle issue
17-
[**transfer_cycle_issues**](CyclesApi.md#transfer_cycle_issues) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/transfer-issues/ | Transfer cycle issues
16+
[**retrieve_cycle_work_item**](CyclesApi.md#retrieve_cycle_work_item) | **GET** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/cycle-issues/{issue_id}/ | Retrieve cycle work item
17+
[**transfer_cycle_work_items**](CyclesApi.md#transfer_cycle_work_items) | **POST** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{cycle_id}/transfer-issues/ | Transfer cycle work items
1818
[**unarchive_cycle**](CyclesApi.md#unarchive_cycle) | **DELETE** /api/v1/workspaces/{slug}/projects/{project_id}/archived-cycles/{pk}/unarchive/ | Unarchive cycle
1919
[**update_cycle**](CyclesApi.md#update_cycle) | **PATCH** /api/v1/workspaces/{slug}/projects/{project_id}/cycles/{pk}/ | Update cycle
2020

2121

22-
# **add_cycle_issues**
23-
> CycleIssue add_cycle_issues(cycle_id, project_id, slug, cycle_issue_request_request)
22+
# **add_cycle_work_items**
23+
> CycleIssue add_cycle_work_items(cycle_id, project_id, slug, cycle_issue_request_request)
2424
25-
Add Issues to Cycle
25+
Add Work Items to Cycle
2626

27-
Assign multiple issues to a cycle. Automatically handles bulk creation and updates with activity tracking.
27+
Assign multiple work items to a cycle. Automatically handles bulk creation and updates with activity tracking.
2828

2929
### Example
3030

@@ -71,12 +71,12 @@ with plane.ApiClient(configuration) as api_client:
7171
cycle_issue_request_request = {"issues":["0ec6cfa4-e906-4aad-9390-2df0303a41cd","0ec6cfa4-e906-4aad-9390-2df0303a41ce"]} # CycleIssueRequestRequest |
7272

7373
try:
74-
# Add Issues to Cycle
75-
api_response = api_instance.add_cycle_issues(cycle_id, project_id, slug, cycle_issue_request_request)
76-
print("The response of CyclesApi->add_cycle_issues:\n")
74+
# Add Work Items to Cycle
75+
api_response = api_instance.add_cycle_work_items(cycle_id, project_id, slug, cycle_issue_request_request)
76+
print("The response of CyclesApi->add_cycle_work_items:\n")
7777
pprint(api_response)
7878
except Exception as e:
79-
print("Exception when calling CyclesApi->add_cycle_issues: %s\n" % e)
79+
print("Exception when calling CyclesApi->add_cycle_work_items: %s\n" % e)
8080
```
8181

8282

@@ -109,7 +109,7 @@ Name | Type | Description | Notes
109109
**401** | Authentication credentials were not provided or are invalid. | - |
110110
**403** | Permission denied. User lacks required permissions. | - |
111111
**404** | The requested resource was not found. | - |
112-
**200** | Cycle issues added | - |
112+
**200** | Cycle work items added | - |
113113
**400** | Required fields are missing | - |
114114

115115
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
@@ -383,12 +383,12 @@ void (empty response body)
383383

384384
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
385385

386-
# **delete_cycle_issue**
387-
> delete_cycle_issue(cycle_id, issue_id, project_id, slug)
386+
# **delete_cycle_work_item**
387+
> delete_cycle_work_item(cycle_id, issue_id, project_id, slug)
388388
389-
Delete cycle issue
389+
Delete cycle work item
390390

391-
Remove an issue from a cycle while keeping the issue in the project.
391+
Remove a work item from a cycle while keeping the work item in the project.
392392

393393
### Example
394394

@@ -433,10 +433,10 @@ with plane.ApiClient(configuration) as api_client:
433433
slug = 'my-workspace' # str | Workspace slug
434434

435435
try:
436-
# Delete cycle issue
437-
api_instance.delete_cycle_issue(cycle_id, issue_id, project_id, slug)
436+
# Delete cycle work item
437+
api_instance.delete_cycle_work_item(cycle_id, issue_id, project_id, slug)
438438
except Exception as e:
439-
print("Exception when calling CyclesApi->delete_cycle_issue: %s\n" % e)
439+
print("Exception when calling CyclesApi->delete_cycle_work_item: %s\n" % e)
440440
```
441441

442442

@@ -566,12 +566,12 @@ Name | Type | Description | Notes
566566

567567
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
568568

569-
# **list_cycle_issues**
570-
> PaginatedCycleIssueResponse list_cycle_issues(cycle_id, project_id, slug, cursor=cursor, per_page=per_page)
569+
# **list_cycle_work_items**
570+
> PaginatedCycleIssueResponse list_cycle_work_items(cycle_id, project_id, slug, cursor=cursor, per_page=per_page)
571571
572-
List cycle issues
572+
List cycle work items
573573

574-
Retrieve all issues assigned to a cycle.
574+
Retrieve all work items assigned to a cycle.
575575

576576
### Example
577577

@@ -618,12 +618,12 @@ with plane.ApiClient(configuration) as api_client:
618618
per_page = 20 # int | Number of results per page (default: 20, max: 100) (optional)
619619

620620
try:
621-
# List cycle issues
622-
api_response = api_instance.list_cycle_issues(cycle_id, project_id, slug, cursor=cursor, per_page=per_page)
623-
print("The response of CyclesApi->list_cycle_issues:\n")
621+
# List cycle work items
622+
api_response = api_instance.list_cycle_work_items(cycle_id, project_id, slug, cursor=cursor, per_page=per_page)
623+
print("The response of CyclesApi->list_cycle_work_items:\n")
624624
pprint(api_response)
625625
except Exception as e:
626-
print("Exception when calling CyclesApi->list_cycle_issues: %s\n" % e)
626+
print("Exception when calling CyclesApi->list_cycle_work_items: %s\n" % e)
627627
```
628628

629629

@@ -657,7 +657,7 @@ Name | Type | Description | Notes
657657
**401** | Authentication credentials were not provided or are invalid. | - |
658658
**403** | Permission denied. User lacks required permissions. | - |
659659
**404** | The requested resource was not found. | - |
660-
**200** | Paginated list of cycle issues | - |
660+
**200** | Paginated list of cycle work items | - |
661661

662662
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
663663

@@ -853,12 +853,12 @@ Name | Type | Description | Notes
853853

854854
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
855855

856-
# **retrieve_cycle_issue**
857-
> CycleIssue retrieve_cycle_issue(cycle_id, issue_id, project_id, slug)
856+
# **retrieve_cycle_work_item**
857+
> CycleIssue retrieve_cycle_work_item(cycle_id, issue_id, project_id, slug)
858858
859-
Retrieve cycle issue
859+
Retrieve cycle work item
860860

861-
Retrieve details of a specific cycle issue.
861+
Retrieve details of a specific cycle work item.
862862

863863
### Example
864864

@@ -904,12 +904,12 @@ with plane.ApiClient(configuration) as api_client:
904904
slug = 'my-workspace' # str | Workspace slug
905905

906906
try:
907-
# Retrieve cycle issue
908-
api_response = api_instance.retrieve_cycle_issue(cycle_id, issue_id, project_id, slug)
909-
print("The response of CyclesApi->retrieve_cycle_issue:\n")
907+
# Retrieve cycle work item
908+
api_response = api_instance.retrieve_cycle_work_item(cycle_id, issue_id, project_id, slug)
909+
print("The response of CyclesApi->retrieve_cycle_work_item:\n")
910910
pprint(api_response)
911911
except Exception as e:
912-
print("Exception when calling CyclesApi->retrieve_cycle_issue: %s\n" % e)
912+
print("Exception when calling CyclesApi->retrieve_cycle_work_item: %s\n" % e)
913913
```
914914

915915

@@ -942,16 +942,16 @@ Name | Type | Description | Notes
942942
**401** | Authentication credentials were not provided or are invalid. | - |
943943
**403** | Permission denied. User lacks required permissions. | - |
944944
**404** | The requested resource was not found. | - |
945-
**200** | Cycle issues | - |
945+
**200** | Cycle work items | - |
946946

947947
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
948948

949-
# **transfer_cycle_issues**
950-
> TransferCycleIssues200Response transfer_cycle_issues(cycle_id, project_id, slug, transfer_cycle_issue_request_request)
949+
# **transfer_cycle_work_items**
950+
> TransferCycleWorkItems200Response transfer_cycle_work_items(cycle_id, project_id, slug, transfer_cycle_issue_request_request)
951951
952-
Transfer cycle issues
952+
Transfer cycle work items
953953

954-
Move incomplete issues from the current cycle to a new target cycle. Captures progress snapshot and transfers only unfinished work items.
954+
Move incomplete work items from the current cycle to a new target cycle. Captures progress snapshot and transfers only unfinished work items.
955955

956956
### Example
957957

@@ -963,7 +963,7 @@ import time
963963
import os
964964
import plane
965965
from plane.models.transfer_cycle_issue_request_request import TransferCycleIssueRequestRequest
966-
from plane.models.transfer_cycle_issues200_response import TransferCycleIssues200Response
966+
from plane.models.transfer_cycle_work_items200_response import TransferCycleWorkItems200Response
967967
from plane.rest import ApiException
968968
from pprint import pprint
969969

@@ -998,12 +998,12 @@ with plane.ApiClient(configuration) as api_client:
998998
transfer_cycle_issue_request_request = {"new_cycle_id":"0ec6cfa4-e906-4aad-9390-2df0303a41ce"} # TransferCycleIssueRequestRequest |
999999

10001000
try:
1001-
# Transfer cycle issues
1002-
api_response = api_instance.transfer_cycle_issues(cycle_id, project_id, slug, transfer_cycle_issue_request_request)
1003-
print("The response of CyclesApi->transfer_cycle_issues:\n")
1001+
# Transfer cycle work items
1002+
api_response = api_instance.transfer_cycle_work_items(cycle_id, project_id, slug, transfer_cycle_issue_request_request)
1003+
print("The response of CyclesApi->transfer_cycle_work_items:\n")
10041004
pprint(api_response)
10051005
except Exception as e:
1006-
print("Exception when calling CyclesApi->transfer_cycle_issues: %s\n" % e)
1006+
print("Exception when calling CyclesApi->transfer_cycle_work_items: %s\n" % e)
10071007
```
10081008

10091009

@@ -1019,7 +1019,7 @@ Name | Type | Description | Notes
10191019

10201020
### Return type
10211021

1022-
[**TransferCycleIssues200Response**](TransferCycleIssues200Response.md)
1022+
[**TransferCycleWorkItems200Response**](TransferCycleWorkItems200Response.md)
10231023

10241024
### Authorization
10251025

@@ -1036,7 +1036,7 @@ Name | Type | Description | Notes
10361036
**401** | Authentication credentials were not provided or are invalid. | - |
10371037
**403** | Permission denied. User lacks required permissions. | - |
10381038
**404** | The requested resource was not found. | - |
1039-
**200** | Issues transferred successfully | - |
1039+
**200** | Work items transferred successfully | - |
10401040
**400** | Bad request | - |
10411041

10421042
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

0 commit comments

Comments
 (0)