Merge pull request #129 from qase-tms/testcase_integration_filter

add an integration filter to the cases list
qase-tms · Oct 18, 2023 · 85af0a7 · 85af0a7
2 parents 176dbea + 784d767
commit 85af0a7
Show file tree

Hide file tree

Showing 4 changed files with 97 additions and 0 deletions.
diff --git a/api.yaml b/api.yaml
@@ -294,6 +294,38 @@ paths:
             A list of values separated by comma. Possible values: actual, draft deprecated
           schema:
             type: string
+        - in: query
+          name: 'external_issues[type]'
+          description: |
+            An integration type.
+          schema:
+            type: string
+            enum:
+              - asana
+              - azure-devops
+              - clickup-app
+              - github-app
+              - gitlab-app
+              - jira-cloud
+              - jira-server
+              - linear
+              - monday
+              - redmine-app
+              - trello-app
+              - youtrack-app
+        - in: query
+          name: 'external_issues[ids]'
+          description: A list of issue IDs.
+          schema:
+            type: array
+            items:
+              type: string
+        - in: query
+          name: include
+          description: |
+            A list of entities to include in response separated by comma. Possible values: external_issues.
+          schema:
+            type: string
         - $ref: '#/components/parameters/Code'
         - $ref: '#/components/parameters/Limit'
         - $ref: '#/components/parameters/Offset'
@@ -3728,6 +3760,22 @@ components:
           description: 'Deprecated, use the `updated_at` property instead.'
           type: string
           example: '2021-12-30T19:23:59.000000Z'
+        external_issues:
+          type: array
+          items:
+            type: object
+            properties:
+              type:
+                type: string
+              issues:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    id:
+                      type: string
+                    link:
+                      type: string
     TestCaseCreate:
       type: object
       properties:

diff --git a/paths/cases.yaml b/paths/cases.yaml
@@ -64,6 +64,38 @@ get:
         A list of values separated by comma. Possible values: actual, draft deprecated
       schema:
         type: string
+    - in: query
+      name: external_issues[type]
+      description: | 
+        An integration type.
+      schema:
+        type: string
+        enum:
+          - asana
+          - azure-devops
+          - clickup-app
+          - github-app
+          - gitlab-app
+          - jira-cloud
+          - jira-server
+          - linear
+          - monday
+          - redmine-app
+          - trello-app
+          - youtrack-app
+    - in: query
+      name: external_issues[ids]
+      description: A list of issue IDs.
+      schema:
+          type: array
+          items:
+            type: string
+    - in: query
+      name: include
+      description: |
+          A list of entities to include in response separated by comma. Possible values: external_issues.
+      schema:
+          type: string
     - $ref: '../parameters/Code.yaml'
     - $ref: '../parameters/pagination/Limit.yaml'
     - $ref: '../parameters/pagination/Offset.yaml'

diff --git a/schemas/ExternalIssue.yaml b/schemas/ExternalIssue.yaml
@@ -0,0 +1,13 @@
+type: object
+properties:
+  type:
+    type: string
+  issues:
+    type: array
+    items:
+      type: object
+      properties:
+        id:
+          type: string
+        link:
+          type: string
diff --git a/schemas/TestCase.yaml b/schemas/TestCase.yaml
@@ -95,3 +95,7 @@ properties:
     description: Deprecated, use the `updated_at` property instead.
     type: string
     example: "2021-12-30T19:23:59.000000Z"
+  external_issues:
+    type: array
+    items:
+      $ref: './ExternalIssue.yaml'