fix(specs): ingestion api reference (#2918)

Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>

generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java

@@ -121,6 +121,8 @@ public String toEnumVarName(String value, String datatype) {
         return "GREATER_THAN";
       case ">=":
         return "GREATER_EQUALS";
+      case "mappingkit/v1":
+        return "MAPPINGKIT_V1";
     }
 
     if (!value.matches("[A-Z0-9_]+")) {

generators/src/main/java/com/algolia/codegen/cts/tests/ParametersWithDataType.java

@@ -598,6 +598,9 @@ private void transferPrimitiveData(IJsonSchemaValidationProperties spec, Map<Str
       case "String":
         output.put("isString", true);
         break;
+      case "UUID":
+        output.put("isString", true);
+        break;
       case "Integer":
         output.put("isInteger", true);
         output.put("isNumber", true);

specs/ingestion/common/authenticationParameters.yml

@@ -1,7 +1,7 @@
 type:
   name: type
   in: query
-  description: The type of the authentications to retrieve.
+  description: Type of authentication resource to retrieve.
   required: false
   style: form
   explode: false
@@ -14,7 +14,7 @@ type:
 platform:
   name: platform
   in: query
-  description: The platform of the authentications to retrieve.
+  description: Ecommerce platform for which to retrieve authentication resources.
   required: false
   style: form
   explode: false
@@ -26,7 +26,7 @@ platform:
 
 platformNone:
   type: string
-  description: Used to filter Authentication without platform property.
+  description: Authentication resource not tied to any ecommerce platform, used for filtering.
   enum: ['none']
 
 platformWithNone:
@@ -37,12 +37,13 @@ platformWithNone:
 sort:
   name: sort
   in: query
-  description: The key by which the list should be sorted.
+  description: Property by which to sort the list of authentication resources.
   required: false
   schema:
     $ref: '#/authenticationSortKeys'
 
 authenticationSortKeys:
   type: string
-  description: Used to sort the Authentication list endpoint.
+  description: Property by which to sort the list of authentication resources.
+  default: createdAt
   enum: [name, auth_type, platform, updatedAt, createdAt]

specs/ingestion/common/destinationParameters.yml

@@ -1,7 +1,7 @@
 type:
   name: type
   in: query
-  description: The type of the destinations to retrive.
+  description: Destination type.
   required: false
   style: form
   explode: false
@@ -14,7 +14,7 @@ type:
 authenticationID:
   name: authenticationID
   in: query
-  description: The authenticationIDs of the destinations to retrive.
+  description: Authentication ID used by destinations.
   required: false
   style: form
   explode: false
@@ -26,12 +26,14 @@ authenticationID:
 sort:
   name: sort
   in: query
-  description: The key by which the list should be sorted.
+  description: Property by which to sort the destinations.
   required: false
+  example: type
   schema:
     $ref: '#/destinationSortKeys'
 
 destinationSortKeys:
   type: string
-  description: Used to sort the Destination list endpoint.
+  description: Property by which to sort the destinations.
+  default: createdAt
   enum: [name, type, updatedAt, createdAt]

specs/ingestion/common/observabilityParameters.yml

@@ -1,7 +1,7 @@
 eventStatus:
   name: status
   in: query
-  description: Filter the status of the events.
+  description: Event status for filtering the list of task runs.
   schema:
     type: array
     items:
@@ -10,7 +10,7 @@ eventStatus:
 eventType:
   name: type
   in: query
-  description: Filter the type of the events.
+  description: Event type for filtering the list of task runs.
   schema:
     type: array
     items:
@@ -19,7 +19,7 @@ eventType:
 runStatus:
   name: status
   in: query
-  description: Filter the status of the runs.
+  description: Run status for filtering the list of task runs.
   schema:
     type: array
     items:
@@ -28,32 +28,33 @@ runStatus:
 taskID:
   name: taskID
   in: query
-  description: Filter by taskID.
+  description: Task ID for filtering the list of task runs.
   schema:
     $ref: './schemas/common.yml#/taskID'
 
 runSort:
   name: sort
   in: query
-  description: The key by which the list should be sorted.
+  description: Property by which to sort the list of task runs.
   required: false
   schema:
     $ref: '#/runSortKeys'
 
 runSortKeys:
   type: string
-  description: Used to sort the Run list endpoint.
+  description: Property by which to sort the list of task runs.
+  default: createdAt
   enum: [status, updatedAt, createdAt]
 
 eventSort:
   name: sort
   in: query
-  description: The key by which the list should be sorted.
+  description: Property by which to sort the list of task run events.
   required: false
   schema:
     $ref: '#/eventSortKeys'
 
 eventSortKeys:
   type: string
-  description: Used to sort the Event list endpoint.
+  description: Property by which to sort the list of task run events.
   enum: [status, type, publishedAt]

specs/ingestion/common/parameters.yml

@@ -2,75 +2,76 @@ pathAuthenticationID:
   name: authenticationID
   in: path
   required: true
-  description: The authentication UUID.
+  description: Unique identifier of an authentication resource.
   schema:
     $ref: './schemas/common.yml#/authenticationID'
 
 pathDestinationID:
   name: destinationID
   in: path
   required: true
-  description: The destination UUID.
+  description: Unique identifier of a destination.
   schema:
     $ref: './schemas/common.yml#/destinationID'
 
 pathSourceID:
   name: sourceID
   in: path
   required: true
-  description: The source UUID.
+  description: Unique identifier of a source.
   schema:
     $ref: './schemas/common.yml#/sourceID'
 
 pathTaskID:
   name: taskID
   in: path
   required: true
-  description: The task UUID.
+  description: Unique identifier of a task.
   schema:
     $ref: './schemas/common.yml#/taskID'
 
 pathRunID:
   name: runID
   in: path
   required: true
-  description: The run UUID.
+  description: Unique identifier of a task run.
   schema:
     $ref: './schemas/common.yml#/runID'
 
 pathEventID:
   name: eventID
   in: path
   required: true
-  description: The event UUID.
+  description: Unique identifier of an event.
   schema:
     $ref: './schemas/common.yml#/eventID'
 
 itemsPerPage:
   name: itemsPerPage
   in: query
-  description: The number of items per page to return.
+  description: Number of items per page.
   required: false
   schema:
-    type: integer
+    $ref: './schemas/pagination.yml#/itemsPerPage'
 
 page:
   name: page
   in: query
-  description: The page number to fetch, starting at 1.
+  description: Page number of the paginated API response.
   required: false
   schema:
-    type: integer
+    $ref: './schemas/pagination.yml#/page'
 
 order:
   name: order
   in: query
-  description: The order of the returned list.
+  description: Sort order of the response, ascending or descending.
   required: false
   schema:
     $ref: '#/orderKeys'
 
 orderKeys:
   type: string
-  description: Used to order a sorted request.
+  description: Ascending or descending sort order.
+  default: desc
   enum: [asc, desc]