Merge pull request #49 from makeplane/api-fixes

danciaclara · web-flow · commit f42052718c3b · 2024-12-21T23:13:44.000+05:30
Added troubleshooting docs and other API fixes
diff --git a/api-reference/inbox-issue/add-inbox-issue.mdx b/api-reference/inbox-issue/add-inbox-issue.mdx
@@ -1,7 +1,7 @@
 ---
 title: Add intake issue
 description: Adds an intake issue in a project
-api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-issues/
+api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/
 ---
 
 ### Path parameters
diff --git a/api-reference/inbox-issue/delete-inbox-issue.mdx b/api-reference/inbox-issue/delete-inbox-issue.mdx
@@ -1,7 +1,7 @@
 ---
 title: Delete intake issue
 description: Deletes an intake issue
-api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-issues/{issue_id}
+api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/{issue_id}
 ---
 
 ### Path parameters
@@ -10,6 +10,6 @@ api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-issu
 
 <ParamField path="project_id" type="string" required></ParamField>
 
-<ParamField path="inbox_id" type="string" required></ParamField>
+<ParamField path="intake_id" type="string" required></ParamField>
 
 <ParamField path="issue_id" type="string" required></ParamField>
diff --git a/api-reference/inbox-issue/get-inbox-issue-detail.mdx b/api-reference/inbox-issue/get-inbox-issue-detail.mdx
@@ -1,7 +1,7 @@
 ---
 title: Get intake issue detail
 description: Gets the details of an intake issue
-api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-issues/{issue_id}
+api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/{issue_id}
 ---
 
 ### Path parameters
diff --git a/api-reference/inbox-issue/list-inbox-issues.mdx b/api-reference/inbox-issue/list-inbox-issues.mdx
@@ -1,7 +1,7 @@
 ---
 title: List intake issues
 description: Gets all the intake issue of a project
-api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-issues/
+api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/
 ---
 
 ### Path parameters
diff --git a/api-reference/inbox-issue/overview.mdx b/api-reference/inbox-issue/overview.mdx
@@ -2,23 +2,35 @@
 title: Overview
 ---
 
-To enable the intake feature, the user can hit a PATCH request on the project api with the body as
+<Warning>
+**Deprecation notice**
+
+We are deprecating all `/api/v1/.../inbox-issues/` endpoints in favor of `/api/v1/.../intake-issues/`.
+
+**End of support**  
+28th February 2025
+
+**What you need to do**  
+To ensure uninterrupted service, replace all `/inbox-issues/` references with `/intake-issues/` in your codebase before the support end date.
+</Warning>
+
+To enable the Intake feature, the user can hit a PATCH request on the project api with the body as
 
 ```http
-GET    /api/v1/workspaces/:workspace-slug/projects/:project_id/inbox-issues/
-POST   /api/v1/workspaces/:workspace-slug/projects/:project_id/inbox-issues/
-GET    /api/v1/workspaces/:workspace-slug/projects/:project_id/inbox-issues/:issue_id/
-PATCH  /api/v1/workspaces/:workspace-slug/projects/:project_id/inbox-issues/:issue_id/
-DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/inbox-issues/:issue_id/
+GET    /api/v1/workspaces/:workspace-slug/projects/:project_id/intake-issues/
+POST   /api/v1/workspaces/:workspace-slug/projects/:project_id/intake-issues/
+GET    /api/v1/workspaces/:workspace-slug/projects/:project_id/intake-issues/:issue_id/
+PATCH  /api/v1/workspaces/:workspace-slug/projects/:project_id/intake-issues/:issue_id/
+DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/intake-issues/:issue_id/
 ```
 
 ```
 {
-	inbox_view:true,
+	intake_view:true,
 }
 ```
 
-To create an intake issue, the payload should be sent in the below format
+To create an Intake issue, the payload should be sent in the below format
 
 ```json
 {
@@ -29,7 +41,7 @@ To create an intake issue, the payload should be sent in the below format
 }
 ```
 
-### Intake Issue Object
+### Intake issue object
 
 **Attribute**
 
@@ -90,7 +102,7 @@ To create an intake issue, the payload should be sent in the below format
     "pending_issue_count": 0,
     "created_at": "2023-11-21T07:32:26.072634Z",
     "updated_at": "2023-11-21T07:32:26.072648Z",
-    "name": "a dummy project hvh Inbox",
+    "name": "a dummy project with Intake",
     "description": "",
     "is_default": true,
     "view_props": {},
diff --git a/api-reference/inbox-issue/update-inbox-issue-detail.mdx b/api-reference/inbox-issue/update-inbox-issue-detail.mdx
@@ -1,7 +1,7 @@
 ---
 title: Update intake issue detail
 description: Updates the details of an intake issue
-api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-issues/{issue_id}
+api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/{issue_id}
 ---
 
 ### Path parameters
diff --git a/api-reference/issue/get-issue-detail.mdx b/api-reference/issue/get-issue-detail.mdx
@@ -1,6 +1,6 @@
 ---
-title: Get issue details
-description: Gets the details of an issue
+title: Get issue by UUID
+description: Gets the details of an issue using the UUID
 api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/issues/{issue_id}
 ---
 
diff --git a/api-reference/issue/get-issue-sequence-id.mdx b/api-reference/issue/get-issue-sequence-id.mdx
@@ -0,0 +1,11 @@
+---
+title: Get issue by sequence ID 
+description: Gets the details of an issue using the sequence id
+api: GET /api/v1/workspaces/{workspace-slug}/issues/{sequence_id}/
+---
+
+### Path parameters
+
+<ParamField path="workspace-slug" type="string" required></ParamField>
+
+<ParamField path="sequence_id" type="string" required></ParamField>
diff --git a/api-reference/project/overview.mdx b/api-reference/project/overview.mdx
@@ -13,6 +13,13 @@ PATCH  /api/v1/workspaces/:workspace-slug/projects/:project_id/
 DELETE /api/v1/workspaces/:workspace-slug/projects/:project_id/
 ```
 
+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`.
+
 ### Project Object
 
 **Attributes**
diff --git a/mint.json b/mint.json
@@ -111,6 +111,13 @@
         
       ]
     },
+    {
+      "group": "Troubleshoot",
+      "pages": [
+        "self-hosting/troubleshoot/license-errors",
+        "self-hosting/troubleshoot/cli-errors"
+      ]
+    },
     {
       "group": "API Reference",
       "pages": [
@@ -166,6 +173,7 @@
             "api-reference/issue/add-issue",
             "api-reference/issue/list-issues",
             "api-reference/issue/get-issue-detail",
+            "api-reference/issue/get-issue-sequence-id",
             "api-reference/issue/update-issue-detail",
             "api-reference/issue/delete-issue"
           ]
diff --git a/self-hosting/manage/backup-restore.mdx b/self-hosting/manage/backup-restore.mdx
@@ -17,6 +17,14 @@ This command initiates a full backup of all critical data, storing it in the def
 ```
 Each backup file will be timestamped to ensure you can easily identify the latest or a specific backup if needed.
 
+### Backup plane.env
+If you need to back up only the `plane.env` file, you'll need to do it manually. Here’s how:
+
+1. Navigate to the `/opt/plane` folder on your machine or server where Plane is installed..
+2. Locate the `plane.env` file.
+3. Copy this file to a different location as a backup, so you can restore it if needed.
+
+
 ## Restore data
 
 You can restore your data from a previous backup with ↓:
@@ -59,7 +67,15 @@ Backing Up plane-app_uploads
 Backup completed successfully. Backup files are stored in /....../plane-app/backup/20240502-1120
 ```
 The backup files are stored locally, so you can copy them to an external storage service if needed for extra security.
-**** 
+
+### Backup plane.env
+If you need to back up only the `plane.env` file, you'll need to do it manually. Here’s how:
+
+1. Navigate to the folder on your machine or server where Plane is installed..
+2. Locate the `plane.env` file.
+3. Copy this file to a different location as a backup, so you can restore it if needed.
+
+***
 
 ## Restore data
 Follow these steps to restore data from a backup:
diff --git a/self-hosting/methods/kubernetes.mdx b/self-hosting/methods/kubernetes.mdx
@@ -20,7 +20,7 @@ Plane One and Plane Pro are enabled on this edition, so the Free plan on this ed
     1. Open terminal or any other command-line app that has access to Kubernetes tools on your local system.
     2. Set the following environment variables:
         ```bash
-        PLANE_VERSION=v1.3.2
+        PLANE_VERSION=v1.6.0
         ```
         ```bash
         DOMAIN_NAME=<subdomain.domain.tld or domain.tld>
@@ -73,7 +73,7 @@ Plane One and Plane Pro are enabled on this edition, so the Free plan on this ed
             ```
 
             Make sure you set the required environment variables listed below:
-            - `planeVersion: v1.3.2`
+            - `planeVersion: v1.6.0`
             - `license.licenseDomain: <The domain you have specified to host Plane>`
             - `license.licenseServer: https://prime.plane.so`
             - `ingress.enabled: <true | false>`
@@ -103,7 +103,7 @@ If you want to upgrade to a paid plan, see [Plan upgrades](https://docs.plane.so
 
     | Setting | Default | Required | Description |
     |---|:---:|:---:|---|
-    | planeVersion | v1.3.2	 | Yes |  Specifies the version of Plane to be deployed. Copy this from `prime.plane.so.` |
+    | planeVersion | v1.6.0	 | Yes |  Specifies the version of Plane to be deployed. Copy this from `prime.plane.so.` |
     | license.licenseServer | `https://prime.plane.so` | Yes | Sets the value of the `licenseServer` that gets you your license and validates it periodically. Don't change this. |
     | license.licenseDomain | 'plane.example.com' | Yes | The fully-qualified domain name (FQDN) in the format `sudomain.domain.tld` or `domain.tld` that the license is bound to. It is also attached to your `ingress` host to access Plane. |
 
diff --git a/self-hosting/troubleshoot/cli-errors.mdx b/self-hosting/troubleshoot/cli-errors.mdx
@@ -0,0 +1,23 @@
+---
+title: CLI errors
+---
+
+This page helps you troubleshoot common issues you might run into when using the Plane CLI tools. It covers potential causes of errors and provides straightforward steps to resolve them.
+
+## Failed to update Prime CLI
+
+<div style={{color:"red"}}> 
+    Error: Failed to update Prime CLI, please contact support or try again later.
+</div>
+
+This error typically happens if you're using an older version of the Prime CLI. To fix it, follow these steps:
+
+1. Start by taking a [data backup](/self-hosting/manage/backup-restore#backup-data) to be safe.
+2. Run this command to remove the existing CLI:
+    ```bash
+    rm -rf /usr/bin/prime-cli
+    ```
+3. Install the latest version of the CLI with:
+    ```bash
+    curl -fsSL https://prime.plane.so/install/ | sh
+    ```
diff --git a/self-hosting/troubleshoot/license-errors.mdx b/self-hosting/troubleshoot/license-errors.mdx
@@ -0,0 +1,49 @@
+---
+title: License errors
+---
+
+This guide is designed to help you resolve common issues encountered while activating the license key for a workspace. Each section includes potential causes and step-by-step solutions for identified problems.
+
+## License is invalid
+
+<div style={{color:"red"}}> 
+    Error: Your license is invalid or already in use. 
+</div>
+
+
+- This issue usually occurs when your server has trouble connecting to ours to verify the license. Try running `prime-cli restart`, and it should resolve the problem.
+
+- If you migrated Plane to a new server without first [delinking the license key](https://docs.plane.so/workspaces-and-users/upgrade-plan#delink-license-key) from the old server, this error might happen. In that case, please reach out to the support team to have the license key delinked. For future reference, if you need to reinstall Plane or move to another server, follow [this guide](/self-hosting/manage/migrate-plane) to ensure a smooth transition.
+
+## Something went wrong
+
+<div style={{color:"red"}}> 
+    Error: Something went wrong please try again later 
+</div>
+
+This error usually occurs when the license validation service is unavailable. Here's how you can troubleshoot it:
+
+1. Confirm that your Plane instance is running the latest version.
+2. If it's not up-to-date, [update to the latest version](/self-hosting/manage/upgrade-plane#prerequisites).
+
+Updating typically resolves this issue. If the problem persists, double-check your network connection and any firewall rules that might block access to the license validation service.
+
+## Payment server is not configured
+
+<div style={{color:"red"}}> 
+    Error: Payment server is not configured
+</div>
+
+This usually occurs when the environment confiuration is incorrect. The  Env variable `payment_server_url` is missing in the setup. In this case, follow the below steps.
+
+1. Backup the `plane.env` file.
+    1. Navigate to the `/opt/plane` folder on your machine or server where Plane is installed..
+    2. Locate the `plane.env` file.
+    3. Copy this file to a different location as a backup, so you can restore it if needed.
+2. Run `prime-cli repair` to allow Prime CLI to attempt automatic fixes to the `plane.env` file.
+3. Try activating your workspace with the license key.
+3. If needed, you can configure the instance in [God mode](/self-hosting/govern/instance-admin#settings) or adjust the environment variables directly in the new plane.env file.
+
+
+
+
