Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/api-reference/assets/create-workspace-asset-upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, assets, create workspace

<div class="api-endpoint-badge">
<span class="method post">POST</span>
<span class="path">/api/v1/workspaces/{slug}/assets/</span>
<span class="path">/api/v1/workspaces/{workspace_slug}/assets/</span>
</div>

<div class="api-two-column">
Expand All @@ -22,9 +22,9 @@ Generate presigned URL for generic asset upload

<div class="params-list">

<ApiParam name="slug" type="string" :required="true">
<ApiParam name="workspace_slug" type="string" :required="true">

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`.

</ApiParam>

Expand Down
8 changes: 4 additions & 4 deletions docs/api-reference/assets/delete-user-asset.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,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"
```

</template>
Expand All @@ -63,7 +63,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)
Expand All @@ -73,7 +73,7 @@ print(response.status_code)
<template #javascript>

```javascript
const response = await fetch("https://api.plane.so/api/v1/assets/user-assets/550e8400-e29b-41d4-a716-446655440002/", {
const response = await fetch("https://api.plane.so/api/v1/assets/user-assets/asset-uuid/", {
method: "DELETE",
headers: {
"X-API-Key": "your-api-key",
Expand Down
29 changes: 13 additions & 16 deletions docs/api-reference/assets/get-workspace-asset.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, assets, get workspace ass

<div class="api-endpoint-badge">
<span class="method get">GET</span>
<span class="path">/api/v1/workspaces/{slug}/assets/{asset_id}/</span>
<span class="path">/api/v1/workspaces/{workspace_slug}/assets/{asset_id}/</span>
</div>

<div class="api-two-column">
Expand All @@ -24,13 +24,13 @@ Get presigned URL for asset download

<ApiParam name="asset_id" type="string" :required="true">

Asset id.
The unique identifier of the asset.

</ApiParam>

<ApiParam name="slug" type="string" :required="true">
<ApiParam name="workspace_slug" type="string" :required="true">

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`.

</ApiParam>

Expand All @@ -54,9 +54,9 @@ Workspace slug

```bash
curl -X 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/" \
-H "X-API-Key: $PLANE_API_KEY" \
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN"
```

</template>
Expand All @@ -66,7 +66,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())
Expand All @@ -76,15 +76,12 @@ print(response.json())
<template #javascript>

```javascript
const response = await fetch(
"https://api.plane.so/api/v1/workspaces/my-workspace/assets/550e8400-e29b-41d4-a716-446655440002/",
{
method: "GET",
headers: {
"X-API-Key": "your-api-key",
},
}
);
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/assets/asset-uuid/", {
method: "GET",
headers: {
"X-API-Key": "your-api-key",
},
});
const data = await response.json();
```

Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/assets/update-user-asset.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Additional attributes to update for the asset

```bash
curl -X PATCH \
"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" \
-H "Content-Type: application/json" \
Expand All @@ -84,7 +84,7 @@ curl -X PATCH \
import requests

response = requests.patch(
"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"},
json={
"attributes": {
Expand All @@ -102,7 +102,7 @@ print(response.status_code)
<template #javascript>

```javascript
const response = await fetch("https://api.plane.so/api/v1/assets/user-assets/550e8400-e29b-41d4-a716-446655440002/", {
const response = await fetch("https://api.plane.so/api/v1/assets/user-assets/asset-uuid/", {
method: "PATCH",
headers: {
"X-API-Key": "your-api-key",
Expand Down
35 changes: 16 additions & 19 deletions docs/api-reference/assets/update-workspace-asset.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, assets, update workspace

<div class="api-endpoint-badge">
<span class="method patch">PATCH</span>
<span class="path">/api/v1/workspaces/{slug}/assets/{asset_id}/</span>
<span class="path">/api/v1/workspaces/{workspace_slug}/assets/{asset_id}/</span>
</div>

<div class="api-two-column">
Expand All @@ -24,13 +24,13 @@ Update generic asset after upload completion

<ApiParam name="asset_id" type="string" :required="true">

Asset ID
The unique identifier of the asset.

</ApiParam>

<ApiParam name="slug" type="string" :required="true">
<ApiParam name="workspace_slug" type="string" :required="true">

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`.

</ApiParam>

Expand Down Expand Up @@ -69,7 +69,7 @@ Whether the asset has been successfully uploaded

```bash
curl -X PATCH \
"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/" \
-H "X-API-Key: $PLANE_API_KEY" \
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
-H "Content-Type: application/json" \
Expand All @@ -85,7 +85,7 @@ curl -X PATCH \
import requests

response = requests.patch(
"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"},
json={
"is_uploaded": true
Expand All @@ -98,19 +98,16 @@ print(response.status_code)
<template #javascript>

```javascript
const response = await fetch(
"https://api.plane.so/api/v1/workspaces/my-workspace/assets/550e8400-e29b-41d4-a716-446655440002/",
{
method: "PATCH",
headers: {
"X-API-Key": "your-api-key",
"Content-Type": "application/json",
},
body: JSON.stringify({
is_uploaded: true,
}),
}
);
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/assets/asset-uuid/", {
method: "PATCH",
headers: {
"X-API-Key": "your-api-key",
"Content-Type": "application/json",
},
body: JSON.stringify({
is_uploaded: true,
}),
});
console.log(response.status);
```

Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/customer/add-customer-property.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, customer, create a custom

<div class="api-endpoint-badge">
<span class="method post">POST</span>
<span class="path">/api/v1/workspaces/{slug}/customer-properties/</span>
<span class="path">/api/v1/workspaces/{workspace_slug}/customer-properties/</span>
</div>

<div class="api-two-column">
Expand All @@ -22,9 +22,9 @@ Create a new customer property in the specified workspace.

<div class="params-list">

<ApiParam name="slug" type="string" :required="true">
<ApiParam name="workspace_slug" type="string" :required="true">

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`.

</ApiParam>

Expand Down
43 changes: 20 additions & 23 deletions docs/api-reference/customer/add-customer-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, customer, create a custom

<div class="api-endpoint-badge">
<span class="method post">POST</span>
<span class="path">/api/v1/workspaces/{slug}/customers/{customer_id}/requests/</span>
<span class="path">/api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/</span>
</div>

<div class="api-two-column">
Expand All @@ -24,13 +24,13 @@ Create a new request for the specified customer.

<ApiParam name="customer_id" type="string" :required="true">

Customer id.
The unique identifier of the customer.

</ApiParam>

<ApiParam name="slug" type="string" :required="true">
<ApiParam name="workspace_slug" type="string" :required="true">

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`.

</ApiParam>

Expand Down Expand Up @@ -93,7 +93,7 @@ Work item ids.

```bash
curl -X POST \
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/requests/" \
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/requests/" \
-H "X-API-Key: $PLANE_API_KEY" \
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
-H "Content-Type: application/json" \
Expand All @@ -115,7 +115,7 @@ curl -X POST \
import requests

response = requests.post(
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/requests/",
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/requests/",
headers={"X-API-Key": "your-api-key"},
json={
"name": "Example Name",
Expand All @@ -134,23 +134,20 @@ print(response.json())
<template #javascript>

```javascript
const response = await fetch(
"https://api.plane.so/api/v1/workspaces/my-workspace/customers/550e8400-e29b-41d4-a716-446655440001/requests/",
{
method: "POST",
headers: {
"X-API-Key": "your-api-key",
"Content-Type": "application/json",
},
body: JSON.stringify({
name: "Example Name",
description: "example-value",
description_html: "<p>Example content</p>",
link: "https://example.com/resource",
work_item_ids: ["550e8400-e29b-41d4-a716-446655440000"],
}),
}
);
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/customers/customer-uuid/requests/", {
method: "POST",
headers: {
"X-API-Key": "your-api-key",
"Content-Type": "application/json",
},
body: JSON.stringify({
name: "Example Name",
description: "example-value",
description_html: "<p>Example content</p>",
link: "https://example.com/resource",
work_item_ids: ["550e8400-e29b-41d4-a716-446655440000"],
}),
});
const data = await response.json();
```

Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/customer/add-customer.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ keywords: plane, plane api, rest api, api integration, customer, create a custom

<div class="api-endpoint-badge">
<span class="method post">POST</span>
<span class="path">/api/v1/workspaces/{slug}/customers/</span>
<span class="path">/api/v1/workspaces/{workspace_slug}/customers/</span>
</div>

<div class="api-two-column">
Expand All @@ -22,9 +22,9 @@ Create a new customer in the specified workspace.

<div class="params-list">

<ApiParam name="slug" type="string" :required="true">
<ApiParam name="workspace_slug" type="string" :required="true">

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`.

</ApiParam>

Expand Down
Loading
Loading