From fcf7185a5eed9b62ba093bf61ffaa97a0a91b2ad Mon Sep 17 00:00:00 2001 From: VipinDevelops Date: Thu, 26 Mar 2026 14:55:26 +0530 Subject: [PATCH 1/3] chore: upate description --- .../assets/create-user-asset-upload.md | 27 +- .../assets/create-workspace-asset-upload.md | 23 +- .../api-reference/assets/delete-user-asset.md | 13 +- .../assets/get-workspace-asset.md | 30 +- docs/api-reference/assets/overview.md | 2 + .../api-reference/assets/update-user-asset.md | 25 +- .../assets/update-workspace-asset.md | 36 +- .../customer/add-customer-property.md | 73 +- .../customer/add-customer-request.md | 54 +- docs/api-reference/customer/add-customer.md | 49 +- .../customer/delete-customer-property.md | 38 +- .../customer/delete-customer-request.md | 42 +- .../api-reference/customer/delete-customer.md | 38 +- .../customer/get-customer-detail.md | 38 +- .../customer/get-customer-property-detail.md | 38 +- .../customer/get-customer-property-value.md | 42 +- .../customer/get-customer-request-detail.md | 42 +- .../customer/link-work-items-to-customer.md | 46 +- .../customer/list-customer-properties.md | 17 +- .../customer/list-customer-property-values.md | 38 +- .../customer/list-customer-requests.md | 38 +- .../customer/list-customer-work-items.md | 38 +- docs/api-reference/customer/list-customers.md | 17 +- .../unlink-work-item-from-customer.md | 42 +- .../customer/update-customer-detail.md | 74 +- .../update-customer-property-detail.md | 98 +- .../update-customer-property-value.md | 50 +- .../update-customer-request-detail.md | 58 +- .../cycle/add-cycle-work-items.md | 49 +- docs/api-reference/cycle/add-cycle.md | 920 +++++++++-------- docs/api-reference/cycle/archive-cycle.md | 40 +- docs/api-reference/cycle/delete-cycle.md | 40 +- docs/api-reference/cycle/get-cycle-detail.md | 40 +- .../cycle/list-archived-cycles.md | 38 +- .../cycle/list-cycle-work-items.md | 40 +- docs/api-reference/cycle/list-cycles.md | 38 +- .../cycle/remove-cycle-work-item.md | 46 +- .../cycle/transfer-cycle-work-items.md | 46 +- docs/api-reference/cycle/unarchive-cycle.md | 40 +- .../cycle/update-cycle-detail.md | 922 +++++++++--------- docs/api-reference/epics/get-epic-detail.md | 40 +- docs/api-reference/epics/list-epics.md | 38 +- .../estimate/add-estimate-points.md | 16 +- docs/api-reference/estimate/add-estimate.md | 14 +- .../estimate/delete-estimate-point.md | 18 +- .../api-reference/estimate/delete-estimate.md | 14 +- docs/api-reference/estimate/get-estimate.md | 14 +- .../estimate/list-estimate-points.md | 16 +- .../estimate/update-estimate-point.md | 18 +- .../api-reference/estimate/update-estimate.md | 14 +- .../initiative/add-epics-to-initiative.md | 46 +- .../initiative/add-initiative-label.md | 25 +- .../initiative/add-initiative.md | 51 +- .../initiative/add-labels-to-initiative.md | 46 +- .../initiative/add-projects-to-initiative.md | 46 +- .../initiative/delete-initiative-label.md | 44 +- .../initiative/delete-initiative.md | 44 +- .../initiative/get-initiative-detail.md | 44 +- .../initiative/get-initiative-label-detail.md | 44 +- .../initiative/list-initiative-epics.md | 44 +- .../list-initiative-labels-for-initiative.md | 38 +- .../initiative/list-initiative-labels.md | 38 +- .../initiative/list-initiative-projects.md | 38 +- .../initiative/list-initiatives.md | 38 +- .../remove-epics-from-initiative.md | 38 +- .../remove-labels-from-initiative.md | 38 +- .../remove-projects-from-initiative.md | 38 +- .../initiative/update-initiative-detail.md | 82 +- .../update-initiative-label-detail.md | 56 +- .../intake-issue/add-intake-issue.md | 50 +- .../intake-issue/delete-intake-issue.md | 46 +- .../intake-issue/get-intake-issue-detail.md | 40 +- .../intake-issue/list-intake-issues.md | 38 +- .../update-intake-issue-detail.md | 64 +- .../get-issue-activity-detail.md | 46 +- .../issue-activity/list-issue-activities.md | 40 +- .../issue-attachments/complete-upload.md | 52 +- .../issue-attachments/delete-attachment.md | 46 +- .../get-attachment-detail.md | 46 +- .../issue-attachments/get-attachments.md | 40 +- .../get-upload-credentials.md | 54 +- .../issue-attachments/update-attachment.md | 52 +- .../issue-comment/add-issue-comment.md | 68 +- .../issue-comment/delete-issue-comment.md | 46 +- .../issue-comment/get-issue-comment-detail.md | 60 +- .../issue-comment/list-issue-comments.md | 40 +- .../update-issue-comment-detail.md | 74 +- .../options/add-dropdown-options.md | 54 +- .../options/delete-dropdown-options.md | 42 +- .../issue-types/options/get-option-details.md | 42 +- .../options/list-dropdown-options.md | 42 +- .../options/update-dropdown-options.md | 54 +- .../issue-types/properties/add-property.md | 78 +- .../issue-types/properties/delete-property.md | 46 +- .../properties/get-property-details.md | 46 +- .../issue-types/properties/list-properties.md | 40 +- .../issue-types/properties/update-property.md | 84 +- .../issue-types/types/add-issue-type.md | 54 +- .../issue-types/types/delete-issue-type.md | 40 +- .../types/get-issue-type-details.md | 44 +- .../types/get-work-item-type-schema.md | 67 +- .../issue-types/types/list-issue-types.md | 42 +- .../issue-types/types/update-issue-types.md | 56 +- .../issue-types/values/add-property-values.md | 56 +- .../values/delete-property-value.md | 34 +- .../values/get-property-value-detail.md | 34 +- .../values/list-property-values.md | 46 +- .../values/update-property-value.md | 40 +- docs/api-reference/issue/add-issue.md | 80 +- .../issue/advanced-search-work-items.md | 17 +- docs/api-reference/issue/delete-issue.md | 40 +- docs/api-reference/issue/get-issue-detail.md | 48 +- .../issue/get-issue-sequence-id.md | 41 +- docs/api-reference/issue/list-issues.md | 44 +- docs/api-reference/issue/search-issues.md | 34 +- .../issue/update-issue-detail.md | 78 +- docs/api-reference/label/add-label.md | 52 +- docs/api-reference/label/delete-label.md | 40 +- docs/api-reference/label/get-label-detail.md | 40 +- docs/api-reference/label/list-labels.md | 38 +- .../label/update-label-detail.md | 54 +- docs/api-reference/link/add-link.md | 48 +- docs/api-reference/link/delete-link.md | 46 +- docs/api-reference/link/get-link-detail.md | 46 +- docs/api-reference/link/list-links.md | 40 +- docs/api-reference/link/update-link-detail.md | 54 +- .../members/add-project-member.md | 44 +- .../members/delete-project-member.md | 34 +- .../members/get-project-member-detail.md | 34 +- .../members/get-project-members.md | 38 +- .../members/get-workspace-members.md | 17 +- .../members/remove-workspace-member.md | 15 +- .../members/update-project-member.md | 48 +- .../api-reference/milestones/add-milestone.md | 42 +- .../milestones/delete-milestone.md | 32 +- .../milestones/get-milestone-detail.md | 32 +- .../milestones/list-milestone-work-items.md | 32 +- .../milestones/list-milestones.md | 30 +- .../milestones/update-milestone-detail.md | 44 +- .../module/add-module-work-items.md | 49 +- docs/api-reference/module/add-module.md | 66 +- docs/api-reference/module/archive-module.md | 40 +- docs/api-reference/module/delete-module.md | 40 +- .../api-reference/module/get-module-detail.md | 40 +- .../module/list-archived-modules.md | 38 +- .../module/list-module-work-items.md | 40 +- docs/api-reference/module/list-modules.md | 38 +- .../module/remove-module-work-item.md | 46 +- docs/api-reference/module/unarchive-module.md | 40 +- .../module/update-module-detail.md | 68 +- docs/api-reference/page/add-project-page.md | 66 +- docs/api-reference/page/add-workspace-page.md | 41 +- docs/api-reference/page/get-project-page.md | 40 +- docs/api-reference/page/get-workspace-page.md | 38 +- .../project-features/get-project-features.md | 30 +- .../update-project-features.md | 48 +- .../project-labels/add-project-label.md | 17 +- .../project-labels/delete-project-label.md | 32 +- .../get-project-label-detail.md | 32 +- .../project-labels/list-project-labels.md | 24 +- .../update-project-label-detail.md | 42 +- docs/api-reference/project/add-project.md | 891 ++++++++--------- docs/api-reference/project/archive-project.md | 30 +- docs/api-reference/project/delete-project.md | 38 +- .../project/get-project-detail.md | 38 +- docs/api-reference/project/list-projects.md | 30 +- .../project/unarchive-project.md | 30 +- .../project/update-project-detail.md | 916 +++++++++-------- docs/api-reference/state/add-state.md | 64 +- docs/api-reference/state/delete-state.md | 40 +- docs/api-reference/state/get-state-detail.md | 40 +- docs/api-reference/state/list-states.md | 38 +- .../state/update-state-detail.md | 66 +- docs/api-reference/sticky/add-sticky.md | 39 +- docs/api-reference/sticky/delete-sticky.md | 38 +- .../api-reference/sticky/get-sticky-detail.md | 38 +- docs/api-reference/sticky/list-stickies.md | 25 +- .../sticky/update-sticky-detail.md | 64 +- .../teamspace/add-projects-to-teamspace.md | 44 +- .../teamspace/add-teamspace-members.md | 44 +- docs/api-reference/teamspace/add-teamspace.md | 33 +- .../teamspace/delete-teamspace.md | 42 +- .../teamspace/get-teamspace-detail.md | 42 +- .../teamspace/list-teamspace-members.md | 36 +- .../teamspace/list-teamspace-projects.md | 36 +- .../teamspace/list-teamspaces.md | 38 +- .../remove-projects-from-teamspace.md | 36 +- .../teamspace/remove-teamspace-members.md | 36 +- .../teamspace/update-teamspace-detail.md | 62 +- docs/api-reference/user/get-current-user.md | 11 +- .../work-item-pages/add-work-item-page.md | 42 +- .../work-item-pages/delete-work-item-page.md | 40 +- .../get-work-item-page-detail.md | 40 +- .../work-item-pages/list-work-item-pages.md | 36 +- docs/api-reference/worklogs/create-worklog.md | 52 +- docs/api-reference/worklogs/delete-worklog.md | 46 +- docs/api-reference/worklogs/get-total-time.md | 38 +- .../worklogs/get-worklogs-for-issue.md | 40 +- docs/api-reference/worklogs/update-worklog.md | 58 +- .../get-workspace-features.md | 11 +- .../update-workspace-features.md | 23 +- .../add-workspace-invitation.md | 21 +- .../delete-workspace-invitation.md | 32 +- .../get-workspace-invitation-detail.md | 32 +- .../list-workspace-invitations.md | 11 +- .../workspace-invitations/overview.md | 2 +- .../update-workspace-invitation.md | 46 +- 207 files changed, 5853 insertions(+), 6167 deletions(-) diff --git a/docs/api-reference/assets/create-user-asset-upload.md b/docs/api-reference/assets/create-user-asset-upload.md index 735620c..6cbeb26 100644 --- a/docs/api-reference/assets/create-user-asset-upload.md +++ b/docs/api-reference/assets/create-user-asset-upload.md @@ -32,11 +32,11 @@ Original filename of the asset MIME type of the file -- `image/jpeg` - JPEG -- `image/png` - PNG -- `image/webp` - WebP -- `image/jpg` - JPG -- `image/gif` - GIF +* `image/jpeg` - JPEG +* `image/png` - PNG +* `image/webp` - WebP +* `image/jpg` - JPG +* `image/gif` - GIF @@ -50,8 +50,8 @@ File size in bytes Type of user asset -- `USER_AVATAR` - User Avatar -- `USER_COVER` - User Cover +* `USER_AVATAR` - User Avatar +* `USER_COVER` - User Cover @@ -66,6 +66,7 @@ Type of user asset +
@@ -114,14 +115,14 @@ const response = await fetch("https://api.plane.so/api/v1/assets/user-assets/", method: "POST", headers: { "X-API-Key": "your-api-key", - "Content-Type": "application/json", + "Content-Type": "application/json" }, body: JSON.stringify({ - name: "Example Name", - type: "image/jpeg", - size: 1024000, - entity_type: "USER_AVATAR", - }), + "name": "Example Name", + "type": "image/jpeg", + "size": 1024000, + "entity_type": "USER_AVATAR" +}), }); const data = await response.json(); ``` diff --git a/docs/api-reference/assets/create-workspace-asset-upload.md b/docs/api-reference/assets/create-workspace-asset-upload.md index 472445a..29c90c8 100644 --- a/docs/api-reference/assets/create-workspace-asset-upload.md +++ b/docs/api-reference/assets/create-workspace-asset-upload.md @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, assets, create workspace
POST - /api/v1/workspaces/{slug}/assets/ + /api/v1/workspaces/{workspace_slug}/assets/
@@ -22,9 +22,9 @@ Generate presigned URL for generic asset upload
- + -Workspace slug +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. @@ -84,6 +84,7 @@ External source system (for integration tracking)
+
@@ -136,16 +137,16 @@ const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspac method: "POST", headers: { "X-API-Key": "your-api-key", - "Content-Type": "application/json", + "Content-Type": "application/json" }, body: JSON.stringify({ - name: "Example Name", - type: "image/jpeg", - size: 1024000, - project_id: "550e8400-e29b-41d4-a716-446655440000", - external_id: "550e8400-e29b-41d4-a716-446655440000", - external_source: "github", - }), + "name": "Example Name", + "type": "image/jpeg", + "size": 1024000, + "project_id": "550e8400-e29b-41d4-a716-446655440000", + "external_id": "550e8400-e29b-41d4-a716-446655440000", + "external_source": "github" +}), }); const data = await response.json(); ``` diff --git a/docs/api-reference/assets/delete-user-asset.md b/docs/api-reference/assets/delete-user-asset.md index 1fdef24..acc4fca 100644 --- a/docs/api-reference/assets/delete-user-asset.md +++ b/docs/api-reference/assets/delete-user-asset.md @@ -27,7 +27,7 @@ This performs a soft delete by marking the asset as deleted and updating the use -Asset ID +The unique identifier of the asset. @@ -42,6 +42,7 @@ Asset ID
+
@@ -51,9 +52,9 @@ Asset ID ```bash curl -X DELETE \ - "https://api.plane.so/api/v1/assets/user-assets/550e8400-e29b-41d4-a716-446655440002/" \ + "https://api.plane.so/api/v1/assets/user-assets/asset-uuid/" \ -H "X-API-Key: $PLANE_API_KEY" \ - # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \ + # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" ``` @@ -63,7 +64,7 @@ curl -X DELETE \ import requests response = requests.delete( - "https://api.plane.so/api/v1/assets/user-assets/550e8400-e29b-41d4-a716-446655440002/", + "https://api.plane.so/api/v1/assets/user-assets/asset-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.status_code) @@ -73,10 +74,10 @@ print(response.status_code) @@ -66,7 +67,7 @@ curl -X GET \ import requests response = requests.get( - "https://api.plane.so/api/v1/workspaces/my-workspace/assets/550e8400-e29b-41d4-a716-446655440002/", + "https://api.plane.so/api/v1/workspaces/my-workspace/assets/asset-uuid/", headers={"X-API-Key": "your-api-key"} ) print(response.json()) @@ -76,15 +77,12 @@ print(response.json())