Skip to content

Commit 783681b

Browse files
Prashant-SuryaPrashant-Surya
authored
[SILO-437] fix: types for apis (#2)
* [SILO-437] fix types for apis - add IssueSearchItemSerializer type for issues search endpoint - add a new IssueDetailSerializer extending IssueSerializer for detail api - exclude slug field from State API response - add many=True for serializer responses with arrays - add IssuePropertyValueAPIDetailSerializer for issue property values * upgrade to v2 for gh-release action
1 parent bcfc08d commit 783681b

21 files changed

+398
-84
lines changed

‎.github/workflows/publish.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ jobs:
4343
echo "current-version=$VERSION" >> $GITHUB_OUTPUT
4444
4545
- name: Create GitHub Release
46-
uses: softprops/action-gh-release@v1
46+
uses: softprops/action-gh-release@v2
4747
with:
4848
tag_name: v${{ steps.package-version.outputs.current-version }}
4949
name: v${{ steps.package-version.outputs.current-version }}

‎.openapi-generator/FILES‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ docs/IssueAttachment.md
2525
docs/IssueAttachmentUploadRequest.md
2626
docs/IssueComment.md
2727
docs/IssueCommentCreateRequest.md
28+
docs/IssueDetail.md
2829
docs/IssueExpand.md
2930
docs/IssueForIntakeRequest.md
3031
docs/IssueLink.md
@@ -34,6 +35,7 @@ docs/IssuePropertyAPIRequest.md
3435
docs/IssuePropertyOptionAPI.md
3536
docs/IssuePropertyOptionAPIRequest.md
3637
docs/IssuePropertyValueAPI.md
38+
docs/IssuePropertyValueAPIDetail.md
3739
docs/IssuePropertyValueAPIRequest.md
3840
docs/IssueRequest.md
3941
docs/IssueSearch.md
@@ -44,7 +46,6 @@ docs/IssueWorkLogAPI.md
4446
docs/IssueWorkLogAPIRequest.md
4547
docs/Label.md
4648
docs/LabelCreateUpdateRequest.md
47-
docs/LabelLite.md
4849
docs/LabelsApi.md
4950
docs/MembersApi.md
5051
docs/Module.md
@@ -158,6 +159,7 @@ plane/models/issue_attachment.py
158159
plane/models/issue_attachment_upload_request.py
159160
plane/models/issue_comment.py
160161
plane/models/issue_comment_create_request.py
162+
plane/models/issue_detail.py
161163
plane/models/issue_expand.py
162164
plane/models/issue_for_intake_request.py
163165
plane/models/issue_link.py
@@ -167,6 +169,7 @@ plane/models/issue_property_api_request.py
167169
plane/models/issue_property_option_api.py
168170
plane/models/issue_property_option_api_request.py
169171
plane/models/issue_property_value_api.py
172+
plane/models/issue_property_value_api_detail.py
170173
plane/models/issue_property_value_api_request.py
171174
plane/models/issue_request.py
172175
plane/models/issue_search.py
@@ -177,7 +180,6 @@ plane/models/issue_work_log_api.py
177180
plane/models/issue_work_log_api_request.py
178181
plane/models/label.py
179182
plane/models/label_create_update_request.py
180-
plane/models/label_lite.py
181183
plane/models/module.py
182184
plane/models/module_create_request.py
183185
plane/models/module_issue.py

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The Plane REST API
44
Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
55

66
- API version: 0.0.1
7-
- Package version: 0.1.5
7+
- Package version: 0.1.6
88
- Generator version: 7.13.0
99
- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
1010
For more information, please visit [https://plane.so](https://plane.so)
@@ -215,6 +215,7 @@ Class | Method | HTTP request | Description
215215
- [IssueAttachmentUploadRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueAttachmentUploadRequest.md)
216216
- [IssueComment](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueComment.md)
217217
- [IssueCommentCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueCommentCreateRequest.md)
218+
- [IssueDetail](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueDetail.md)
218219
- [IssueExpand](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueExpand.md)
219220
- [IssueForIntakeRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueForIntakeRequest.md)
220221
- [IssueLink](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueLink.md)
@@ -224,6 +225,7 @@ Class | Method | HTTP request | Description
224225
- [IssuePropertyOptionAPI](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyOptionAPI.md)
225226
- [IssuePropertyOptionAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyOptionAPIRequest.md)
226227
- [IssuePropertyValueAPI](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyValueAPI.md)
228+
- [IssuePropertyValueAPIDetail](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyValueAPIDetail.md)
227229
- [IssuePropertyValueAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssuePropertyValueAPIRequest.md)
228230
- [IssueRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueRequest.md)
229231
- [IssueSearch](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueSearch.md)
@@ -234,7 +236,6 @@ Class | Method | HTTP request | Description
234236
- [IssueWorkLogAPIRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/IssueWorkLogAPIRequest.md)
235237
- [Label](https://github.com/makeplane/plane-python-sdk/blob/main/docs/Label.md)
236238
- [LabelCreateUpdateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelCreateUpdateRequest.md)
237-
- [LabelLite](https://github.com/makeplane/plane-python-sdk/blob/main/docs/LabelLite.md)
238239
- [Module](https://github.com/makeplane/plane-python-sdk/blob/main/docs/Module.md)
239240
- [ModuleCreateRequest](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModuleCreateRequest.md)
240241
- [ModuleIssue](https://github.com/makeplane/plane-python-sdk/blob/main/docs/ModuleIssue.md)

‎docs/IssueDetail.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# IssueDetail
2+
3+
Comprehensive work item serializer with full relationship management. Handles complete work item lifecycle including assignees, labels, validation, and related model updates. Supports dynamic field expansion and HTML content processing.
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**id** | **str** | | [optional] [readonly]
9+
**assignees** | [**List[UserLite]**](UserLite.md) | |
10+
**labels** | [**List[Label]**](Label.md) | |
11+
**type_id** | **str** | | [optional]
12+
**created_at** | **datetime** | | [optional] [readonly]
13+
**updated_at** | **datetime** | | [optional] [readonly]
14+
**deleted_at** | **datetime** | | [optional]
15+
**point** | **int** | | [optional]
16+
**name** | **str** | |
17+
**description_html** | **str** | | [optional]
18+
**description_stripped** | **str** | | [optional]
19+
**description_binary** | **bytearray** | | [optional] [readonly]
20+
**priority** | [**PriorityEnum**](PriorityEnum.md) | | [optional]
21+
**start_date** | **date** | | [optional]
22+
**target_date** | **date** | | [optional]
23+
**sequence_id** | **int** | | [optional]
24+
**sort_order** | **float** | | [optional]
25+
**completed_at** | **datetime** | | [optional]
26+
**archived_at** | **date** | | [optional]
27+
**is_draft** | **bool** | | [optional]
28+
**external_source** | **str** | | [optional]
29+
**external_id** | **str** | | [optional]
30+
**created_by** | **str** | | [optional]
31+
**updated_by** | **str** | | [optional] [readonly]
32+
**project** | **str** | | [optional] [readonly]
33+
**workspace** | **str** | | [optional] [readonly]
34+
**parent** | **str** | | [optional]
35+
**state** | **str** | | [optional]
36+
**estimate_point** | **str** | | [optional]
37+
**type** | **str** | | [optional]
38+
39+
## Example
40+
41+
```python
42+
from plane.models.issue_detail import IssueDetail
43+
44+
# TODO update the JSON string below
45+
json = "{}"
46+
# create an instance of IssueDetail from a JSON string
47+
issue_detail_instance = IssueDetail.from_json(json)
48+
# print the JSON string representation of the object
49+
print IssueDetail.to_json()
50+
51+
# convert the object into a dict
52+
issue_detail_dict = issue_detail_instance.to_dict()
53+
# create an instance of IssueDetail from a dict
54+
issue_detail_from_dict = IssueDetail.from_dict(issue_detail_dict)
55+
```
56+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
57+
58+

‎docs/IssueExpand.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Name | Type | Description | Notes
88
**id** | **str** | | [optional] [readonly]
99
**cycle** | [**CycleLite**](CycleLite.md) | | [optional] [readonly]
1010
**module** | [**ModuleLite**](ModuleLite.md) | | [optional] [readonly]
11-
**labels** | [**List[LabelLite]**](LabelLite.md) | | [optional] [readonly]
12-
**assignees** | [**List[UserLite]**](UserLite.md) | | [optional] [readonly]
11+
**labels** | **str** | | [optional] [readonly]
12+
**assignees** | **str** | | [optional] [readonly]
1313
**state** | [**StateLite**](StateLite.md) | | [optional] [readonly]
1414
**created_at** | **datetime** | | [optional] [readonly]
1515
**updated_at** | **datetime** | | [optional] [readonly]

‎docs/IssuePropertyValueAPIDetail.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# IssuePropertyValueAPIDetail
2+
3+
Serializer for aggregated issue property values response. This serializer handles the response format from the query_annotator method which returns property_id and values (ArrayAgg of property values).
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**property_id** | **str** | The ID of the issue property |
9+
**values** | **List[str]** | List of aggregated property values for the given property |
10+
11+
## Example
12+
13+
```python
14+
from plane.models.issue_property_value_api_detail import IssuePropertyValueAPIDetail
15+
16+
# TODO update the JSON string below
17+
json = "{}"
18+
# create an instance of IssuePropertyValueAPIDetail from a JSON string
19+
issue_property_value_api_detail_instance = IssuePropertyValueAPIDetail.from_json(json)
20+
# print the JSON string representation of the object
21+
print IssuePropertyValueAPIDetail.to_json()
22+
23+
# convert the object into a dict
24+
issue_property_value_api_detail_dict = issue_property_value_api_detail_instance.to_dict()
25+
# create an instance of IssuePropertyValueAPIDetail from a dict
26+
issue_property_value_api_detail_from_dict = IssuePropertyValueAPIDetail.from_dict(issue_property_value_api_detail_dict)
27+
```
28+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
29+
30+

‎docs/IssueSearch.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# IssueSearch
22

3-
Serializer for work item search result data formatting. Provides standardized search result structure including work item identifiers, project context, and workspace information for search API responses.
3+
Search results for work items. Provides list of issues with their identifiers, names, and project context.
44

55
## Properties
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**issues** | [**List[IssueSearchItem]**](IssueSearchItem.md) | Array of search result issues |
8+
**issues** | [**List[IssueSearchItem]**](IssueSearchItem.md) | |
99

1010
## Example
1111

‎docs/WorkItemPropertiesApi.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ void (empty response body)
487487
[[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)
488488

489489
# **list_issue_properties**
490-
> IssuePropertyAPI list_issue_properties(project_id, slug, type_id)
490+
> List[IssuePropertyAPI] list_issue_properties(project_id, slug, type_id)
491491
492492
List issue properties
493493

@@ -556,7 +556,7 @@ Name | Type | Description | Notes
556556

557557
### Return type
558558

559-
[**IssuePropertyAPI**](IssuePropertyAPI.md)
559+
[**List[IssuePropertyAPI]**](IssuePropertyAPI.md)
560560

561561
### Authorization
562562

@@ -578,7 +578,7 @@ Name | Type | Description | Notes
578578
[[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)
579579

580580
# **list_issue_property_options**
581-
> IssuePropertyOptionAPI list_issue_property_options(project_id, property_id, slug)
581+
> List[IssuePropertyOptionAPI] list_issue_property_options(project_id, property_id, slug)
582582
583583
List issue property options
584584

@@ -647,7 +647,7 @@ Name | Type | Description | Notes
647647

648648
### Return type
649649

650-
[**IssuePropertyOptionAPI**](IssuePropertyOptionAPI.md)
650+
[**List[IssuePropertyOptionAPI]**](IssuePropertyOptionAPI.md)
651651

652652
### Authorization
653653

@@ -669,7 +669,7 @@ Name | Type | Description | Notes
669669
[[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)
670670

671671
# **list_issue_property_values**
672-
> IssuePropertyValueAPI list_issue_property_values(issue_id, project_id, property_id, slug)
672+
> List[IssuePropertyValueAPIDetail] list_issue_property_values(issue_id, project_id, property_id, slug)
673673
674674
List issue property values
675675

@@ -684,7 +684,7 @@ List issue property values
684684
import time
685685
import os
686686
import plane
687-
from plane.models.issue_property_value_api import IssuePropertyValueAPI
687+
from plane.models.issue_property_value_api_detail import IssuePropertyValueAPIDetail
688688
from plane.rest import ApiException
689689
from pprint import pprint
690690

@@ -740,7 +740,7 @@ Name | Type | Description | Notes
740740

741741
### Return type
742742

743-
[**IssuePropertyValueAPI**](IssuePropertyValueAPI.md)
743+
[**List[IssuePropertyValueAPIDetail]**](IssuePropertyValueAPIDetail.md)
744744

745745
### Authorization
746746

‎docs/WorkItemsApi.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ Name | Type | Description | Notes
389389
[[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)
390390

391391
# **retrieve_work_item**
392-
> Issue retrieve_work_item(pk, project_id, slug, expand=expand, external_id=external_id, external_source=external_source, fields=fields, order_by=order_by)
392+
> IssueDetail retrieve_work_item(pk, project_id, slug, expand=expand, external_id=external_id, external_source=external_source, fields=fields, order_by=order_by)
393393
394394
Retrieve work item
395395

@@ -404,7 +404,7 @@ Retrieve details of a specific work item.
404404
import time
405405
import os
406406
import plane
407-
from plane.models.issue import Issue
407+
from plane.models.issue_detail import IssueDetail
408408
from plane.rest import ApiException
409409
from pprint import pprint
410410

@@ -468,7 +468,7 @@ Name | Type | Description | Notes
468468

469469
### Return type
470470

471-
[**Issue**](Issue.md)
471+
[**IssueDetail**](IssueDetail.md)
472472

473473
### Authorization
474474

‎plane/__init__.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
""" # noqa: E501
1616

1717

18-
__version__ = "0.1.5"
18+
__version__ = "0.1.6"
1919

2020
# import apis into sdk package
2121
from plane.api.assets_api import AssetsApi
@@ -67,6 +67,7 @@
6767
from plane.models.issue_attachment_upload_request import IssueAttachmentUploadRequest
6868
from plane.models.issue_comment import IssueComment
6969
from plane.models.issue_comment_create_request import IssueCommentCreateRequest
70+
from plane.models.issue_detail import IssueDetail
7071
from plane.models.issue_expand import IssueExpand
7172
from plane.models.issue_for_intake_request import IssueForIntakeRequest
7273
from plane.models.issue_link import IssueLink
@@ -76,6 +77,7 @@
7677
from plane.models.issue_property_option_api import IssuePropertyOptionAPI
7778
from plane.models.issue_property_option_api_request import IssuePropertyOptionAPIRequest
7879
from plane.models.issue_property_value_api import IssuePropertyValueAPI
80+
from plane.models.issue_property_value_api_detail import IssuePropertyValueAPIDetail
7981
from plane.models.issue_property_value_api_request import IssuePropertyValueAPIRequest
8082
from plane.models.issue_request import IssueRequest
8183
from plane.models.issue_search import IssueSearch
@@ -86,7 +88,6 @@
8688
from plane.models.issue_work_log_api_request import IssueWorkLogAPIRequest
8789
from plane.models.label import Label
8890
from plane.models.label_create_update_request import LabelCreateUpdateRequest
89-
from plane.models.label_lite import LabelLite
9091
from plane.models.module import Module
9192
from plane.models.module_create_request import ModuleCreateRequest
9293
from plane.models.module_issue import ModuleIssue

0 commit comments

Comments
 (0)