-
Notifications
You must be signed in to change notification settings - Fork 5
docs: restructure API docs and update Work Item terminology #163
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| --- | ||
| title: Create a customer property | ||
| description: Creates a new customer property definition in a workspace. | ||
| api: POST /api/v1/workspaces/{workspace_slug}/customer-properties/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| ## Body parameters | ||
|
|
||
| <ParamField body="name" type="string"> | ||
| Name of the property. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="display_name" type="string"> | ||
| Display name of the property. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="description" type="string"> | ||
| Description of the property. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="property_type" type="string"> | ||
| Type of the property. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="relation_type" type="string"> | ||
| Relation type of the property. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="is_required" type="boolean"> | ||
| Whether the property is required. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="is_multi" type="boolean"> | ||
| Whether the property supports multiple values. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="is_active" type="boolean"> | ||
| Whether the property is active. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="sort_order" type="number"> | ||
| Sort order for the property. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="default_value" type="string[]"> | ||
| Default values for the property. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="settings" type="object"> | ||
| Settings for the property. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="validation_rules" type="object"> | ||
| Validation rules for the property. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="logo_props" type="object"> | ||
| Logo properties for the property. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="external_source" type="string"> | ||
| External source identifier. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="external_id" type="string"> | ||
| External ID from the external source. | ||
| </ParamField> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| --- | ||
| title: Create a customer request | ||
| description: Creates a new request for a customer. | ||
| api: POST /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="customer_id" type="string" required> | ||
| The unique identifier for the customer. | ||
| </ParamField> | ||
|
|
||
| ## Body parameters | ||
|
|
||
| <ParamField body="title" type="string"> | ||
| Title of the request. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="description" type="string"> | ||
| Description of the request. | ||
| </ParamField> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| title: Create a customer | ||
| description: Creates a new customer in a workspace. | ||
| api: POST /api/v1/workspaces/{workspace_slug}/customers/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| ## Body parameters | ||
|
|
||
| <ParamField body="name" type="string"> | ||
| Name of the customer. | ||
| </ParamField> | ||
|
|
||
| <ParamField body="email" type="string"> | ||
| Email address of the customer. | ||
| </ParamField> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| title: Delete a customer property | ||
| description: Permanently deletes a customer property definition from a workspace. This action cannot be undone. | ||
| api: DELETE /api/v1/workspaces/{workspace_slug}/customer-properties/{property_id}/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="property_id" type="string" required> | ||
| The unique identifier for the customer property. | ||
| </ParamField> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| title: Delete a customer request | ||
| description: Permanently deletes a customer request. This action cannot be undone. | ||
| api: DELETE /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/{request_id}/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="customer_id" type="string" required> | ||
| The unique identifier for the customer. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="request_id" type="string" required> | ||
| The unique identifier for the request. | ||
| </ParamField> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| title: Delete a customer | ||
| description: Permanently deletes a customer from a workspace. This action cannot be undone. | ||
| api: DELETE /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="customer_id" type="string" required> | ||
| The unique identifier for the customer. | ||
| </ParamField> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| title: Retrieve a customer | ||
| description: Retrieves the details of an existing customer by its ID. | ||
| api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="customer_id" type="string" required> | ||
| The unique identifier for the customer. | ||
| </ParamField> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| title: Retrieve a customer property | ||
| description: Retrieves the details of an existing customer property definition by its ID. | ||
| api: GET /api/v1/workspaces/{workspace_slug}/customer-properties/{property_id}/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="property_id" type="string" required> | ||
| The unique identifier for the customer property. | ||
| </ParamField> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| title: Retrieve a customer property value | ||
| description: Retrieves a specific property value for a customer by property ID. | ||
| api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/property-values/{property_id}/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="customer_id" type="string" required> | ||
| The unique identifier for the customer. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="property_id" type="string" required> | ||
| The unique identifier for the customer property. | ||
| </ParamField> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| title: Retrieve a customer request | ||
| description: Retrieves the details of an existing customer request by its ID. | ||
| api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/{request_id}/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="customer_id" type="string" required> | ||
| The unique identifier for the customer. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="request_id" type="string" required> | ||
| The unique identifier for the request. | ||
| </ParamField> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| title: Link work items to customer | ||
| description: Links one or more work items to a customer. | ||
| api: POST /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/work-items/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="customer_id" type="string" required> | ||
| The unique identifier for the customer. | ||
| </ParamField> | ||
|
|
||
| ## Body parameters | ||
|
|
||
| <ParamField body="issue_ids" type="string[]" required> | ||
| Array of work item IDs to link to the customer. | ||
| </ParamField> | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| --- | ||
| title: List all customer properties | ||
| description: Returns a list of all customer property definitions in a workspace. | ||
| api: GET /api/v1/workspaces/{workspace_slug}/customer-properties/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| ## Query parameters | ||
|
|
||
| <ParamField query="workspace" type="string"> | ||
| Filter by workspace ID. | ||
| </ParamField> | ||
|
|
||
| <ParamField query="limit" type="number"> | ||
| Number of results to return per page. | ||
| </ParamField> | ||
|
|
||
| <ParamField query="offset" type="number"> | ||
| Number of results to skip for pagination. | ||
| </ParamField> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| title: List all customer property values | ||
| description: Returns a list of all property values for a customer. | ||
| api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/property-values/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="customer_id" type="string" required> | ||
| The unique identifier for the customer. | ||
| </ParamField> | ||
|
|
||
| ## Query parameters | ||
|
|
||
| <ParamField query="customer" type="string"> | ||
| Filter by customer ID. | ||
| </ParamField> | ||
|
|
||
| <ParamField query="property" type="string"> | ||
| Filter by property ID. | ||
| </ParamField> | ||
|
|
||
| <ParamField query="workspace" type="string"> | ||
| Filter by workspace ID. | ||
| </ParamField> | ||
|
|
||
| <ParamField query="limit" type="number"> | ||
| Number of results to return per page. | ||
| </ParamField> | ||
|
|
||
| <ParamField query="offset" type="number"> | ||
| Number of results to skip for pagination. | ||
| </ParamField> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| --- | ||
| title: List all customer requests | ||
| description: Returns a list of all requests for a customer. | ||
| api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/requests/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="customer_id" type="string" required> | ||
| The unique identifier for the customer. | ||
| </ParamField> | ||
|
|
||
| ## Query parameters | ||
|
|
||
| <ParamField query="customer" type="string"> | ||
| Filter by customer ID. | ||
| </ParamField> | ||
|
|
||
| <ParamField query="workspace" type="string"> | ||
| Filter by workspace ID. | ||
| </ParamField> | ||
|
|
||
| <ParamField query="limit" type="number"> | ||
| Number of results to return per page. | ||
| </ParamField> | ||
|
|
||
| <ParamField query="offset" type="number"> | ||
| Number of results to skip for pagination. | ||
| </ParamField> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| title: List all customer work items | ||
| description: Returns a list of all work items associated with a customer. | ||
| api: GET /api/v1/workspaces/{workspace_slug}/customers/{customer_id}/work-items/ | ||
| --- | ||
|
|
||
| ## Path parameters | ||
|
|
||
| <ParamField path="workspace_slug" type="string" required> | ||
| 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`. | ||
| </ParamField> | ||
|
|
||
| <ParamField path="customer_id" type="string" required> | ||
| The unique identifier for the customer. | ||
| </ParamField> | ||
|
|
||
|
|
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Deprecated parameter name issue_ids in customer linking
The body parameter is named
issue_ids, which uses the old terminology. Given the PR's goal to replace "Issue" with "Work Item" terminology, this should be consistent with how similar endpoints name their parameters. However, the actual API endpoint may still useissue_ids, so this could be a documentation-only issue if the backend hasn't been updated. The parameter naming should be verified against the actual API implementation.