feat(specs): add sourceID query param to task list endpoint (#1250)

Co-authored-by: Pierre Millot <[email protected]>

Author: Fluf22

specs/ingestion/common/authenticationParameters.yml

@@ -8,8 +8,8 @@ type:
   schema:
     type: array
     items:
-      $ref: '#/authenticationTypeWithNone'
-    example: basic,oauth,none
+      $ref: './schemas/authentication.yml#/AuthenticationType'
+    example: basic,oauth
 
 platform:
   name: platform
@@ -21,10 +21,10 @@ platform:
   schema:
     type: array
     items:
-      $ref: './schemas/authentication.yml#/Platform'
-    example: commercetools,bigcommerce
+      $ref: '#/platformWithNone'
+    example: commercetools,none
 
-authenticationTypeWithNone:
+platformWithNone:
   oneOf:
-    - $ref: './schemas/authentication.yml#/AuthenticationType'
-    - $ref: './schemas/authentication.yml#/AuthenticationNone'
+    - $ref: './schemas/authentication.yml#/Platform'
+    - $ref: './schemas/authentication.yml#/PlatformNone'

specs/ingestion/common/schemas/authentication.yml

@@ -97,14 +97,14 @@ AuthenticationType:
   type: string
   enum: ['googleServiceAccount', 'basic', 'apiKey', 'oauth', 'algolia']
 
-AuthenticationNone:
-  type: string
-  enum: ['none']
-
 Platform:
   type: string
   enum: ['bigcommerce', 'commercetools']
 
+PlatformNone:
+  type: string
+  enum: ['none']
+
 AuthGoogleServiceAccount:
   type: object
   additionalProperties: false

specs/ingestion/common/sourceParameters.yml

@@ -14,11 +14,14 @@ type:
 authenticationID:
   name: authenticationID
   in: query
-  description: Which authenticationID the returned source should have. Can be a list of string separated with commas.
+  description: >-
+    Which authenticationID the returned source should have. Can be a list of string separated with commas.
+    Also supports 'none' as a value to return sources that don't have any authentication.
   required: false
   style: form
   explode: false
   schema:
     type: array
     items:
       type: string
+    example: 10000000-0a75-4000-a000-000000000001,none

specs/ingestion/common/taskParameters.yml

@@ -19,6 +19,18 @@ action:
       $ref: './schemas/task.yml#/ActionType'
     example: save,replace
 
+sourceID:
+  name: sourceID
+  in: query
+  description: Which sourceID the returned task should have. Can be a list of string separated with commas.
+  required: false
+  style: form
+  explode: false
+  schema:
+    type: array
+    items:
+      type: string
+
 destinationID:
   name: destinationID
   in: query

specs/ingestion/paths/tasks/tasks.yml

@@ -9,6 +9,7 @@ get:
     - $ref: '../../common/parameters.yml#/page'
     - $ref: '../../common/taskParameters.yml#/action'
     - $ref: '../../common/taskParameters.yml#/enabled'
+    - $ref: '../../common/taskParameters.yml#/sourceID'
     - $ref: '../../common/taskParameters.yml#/destinationID'
     - $ref: '../../common/taskParameters.yml#/triggerType'
   responses: