feat(tasks): put task parameters in their own file

algolia · Jan 16, 2023 · 46fa260 · 46fa260
1 parent e01d660
commit 46fa260
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 50 deletions.
diff --git a/specs/ingestion/common/parameters.yml b/specs/ingestion/common/parameters.yml
@@ -67,49 +67,3 @@ page:
   required: false
   schema:
     type: integer
-
-enabled:
-  name: enabled
-  in: query
-  description: If the return element should have is 'enabled' property set to true.
-  required: false
-  schema:
-    type: boolean
-
-action:
-  name: action
-  in: query
-  description: Which action the return element should have. Can be a list of string separated with commas.
-  required: false
-  style: form
-  explode: false
-  schema:
-    type: array
-    items:
-      $ref: './schemas/task.yml#/ActionType'
-    example: save,replace
-
-destinationIDQueryParam:
-  name: destinationID
-  in: query
-  description: Which destinationID the return element should have. Can be a list of string separated with commas.
-  required: false
-  style: form
-  explode: false
-  schema:
-    type: array
-    items:
-      type: string
-
-triggerType:
-  name: triggerType
-  in: query
-  description: Which trigger type the return element should have. Can be a list of string separated with commas.
-  required: false
-  style: form
-  explode: false
-  schema:
-    type: array
-    items:
-      $ref: './schemas/task.yml#/TriggerType'
-    example: on_demand,schedule
diff --git a/specs/ingestion/common/taskParameters.yml b/specs/ingestion/common/taskParameters.yml
@@ -0,0 +1,45 @@
+enabled:
+  name: enabled
+  in: query
+  description: If the returned task should have its 'enabled' property set to true.
+  required: false
+  schema:
+    type: boolean
+
+action:
+  name: action
+  in: query
+  description: Which action the returned task should have. Can be a list of string separated with commas.
+  required: false
+  style: form
+  explode: false
+  schema:
+    type: array
+    items:
+      $ref: './schemas/task.yml#/ActionType'
+    example: save,replace
+
+destinationID:
+  name: destinationID
+  in: query
+  description: Which destinationID 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
+
+triggerType:
+  name: triggerType
+  in: query
+  description: Which trigger type the returned task should have. Can be a list of string separated with commas.
+  required: false
+  style: form
+  explode: false
+  schema:
+    type: array
+    items:
+      $ref: './schemas/task.yml#/TriggerType'
+    example: on_demand,schedule
diff --git a/specs/ingestion/paths/tasks/tasks.yml b/specs/ingestion/paths/tasks/tasks.yml
@@ -7,10 +7,10 @@ get:
   parameters:
     - $ref: '../../common/parameters.yml#/itemsPerPage'
     - $ref: '../../common/parameters.yml#/page'
-    - $ref: '../../common/parameters.yml#/action'
-    - $ref: '../../common/parameters.yml#/enabled'
-    - $ref: '../../common/parameters.yml#/destinationIDQueryParam'
-    - $ref: '../../common/parameters.yml#/triggerType'
+    - $ref: '../../common/taskParameters.yml#/action'
+    - $ref: '../../common/taskParameters.yml#/enabled'
+    - $ref: '../../common/taskParameters.yml#/destinationID'
+    - $ref: '../../common/taskParameters.yml#/triggerType'
   responses:
     '200':
       description: OK