feat(specs): add sort and order handling in query parameters (#1304)

Author: Fluf22

specs/ingestion/common/authenticationParameters.yml

@@ -33,3 +33,16 @@ platformWithNone:
   oneOf:
     - $ref: './schemas/authentication.yml#/Platform'
     - $ref: '#/platformNone'
+
+sort:
+  name: sort
+  in: query
+  description: The key by which the list should be sorted.
+  required: false
+  schema:
+    $ref: '#/authenticationSortKeys'
+
+authenticationSortKeys:
+  type: string
+  description: Used to sort the Authentication list endpoint.
+  enum: [name, auth_type, platform, updatedAt, createdAt]

specs/ingestion/common/destinationParameters.yml

@@ -22,3 +22,16 @@ authenticationID:
     type: array
     items:
       $ref: './schemas/common.yml#/authenticationID'
+
+sort:
+  name: sort
+  in: query
+  description: The key by which the list should be sorted.
+  required: false
+  schema:
+    $ref: '#/destinationSortKeys'
+
+destinationSortKeys:
+  type: string
+  description: Used to sort the Destination list endpoint.
+  enum: [name, type, updatedAt, createdAt]

specs/ingestion/common/observabilityParameters.yml

@@ -31,3 +31,29 @@ taskID:
   description: Filter by taskID.
   schema:
     $ref: './schemas/common.yml#/taskID'
+
+runSort:
+  name: sort
+  in: query
+  description: The key by which the list should be sorted.
+  required: false
+  schema:
+    $ref: '#/runSortKeys'
+
+runSortKeys:
+  type: string
+  description: Used to sort the Run list endpoint.
+  enum: [status, updatedAt, createdAt]
+
+eventSort:
+  name: sort
+  in: query
+  description: The key by which the list should be sorted.
+  required: false
+  schema:
+    $ref: '#/eventSortKeys'
+
+eventSortKeys:
+  type: string
+  description: Used to sort the Event list endpoint.
+  enum: [status, type, publishedAt]

specs/ingestion/common/parameters.yml

@@ -61,3 +61,16 @@ page:
   required: false
   schema:
     type: integer
+
+order:
+  name: order
+  in: query
+  description: The order of the returned list.
+  required: false
+  schema:
+    $ref: '#/orderKeys'
+
+orderKeys:
+  type: string
+  description: Used to order a sorted request.
+  enum: [asc, desc]

specs/ingestion/common/schemas/source.yml

@@ -194,7 +194,6 @@ SourceUpdateCommercetools:
       items:
         type: string
 
-
 SourceUpdateInput:
   oneOf:
     - $ref: '#/SourceUpdateCommercetools'

specs/ingestion/common/sourceParameters.yml

@@ -25,3 +25,16 @@ authenticationID:
     items:
       $ref: './schemas/common.yml#/authenticationID'
     example: 10000000-0a75-4000-a000-000000000001,none
+
+sort:
+  name: sort
+  in: query
+  description: The key by which the list should be sorted.
+  required: false
+  schema:
+    $ref: '#/sourceSortKeys'
+
+sourceSortKeys:
+  type: string
+  description: Used to sort the Source list endpoint.
+  enum: [name, type, updatedAt, createdAt]

specs/ingestion/common/taskParameters.yml

@@ -56,3 +56,16 @@ triggerType:
     items:
       $ref: './schemas/task.yml#/TriggerType'
     example: onDemand,schedule
+
+sort:
+  name: sort
+  in: query
+  description: The key by which the list should be sorted.
+  required: false
+  schema:
+    $ref: '#/taskSortKeys'
+
+taskSortKeys:
+  type: string
+  description: Used to sort the Task list endpoint.
+  enum: [enabled, triggerType, action, updatedAt, createdAt]

specs/ingestion/paths/authentications/authentications.yml

@@ -9,6 +9,8 @@ get:
     - $ref: '../../common/parameters.yml#/page'
     - $ref: '../../common/authenticationParameters.yml#/type'
     - $ref: '../../common/authenticationParameters.yml#/platform'
+    - $ref: '../../common/authenticationParameters.yml#/sort'
+    - $ref: '../../common/parameters.yml#/order'
   responses:
     '200':
       description: OK

specs/ingestion/paths/destinations/destinations.yml

@@ -9,6 +9,8 @@ get:
     - $ref: '../../common/parameters.yml#/page'
     - $ref: '../../common/destinationParameters.yml#/type'
     - $ref: '../../common/destinationParameters.yml#/authenticationID'
+    - $ref: '../../common/destinationParameters.yml#/sort'
+    - $ref: '../../common/parameters.yml#/order'
   responses:
     '200':
       description: OK

specs/ingestion/paths/runs/events/events.yml

@@ -8,6 +8,8 @@ get:
     - $ref: '../../../common/parameters.yml#/pathRunID'
     - $ref: '../../../common/observabilityParameters.yml#/eventStatus'
     - $ref: '../../../common/observabilityParameters.yml#/eventType'
+    - $ref: '../../../common/observabilityParameters.yml#/eventSort'
+    - $ref: '../../../common/parameters.yml#/order'
   responses:
     '200':
       description: OK