Skip to content

Commit f8451f4

Browse files
committed
docs: refresh API reference and add new endpoints
1 parent f0704cb commit f8451f4

File tree

210 files changed

+15955
-4876
lines changed

Some content is hidden

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

210 files changed

+15955
-4876
lines changed

docs/.vitepress/config.mts

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,22 @@ export default withMermaid(
338338
text: "API Reference",
339339
items: [
340340
{ text: "Introduction", link: "/api-reference/introduction" },
341+
{
342+
text: "Assets",
343+
collapsed: true,
344+
items: [
345+
{ text: "Overview", link: "/api-reference/assets/overview" },
346+
{ text: "Create User Asset Upload", link: "/api-reference/assets/create-user-asset-upload" },
347+
{ text: "Update User Asset", link: "/api-reference/assets/update-user-asset" },
348+
{ text: "Delete User Asset", link: "/api-reference/assets/delete-user-asset" },
349+
{
350+
text: "Create Workspace Asset Upload",
351+
link: "/api-reference/assets/create-workspace-asset-upload",
352+
},
353+
{ text: "Get Workspace Asset", link: "/api-reference/assets/get-workspace-asset" },
354+
{ text: "Update Workspace Asset", link: "/api-reference/assets/update-workspace-asset" },
355+
],
356+
},
341357
{
342358
text: "Project",
343359
collapsed: true,
@@ -347,9 +363,23 @@ export default withMermaid(
347363
{ text: "List Projects", link: "/api-reference/project/list-projects" },
348364
{ text: "Get Project", link: "/api-reference/project/get-project-detail" },
349365
{ text: "Update Project", link: "/api-reference/project/update-project-detail" },
366+
{ text: "Archive Project", link: "/api-reference/project/archive-project" },
367+
{ text: "Unarchive Project", link: "/api-reference/project/unarchive-project" },
350368
{ text: "Delete Project", link: "/api-reference/project/delete-project" },
351369
],
352370
},
371+
{
372+
text: "Project Features",
373+
collapsed: true,
374+
items: [
375+
{ text: "Overview", link: "/api-reference/project-features/overview" },
376+
{ text: "Get Project Features", link: "/api-reference/project-features/get-project-features" },
377+
{
378+
text: "Update Project Features",
379+
link: "/api-reference/project-features/update-project-features",
380+
},
381+
],
382+
},
353383
{
354384
text: "State",
355385
collapsed: true,
@@ -374,17 +404,42 @@ export default withMermaid(
374404
{ text: "Delete Label", link: "/api-reference/label/delete-label" },
375405
],
376406
},
407+
{
408+
text: "Project Labels",
409+
collapsed: true,
410+
items: [
411+
{ text: "Overview", link: "/api-reference/project-labels/overview" },
412+
{ text: "Create Project Label", link: "/api-reference/project-labels/add-project-label" },
413+
{ text: "List Project Labels", link: "/api-reference/project-labels/list-project-labels" },
414+
{
415+
text: "Get Project Label",
416+
link: "/api-reference/project-labels/get-project-label-detail",
417+
},
418+
{
419+
text: "Update Project Label",
420+
link: "/api-reference/project-labels/update-project-label-detail",
421+
},
422+
{ text: "Delete Project Label", link: "/api-reference/project-labels/delete-project-label" },
423+
],
424+
},
377425
{
378426
text: "Work Item",
379427
collapsed: true,
380428
items: [
381429
{ text: "Overview", link: "/api-reference/issue/overview" },
382430
{ text: "Create Work Item", link: "/api-reference/issue/add-issue" },
431+
{ text: "Create Work Item (Create)", link: "/api-reference/issue/create-work-item-from-schema" },
383432
{ text: "List Work Items", link: "/api-reference/issue/list-issues" },
384433
{ text: "Get Work Item", link: "/api-reference/issue/get-issue-detail" },
434+
{ text: "Get Work Item with Properties", link: "/api-reference/issue/get-work-item-properties" },
385435
{ text: "Get by Sequence ID", link: "/api-reference/issue/get-issue-sequence-id" },
386436
{ text: "Search Work Items", link: "/api-reference/issue/search-issues" },
437+
{ text: "Advanced Search", link: "/api-reference/issue/advanced-search-work-items" },
387438
{ text: "Update Work Item", link: "/api-reference/issue/update-issue-detail" },
439+
{
440+
text: "Update Work Item with Properties",
441+
link: "/api-reference/issue/update-work-item-properties",
442+
},
388443
{ text: "Delete Work Item", link: "/api-reference/issue/delete-issue" },
389444
],
390445
},
@@ -443,6 +498,7 @@ export default withMermaid(
443498
{ text: "Add Type", link: "/api-reference/issue-types/types/add-issue-type" },
444499
{ text: "List Types", link: "/api-reference/issue-types/types/list-issue-types" },
445500
{ text: "Get Type Details", link: "/api-reference/issue-types/types/get-issue-type-details" },
501+
{ text: "Get Type Schema", link: "/api-reference/issue-types/types/get-work-item-type-schema" },
446502
{ text: "Update Type", link: "/api-reference/issue-types/types/update-issue-types" },
447503
{ text: "Delete Type", link: "/api-reference/issue-types/types/delete-issue-type" },
448504
],
@@ -466,6 +522,9 @@ export default withMermaid(
466522
{ text: "Overview", link: "/api-reference/issue-types/values/overview" },
467523
{ text: "Add Property Values", link: "/api-reference/issue-types/values/add-property-values" },
468524
{ text: "List Property Values", link: "/api-reference/issue-types/values/list-property-values" },
525+
{ text: "Get Property Value", link: "/api-reference/issue-types/values/get-property-value-detail" },
526+
{ text: "Update Property Value", link: "/api-reference/issue-types/values/update-property-value" },
527+
{ text: "Delete Property Value", link: "/api-reference/issue-types/values/delete-property-value" },
469528
],
470529
},
471530
{
@@ -534,6 +593,36 @@ export default withMermaid(
534593
{ text: "Get Project Page", link: "/api-reference/page/get-project-page" },
535594
],
536595
},
596+
{
597+
text: "Milestones",
598+
collapsed: true,
599+
items: [
600+
{ text: "Overview", link: "/api-reference/milestones/overview" },
601+
{ text: "Create Milestone", link: "/api-reference/milestones/add-milestone" },
602+
{ text: "List Milestones", link: "/api-reference/milestones/list-milestones" },
603+
{ text: "Get Milestone", link: "/api-reference/milestones/get-milestone-detail" },
604+
{ text: "List Milestone Work Items", link: "/api-reference/milestones/list-milestone-work-items" },
605+
{ text: "Update Milestone", link: "/api-reference/milestones/update-milestone-detail" },
606+
{ text: "Delete Milestone", link: "/api-reference/milestones/delete-milestone" },
607+
],
608+
},
609+
{
610+
text: "Work Item Pages",
611+
collapsed: true,
612+
items: [
613+
{ text: "Overview", link: "/api-reference/work-item-pages/overview" },
614+
{ text: "Create Work Item Page Link", link: "/api-reference/work-item-pages/add-work-item-page" },
615+
{ text: "List Work Item Pages", link: "/api-reference/work-item-pages/list-work-item-pages" },
616+
{
617+
text: "Get Work Item Page Link",
618+
link: "/api-reference/work-item-pages/get-work-item-page-detail",
619+
},
620+
{
621+
text: "Delete Work Item Page Link",
622+
link: "/api-reference/work-item-pages/delete-work-item-page",
623+
},
624+
],
625+
},
537626
{
538627
text: "Intake",
539628
collapsed: true,
@@ -703,9 +792,55 @@ export default withMermaid(
703792
{ text: "Overview", link: "/api-reference/members/overview" },
704793
{ text: "Get Workspace Members", link: "/api-reference/members/get-workspace-members" },
705794
{ text: "Get Project Members", link: "/api-reference/members/get-project-members" },
795+
{ text: "Create Project Member", link: "/api-reference/members/add-project-member" },
796+
{ text: "Get Project Member", link: "/api-reference/members/get-project-member-detail" },
797+
{ text: "Update Project Member", link: "/api-reference/members/update-project-member" },
798+
{ text: "Delete Project Member", link: "/api-reference/members/delete-project-member" },
706799
{ text: "Remove Workspace Members", link: "/api-reference/members/remove-workspace-member" },
707800
],
708801
},
802+
{
803+
text: "Workspace Features",
804+
collapsed: true,
805+
items: [
806+
{ text: "Overview", link: "/api-reference/workspace-features/overview" },
807+
{
808+
text: "Get Workspace Features",
809+
link: "/api-reference/workspace-features/get-workspace-features",
810+
},
811+
{
812+
text: "Update Workspace Features",
813+
link: "/api-reference/workspace-features/update-workspace-features",
814+
},
815+
],
816+
},
817+
{
818+
text: "Workspace Invitations",
819+
collapsed: true,
820+
items: [
821+
{ text: "Overview", link: "/api-reference/workspace-invitations/overview" },
822+
{
823+
text: "Create Workspace Invitation",
824+
link: "/api-reference/workspace-invitations/add-workspace-invitation",
825+
},
826+
{
827+
text: "List Workspace Invitations",
828+
link: "/api-reference/workspace-invitations/list-workspace-invitations",
829+
},
830+
{
831+
text: "Get Workspace Invitation",
832+
link: "/api-reference/workspace-invitations/get-workspace-invitation-detail",
833+
},
834+
{
835+
text: "Update Workspace Invitation",
836+
link: "/api-reference/workspace-invitations/update-workspace-invitation",
837+
},
838+
{
839+
text: "Delete Workspace Invitation",
840+
link: "/api-reference/workspace-invitations/delete-workspace-invitation",
841+
},
842+
],
843+
},
709844
{
710845
text: "User",
711846
collapsed: true,
Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
---
2+
title: Create user asset upload
3+
description: Create user asset upload via Plane API. HTTP request format, parameters, scopes, and example responses for create user asset upload.
4+
keywords: plane, plane api, rest api, api integration, assets, create user asset upload
5+
---
6+
7+
# Create user asset upload
8+
9+
<div class="api-endpoint-badge">
10+
<span class="method post">POST</span>
11+
<span class="path">/api/v1/assets/user-assets/</span>
12+
</div>
13+
14+
<div class="api-two-column">
15+
<div class="api-left">
16+
17+
Generate presigned URL for user asset upload
18+
19+
<div class="params-section">
20+
21+
### Body Parameters
22+
23+
<div class="params-list">
24+
25+
<ApiParam name="name" type="string" :required="true">
26+
27+
Original filename of the asset
28+
29+
</ApiParam>
30+
31+
<ApiParam name="type" type="string" :required="false">
32+
33+
MIME type of the file
34+
35+
- `image/jpeg` - JPEG
36+
- `image/png` - PNG
37+
- `image/webp` - WebP
38+
- `image/jpg` - JPG
39+
- `image/gif` - GIF
40+
41+
</ApiParam>
42+
43+
<ApiParam name="size" type="integer" :required="true">
44+
45+
File size in bytes
46+
47+
</ApiParam>
48+
49+
<ApiParam name="entity_type" type="string" :required="true">
50+
51+
Type of user asset
52+
53+
- `USER_AVATAR` - User Avatar
54+
- `USER_COVER` - User Cover
55+
56+
</ApiParam>
57+
58+
</div>
59+
</div>
60+
61+
<div class="params-section">
62+
63+
### Scopes
64+
65+
`assets:write`
66+
67+
</div>
68+
69+
</div>
70+
71+
<div class="api-right">
72+
73+
<CodePanel title="Create user asset upload" :languages="['cURL', 'Python', 'JavaScript']">
74+
<template #curl>
75+
76+
```bash
77+
curl -X POST \
78+
"https://api.plane.so/api/v1/assets/user-assets/" \
79+
-H "X-API-Key: $PLANE_API_KEY" \
80+
-H "Content-Type: application/json" \
81+
-d '{
82+
"name": "Example Name",
83+
"type": "image/jpeg",
84+
"size": 1024000,
85+
"entity_type": "USER_AVATAR"
86+
}'
87+
```
88+
89+
</template>
90+
<template #python>
91+
92+
```python
93+
import requests
94+
95+
response = requests.post(
96+
"https://api.plane.so/api/v1/assets/user-assets/",
97+
headers={"X-API-Key": "your-api-key"},
98+
json={
99+
"name": "Example Name",
100+
"type": "image/jpeg",
101+
"size": 1024000,
102+
"entity_type": "USER_AVATAR"
103+
}
104+
)
105+
print(response.json())
106+
```
107+
108+
</template>
109+
<template #javascript>
110+
111+
```javascript
112+
const response = await fetch("https://api.plane.so/api/v1/assets/user-assets/", {
113+
method: "POST",
114+
headers: {
115+
"X-API-Key": "your-api-key",
116+
"Content-Type": "application/json",
117+
},
118+
body: JSON.stringify({
119+
name: "Example Name",
120+
type: "image/jpeg",
121+
size: 1024000,
122+
entity_type: "USER_AVATAR",
123+
}),
124+
});
125+
const data = await response.json();
126+
```
127+
128+
</template>
129+
</CodePanel>
130+
131+
<ResponsePanel status="200">
132+
133+
```json
134+
{
135+
"asset_id": "550e8400-e29b-41d4-a716-446655440000",
136+
"asset_url": "/api/assets/v2/static/550e8400-e29b-41d4-a716-446655440000/",
137+
"upload_data": {
138+
"url": "https://uploads.example.com/plane-bucket",
139+
"fields": {
140+
"Content-Type": "image/png",
141+
"key": "user-assets/550e8400-e29b-41d4-a716-446655440000/profile-image.png",
142+
"x-amz-algorithm": "AWS4-HMAC-SHA256",
143+
"x-amz-credential": "example/20240101/us-east-1/s3/aws4_request",
144+
"x-amz-date": "20240101T000000Z",
145+
"policy": "example-policy",
146+
"x-amz-signature": "example-signature"
147+
}
148+
}
149+
}
150+
```
151+
152+
</ResponsePanel>
153+
154+
</div>
155+
156+
</div>

0 commit comments

Comments
 (0)