feat(specs): add search endpoint to every item type (#1274)

Author: Fluf22

specs/ingestion/common/schemas/authentication.yml

@@ -93,6 +93,17 @@ AuthenticationUpdateResponse:
     - name
     - updatedAt
 
+AuthenticationSearch:
+  type: object
+  additionalProperties: false
+  properties:
+    authenticationIDs:
+      type: array
+      items:
+        type: string
+  required:
+    - authenticationIDs
+
 AuthenticationType:
   type: string
   enum: ['googleServiceAccount', 'basic', 'apiKey', 'oauth', 'algolia']

specs/ingestion/common/schemas/destination.yml

@@ -84,6 +84,17 @@ DestinationUpdateResponse:
     - name
     - updatedAt
 
+DestinationSearch:
+  type: object
+  additionalProperties: false
+  properties:
+    destinationIDs:
+      type: array
+      items:
+        type: string
+  required:
+    - destinationIDs
+
 DestinationType:
   type: string
   enum: ['search', 'insights', 'flow', 'predict']

specs/ingestion/common/schemas/source.yml

@@ -84,6 +84,17 @@ SourceUpdateResponse:
     - name
     - updatedAt
 
+SourceSearch:
+  type: object
+  additionalProperties: false
+  properties:
+    sourceIDs:
+      type: array
+      items:
+        type: string
+  required:
+    - sourceIDs
+
 SourceType:
   type: string
   enum: ['bigcommerce', 'commercetools', 'json']

specs/ingestion/common/schemas/task.yml

@@ -88,6 +88,17 @@ TaskUpdateResponse:
     - taskID
     - updatedAt
 
+TaskSearch:
+  type: object
+  additionalProperties: false
+  properties:
+    taskIDs:
+      type: array
+      items:
+        type: string
+  required:
+    - taskIDs
+
 ActionType:
   type: string
   enum: ['replace', 'save', 'delete']

specs/ingestion/paths/authentications/searchAuthentications.yml

@@ -0,0 +1,24 @@
+post:
+  tags:
+    - authentications
+  summary: Search among authentications.
+  description: Search among authentications with a defined set of parameters.
+  operationId: searchAuthentications
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../common/schemas/authentication.yml#/AuthenticationSearch'
+    required: true
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            title: searchAuthenticationsResponse
+            type: array
+            items:
+              $ref: '../../common/schemas/authentication.yml#/Authentication'
+    '400':
+      $ref: '../../../common/responses/BadRequest.yml'

specs/ingestion/paths/destinations/searchDestinations.yml

@@ -0,0 +1,24 @@
+post:
+  tags:
+    - destinations
+  summary: Search among destinations.
+  description: Search among destinations with a defined set of parameters.
+  operationId: searchDestinations
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../common/schemas/destination.yml#/DestinationSearch'
+    required: true
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            title: searchDestinationsResponse
+            type: array
+            items:
+              $ref: '../../common/schemas/destination.yml#/Destination'
+    '400':
+      $ref: '../../../common/responses/BadRequest.yml'

specs/ingestion/paths/sources/searchSources.yml

@@ -0,0 +1,24 @@
+post:
+  tags:
+    - sources
+  summary: Search among sources.
+  description: Search among sources with a defined set of parameters.
+  operationId: searchSources
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../common/schemas/source.yml#/SourceSearch'
+    required: true
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            title: searchSourcesResponse
+            type: array
+            items:
+              $ref: '../../common/schemas/source.yml#/Source'
+    '400':
+      $ref: '../../../common/responses/BadRequest.yml'

specs/ingestion/paths/tasks/searchTasks.yml

@@ -0,0 +1,24 @@
+post:
+  tags:
+    - tasks
+  summary: Search among tasks.
+  description: Search among tasks with a defined set of parameters.
+  operationId: searchTasks
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../common/schemas/task.yml#/TaskSearch'
+    required: true
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            title: searchTasksResponse
+            type: array
+            items:
+              $ref: '../../common/schemas/task.yml#/Task'
+    '400':
+      $ref: '../../../common/responses/BadRequest.yml'

specs/ingestion/spec.yml

@@ -39,24 +39,32 @@ paths:
   # authentications api
   /1/authentications:
     $ref: 'paths/authentications/authentications.yml'
+  /1/authentications/search:
+    $ref: 'paths/authentications/searchAuthentications.yml'
   /1/authentications/{authenticationID}:
     $ref: 'paths/authentications/authenticationID.yml'
 
   # destinations api
   /1/destinations:
     $ref: 'paths/destinations/destinations.yml'
+  /1/destinations/search:
+    $ref: 'paths/destinations/searchDestinations.yml'
   /1/destinations/{destinationID}:
     $ref: 'paths/destinations/destinationID.yml'
 
   # sources api
   /1/sources:
     $ref: 'paths/sources/sources.yml'
+  /1/sources/search:
+    $ref: 'paths/sources/searchSources.yml'
   /1/sources/{sourceID}:
     $ref: 'paths/sources/sourceID.yml'
 
   # tasks api
   /1/tasks:
     $ref: 'paths/tasks/tasks.yml'
+  /1/tasks/search:
+    $ref: 'paths/tasks/searchTasks.yml'
   /1/tasks/{taskID}:
     $ref: 'paths/tasks/taskID.yml'
   /1/tasks/{taskID}/run: