fix: remove task that the vendor does not support

instill-ai · Aug 11, 2024 · a74e5fc · a74e5fc
1 parent d43ce7f
commit a74e5fc
Show file tree

Hide file tree

Showing 3 changed files with 134 additions and 103 deletions.
diff --git a/application/jira/v0/README.mdx b/application/jira/v0/README.mdx
@@ -13,6 +13,10 @@ It can carry out the following tasks:
 - [List Sprints](#list-sprints)
 - [Get Issue](#get-issue)
 - [Get Sprint](#get-sprint)
+- [Create Issue](#create-issue)
+- [Update Issue](#update-issue)
+- [Create Sprint](#create-sprint)
+- [Update Sprint](#update-sprint)
 
 
 
@@ -183,4 +187,133 @@ Get a sprint in Jira
 
 
 
+### Create Issue
+
+Create an issue in Jira
+
+
+| Input | ID | Type | Description |
+| :--- | :--- | :--- | :--- |
+| Task ID (required) | `task` | string | `TASK_CREATE_ISSUE` |
+| Project Key (required) | `project-key` | string | The key of the project, e.g. `INS` |
+| Issue Type (required) | `issue-type` | object | The type of the issue, can be: `Task`, `Epic`, `Subtask`, etc. |
+| Summary | `summary` | string | The summary of the issue |
+| Description | `description` | string | The description of the issue |
+
+
+
+| Output | ID | Type | Description |
+| :--- | :--- | :--- | :--- |
+| ID | `id` | string | The ID of the issue |
+| Key | `key` | string | The key of the issue, e.g. `JRA-1330` |
+| Self | `self` | string | The URL of the issue |
+| Fields | `fields` | object | The fields of the issue. All navigable and Agile fields are returned |
+| Issue Type (optional) | `issue-type` | string | The type of the issue, can be: `Task`, `Epic` |
+| Summary (optional) | `summary` | string | The summary of the issue |
+| Description (optional) | `description` | string | The description of the issue |
+| Status (optional) | `status` | string | The status of the issue, can be: `To Do`, `In Progress`, `Done` |
+
+
+
+
+
+
+### Update Issue
+
+Update an issue in Jira
+
+
+| Input | ID | Type | Description |
+| :--- | :--- | :--- | :--- |
+| Task ID (required) | `task` | string | `TASK_UPDATE_ISSUE` |
+| Issue Key (required) | `issue-key` | string | The key of the issue, e.g. `JRA-1330` |
+| Notify Users | `notify-users` | boolean | Whether to notify users |
+| Update | `update` | object | Update an issue in Jira |
+
+
+
+| Output | ID | Type | Description |
+| :--- | :--- | :--- | :--- |
+| ID | `id` | string | The ID of the issue |
+| Key | `key` | string | The key of the issue, e.g. `JRA-1330` |
+| Self | `self` | string | The URL of the issue |
+| Fields | `fields` | object | The fields of the issue. All navigable and Agile fields are returned |
+| Issue Type (optional) | `issue-type` | string | The type of the issue, can be: `Task`, `Epic` |
+| Summary (optional) | `summary` | string | The summary of the issue |
+| Description (optional) | `description` | string | The description of the issue |
+| Status (optional) | `status` | string | The status of the issue, can be: `To Do`, `In Progress`, `Done` |
+
+
+
+
+
+
+### Create Sprint
+
+Create a sprint in Jira
+
+
+| Input | ID | Type | Description |
+| :--- | :--- | :--- | :--- |
+| Task ID (required) | `task` | string | `TASK_CREATE_SPRINT` |
+| Board Name (required) | `board-name` | string | The name of the board |
+| Name (required) | `name` | string | The name of the sprint |
+| Goal (required) | `goal` | string | The goal of the sprint |
+| Start Date (required) | `start-date` | string | The start date of the sprint. In the RFC3339 format, e.g. 2018-03-05T00:00:00Z |
+| End Date (required) | `end-date` | string | The end date of the sprint. In the RFC3339 format, e.g. 2018-03-05T00:00:00Z |
+
+
+
+| Output | ID | Type | Description |
+| :--- | :--- | :--- | :--- |
+| ID | `id` | integer | The ID of the sprint |
+| Self | `self` | string | The URL of the sprint |
+| State (optional) | `state` | string | The state of the sprint, can be: `active`, `closed`, `future` |
+| Name (optional) | `name` | string | The name of the sprint |
+| Start Date (optional) | `start-date` | string | The start date of the sprint. In the RFC3339 format, e.g. 2018-03-05T00:00:00Z |
+| End Date (optional) | `end-date` | string | The end date of the sprint. In the RFC3339 format, e.g. 2018-03-05T00:00:00Z |
+| Complete Date (optional) | `complete-date` | string | The complete date of the sprint. In the RFC3339 format, e.g. 2018-03-05T00:00:00Z |
+| Origin Board ID (optional) | `origin-board-id` | integer | The ID of the origin board |
+| Goal (optional) | `goal` | string | The Goal of the sprint |
+
+
+
+
+
+
+### Update Sprint
+
+Update a sprint in Jira
+
+
+| Input | ID | Type | Description |
+| :--- | :--- | :--- | :--- |
+| Task ID (required) | `task` | string | `TASK_UPDATE_SPRINT` |
+| Sprint ID (required) | `sprint-id` | integer | The ID of the sprint |
+| Name (required) | `name` | string | The name of the sprint |
+| Goal | `goal` | string | The goal of the sprint |
+| Start Date (required) | `start-date` | string | The start date of the sprint. In the RFC3339 format, e.g. 2018-03-05T00:00:00Z |
+| End Date (required) | `end-date` | string | The end date of the sprint. In the RFC3339 format, e.g. 2018-03-05T00:00:00Z |
+| Current State (required) | `current-state` | string | The current state of the sprint, can be: `future`, `active`, `closed` |
+| Enter Next State | `enter-next-state` | boolean | Whether to enter the next state. If `true`, the sprint will enter the next state, i.e., `future` -> `active` -> `closed` |
+
+
+
+| Output | ID | Type | Description |
+| :--- | :--- | :--- | :--- |
+| ID | `id` | integer | The ID of the sprint |
+| Self | `self` | string | The URL of the sprint |
+| State (optional) | `state` | string | The state of the sprint, can be: `active`, `closed`, `future` |
+| Name (optional) | `name` | string | The name of the sprint |
+| Start Date (optional) | `start-date` | string | The start date of the sprint. In the RFC3339 format, e.g. 2018-03-05T00:00:00Z |
+| End Date (optional) | `end-date` | string | The end date of the sprint. In the RFC3339 format, e.g. 2018-03-05T00:00:00Z |
+| Complete Date (optional) | `complete-date` | string | The complete date of the sprint. In the RFC3339 format, e.g. 2018-03-05T00:00:00Z |
+| Origin Board ID (optional) | `origin-board-id` | integer | The ID of the origin board |
+| Goal (optional) | `goal` | string | The Goal of the sprint |
+
+
+
+
+
+
 
diff --git a/application/jira/v0/config/definition.json b/application/jira/v0/config/definition.json
@@ -8,8 +8,7 @@
     "TASK_CREATE_ISSUE",
     "TASK_UPDATE_ISSUE",
     "TASK_CREATE_SPRINT",
-    "TASK_UPDATE_SPRINT",
-    "TASK_RANK_EPIC"
+    "TASK_UPDATE_SPRINT"
   ],
   "documentationUrl": "https://www.instill.tech/docs/component/application/jira",
   "icon": "assets/jira.svg",

diff --git a/application/jira/v0/config/tasks.json b/application/jira/v0/config/tasks.json
@@ -1425,106 +1425,5 @@
       "title": "Output",
       "type": "object"
     }
-  },
-  "TASK_RANK_EPIC": {
-    "description": "Rank an epic in Jira",
-    "instillShortDescription": "Rank an epic in Jira",
-    "input": {
-      "description": "Rank an epic in Jira",
-      "instillUIOrder": 0,
-      "instillEditOnNodeFields": [
-        "epic-key",
-        "rank"
-      ],
-      "properties": {
-        "epic-key": {
-          "title": "Epic Key",
-          "description": "The key of the epic, e.g. `JRA-1330`",
-          "instillShortDescription": "The key of the epic",
-          "instillUIOrder": 0,
-          "instillFormat": "string",
-          "instillAcceptFormats": [
-            "string"
-          ],
-          "instillUpstreamTypes": [
-            "value",
-            "reference",
-            "template"
-          ],
-          "type": "string"
-        },
-        "after": {
-          "title": "Rank After Epic",
-          "description": "The key of the epic to rank after",
-          "instillShortDescription": "The key of the epic to rank after",
-          "instillUIOrder": 1,
-          "instillFormat": "string",
-          "instillAcceptFormats": [
-            "string"
-          ],
-          "instillUpstreamTypes": [
-            "value",
-            "reference",
-            "template"
-          ],
-          "type": "string"
-        },
-        "before": {
-          "title": "Rank Before Epic",
-          "description": "The key of the epic to rank before",
-          "instillShortDescription": "The key of the epic to rank before",
-          "instillUIOrder": 2,
-          "instillFormat": "string",
-          "instillAcceptFormats": [
-            "string"
-          ],
-          "instillUpstreamTypes": [
-            "value",
-            "reference",
-            "template"
-          ],
-          "type": "string"
-        },
-        "rank": {
-          "title": "Rank",
-          "description": "The custom rank field ID of the epic",
-          "instillShortDescription": "The custom rank field ID of the epic",
-          "instillUIOrder": 3,
-          "instillFormat": "integer",
-          "instillAcceptFormats": [
-            "integer"
-          ],
-          "instillUpstreamTypes": [
-            "value",
-            "reference"
-          ],
-          "type": "integer"
-        }
-      },
-      "required": [
-        "epic-key",
-        "rank"
-      ],
-      "title": "Input",
-      "type": "object"
-    },
-    "output": {
-      "description": "Rank an epic in Jira",
-      "instillUIOrder": 0,
-      "properties": {
-        "success": {
-          "description": "Whether the epic is ranked",
-          "instillUIOrder": 0,
-          "title": "Success",
-          "instillFormat": "boolean",
-          "type": "boolean"
-        }
-      },
-      "required": [
-        "success"
-      ],
-      "title": "Output",
-      "type": "object"
-    }
   }
 }