Created new pages for Intake issue

danciaclara · danciaclara · commit 83c1b5b444e8 · 2024-12-21T23:32:07.000+05:30
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}/intake-issues/
+api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-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}/intake-issues/{issue_id}
+api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-issues/{issue_id}
 ---
 
 ### Path parameters
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}/intake-issues/{issue_id}
+api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-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}/intake-issues/
+api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-issues/
 ---
 
 ### Path parameters
diff --git a/api-reference/inbox-issue/overview.mdx b/api-reference/inbox-issue/overview.mdx
@@ -17,16 +17,16 @@ To ensure uninterrupted service, replace all `/inbox-issues/` references with `/
 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/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/
+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/
 ```
 
 ```
 {
-	intake_view:true,
+	inbox_view:true,
 }
 ```
 
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}/intake-issues/{issue_id}
+api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/inbox-issues/{issue_id}
 ---
 
 ### Path parameters
diff --git a/api-reference/intake-issue/add-intake-issue.mdx b/api-reference/intake-issue/add-intake-issue.mdx
@@ -0,0 +1,17 @@
+---
+title: Add intake issue
+description: Adds an intake issue in a project
+api: POST /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/
+---
+
+### Path parameters
+
+<ParamField path="workspace-slug" type="string" required></ParamField>
+
+<ParamField path="project_id" type="string" required></ParamField>
+
+### Body
+
+<ParamField body="issue" type="object" required>
+  <ParamField body="name" type="string" required></ParamField>
+</ParamField>
diff --git a/api-reference/intake-issue/delete-intake-issue.mdx b/api-reference/intake-issue/delete-intake-issue.mdx
@@ -0,0 +1,15 @@
+---
+title: Delete intake issue
+description: Deletes an intake issue
+api: DELETE /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/{issue_id}
+---
+
+### Path parameters
+
+<ParamField path="workspace-slug" type="string" required></ParamField>
+
+<ParamField path="project_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/intake-issue/get-intake-issue-detail.mdx b/api-reference/intake-issue/get-intake-issue-detail.mdx
@@ -0,0 +1,13 @@
+---
+title: Get intake issue detail
+description: Gets the details of an intake issue
+api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/{issue_id}
+---
+
+### Path parameters
+
+<ParamField path="workspace-slug" type="string" required></ParamField>
+
+<ParamField path="project_id" type="string" required></ParamField>
+
+<ParamField path="issue_id" type="string" required></ParamField>
diff --git a/api-reference/intake-issue/list-intake-issues.mdx b/api-reference/intake-issue/list-intake-issues.mdx
@@ -0,0 +1,11 @@
+---
+title: List intake issues
+description: Gets all the intake issue of a project
+api: GET /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/
+---
+
+### Path parameters
+
+<ParamField path="workspace-slug" type="string" required></ParamField>
+
+<ParamField path="project_id" type="string" required></ParamField>
diff --git a/api-reference/intake-issue/overview.mdx b/api-reference/intake-issue/overview.mdx
@@ -0,0 +1,116 @@
+---
+title: Overview
+---
+
+<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/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/
+```
+
+```
+{
+	intake_view:true,
+}
+```
+
+To create an Intake issue, the payload should be sent in the below format
+
+```json
+{
+  "issue": {
+    "name": "Snoozed Issue 2",
+    "priority": "high"
+  }
+}
+```
+
+### Intake issue object
+
+**Attribute**
+
+- `created_at` _timestamp_
+
+  The timestamp of the time when the project was created
+
+- `updated_at` _timestamp_
+
+  The timestamp of the time when the project was last updated
+
+- `status`
+
+  the status of the issue can be in above mentioned status
+
+  - \-2 - Pending
+  - \-1 - Rejected
+  - 0 - Snoozed
+  - 1 - Accepted
+  - 2 - Duplicate
+
+- `snoozed_till`
+
+  The time untill the issue is snoozed.
+
+- `source`
+
+  The source describes the type intake issue from
+
+- `created_by` , `updated_by` _uuid_
+
+  These values are auto saved and represent the id of the user that created or updated the module
+
+- `Project` uuid
+
+  It contains projects uuid which is automatically saved.
+
+- `Workspace` uuid
+
+  It contains workspace uuid which is automatically saved.
+
+- `inbox`
+
+  intake id of the issue
+
+- `issue`
+
+  issue id of the issue
+
+- `duplicate_to`
+
+  Id of the issue of which the current issue is duplicate of.
+
+<ResponseExample>
+```json JSON
+{
+    "id": "0de4d6d1-fdc7-4849-8080-dc379ab210e3",
+    "pending_issue_count": 0,
+    "created_at": "2023-11-21T07:32:26.072634Z",
+    "updated_at": "2023-11-21T07:32:26.072648Z",
+    "name": "a dummy project with Intake",
+    "description": "",
+    "is_default": true,
+    "view_props": {},
+    "created_by": "0649cb9d-05c8-4ef4-8e8b-d108ccddd42c",
+    "updated_by": "0649cb9d-05c8-4ef4-8e8b-d108ccddd42c",
+    "project": "6436c4ae-fba7-45dc-ad4a-5440e17cb1b2",
+    "workspace": "c467e125-59e3-44ec-b5ee-f9c1e138c611"
+}
+
+```
+</ResponseExample>
diff --git a/api-reference/intake-issue/update-intake-issue-detail.mdx b/api-reference/intake-issue/update-intake-issue-detail.mdx
@@ -0,0 +1,19 @@
+---
+title: Update intake issue detail
+description: Updates the details of an intake issue
+api: PATCH /api/v1/workspaces/{workspace-slug}/projects/{project_id}/intake-issues/{issue_id}
+---
+
+### Path parameters
+
+<ParamField path="workspace-slug" type="string" required></ParamField>
+
+<ParamField path="project_id" type="string" required></ParamField>
+
+<ParamField path="issue_id" type="string" required></ParamField>
+
+### Body
+
+<ParamField body="issue" type="object">
+  <ParamField body="name" type="string"></ParamField>
+</ParamField>
diff --git a/mint.json b/mint.json
@@ -240,12 +240,12 @@
         {
           "group": "Intake issue",
           "pages": [
-            "api-reference/inbox-issue/overview",
-            "api-reference/inbox-issue/add-inbox-issue",
-            "api-reference/inbox-issue/list-inbox-issues",
-            "api-reference/inbox-issue/get-inbox-issue-detail",
-            "api-reference/inbox-issue/update-inbox-issue-detail",
-            "api-reference/inbox-issue/delete-inbox-issue"
+            "api-reference/intake-issue/overview",
+            "api-reference/intake-issue/add-intake-issue",
+            "api-reference/intake-issue/list-intake-issues",
+            "api-reference/intake-issue/get-intake-issue-detail",
+            "api-reference/intake-issue/update-intake-issue-detail",
+            "api-reference/intake-issue/delete-intake-issue"
           ]
         },
         {
