feat(specs): add with transformation helpers (#4931)

Author: shortcuts

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

@@ -63,6 +63,8 @@ public class AlgoliaSwiftGenerator extends Swift5ClientCodegen {
     "edit",
     "edittype",
     "errorbase",
+    "event",
+    "eventstatus",
     "eventtype",
     "exactonsinglewordquery",
     "exhaustive",
@@ -120,6 +122,7 @@ public class AlgoliaSwiftGenerator extends Swift5ClientCodegen {
     "typotolerance",
     "typotoleranceenum",
     "value",
+    "watchresponse",
     "widgets"
   );
 

specs/common/parameters/ingestion.yml

@@ -0,0 +1,29 @@
+RunID:
+  type: string
+  # format: uuid
+  description: Universally unique identifier (UUID) of a task run.
+  example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f
+
+EventID:
+  type: string
+  # format: uuid
+  description: Universally unique identifier (UUID) of an event.
+  example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f
+
+CreatedAt:
+  type: string
+  description: Date of creation in RFC 3339 format.
+
+PublishedAt:
+  type: string
+  description: Date of publish RFC 3339 format.
+
+EventStatus:
+  oneOf:
+    - type: string
+      enum: [created, started, retried, failed, succeeded, critical]
+    - type: 'null'
+
+EventType:
+  type: string
+  enum: [fetch, record, log, transform]

specs/ingestion/common/schemas/event.yml renamed to specs/common/schemas/ingestion/Observability.yml

@@ -4,13 +4,13 @@ Event:
   additionalProperties: false
   properties:
     eventID:
-      $ref: './common.yml#/eventID'
+      $ref: '../../parameters/ingestion.yml#/EventID'
     runID:
-      $ref: './common.yml#/runID'
+      $ref: '../../parameters/ingestion.yml#/RunID'
     status:
-      $ref: '#/EventStatus'
+      $ref: '../../parameters/ingestion.yml#/EventStatus'
     type:
-      $ref: '#/EventType'
+      $ref: '../../parameters/ingestion.yml#/EventType'
     batchSize:
       type: integer
       description: The extracted record batch size.
@@ -23,21 +23,11 @@ Event:
           additionalProperties: true
         - type: 'null'
     publishedAt:
-      $ref: './common.yml#/publishedAt'
+      $ref: '../../parameters/ingestion.yml#/PublishedAt'
   required:
     - eventID
     - runID
     - status
     - type
     - batchSize
     - publishedAt
-
-EventStatus:
-  oneOf:
-    - type: string
-      enum: [created, started, retried, failed, succeeded, critical]
-    - type: 'null'
-
-EventType:
-  type: string
-  enum: [fetch, record, log, transform]

specs/common/schemas/ingestion/WatchResponse.yml

@@ -0,0 +1,26 @@
+type: object
+additionalProperties: false
+properties:
+  runID:
+    $ref: '../../parameters/ingestion.yml#/RunID'
+  eventID:
+    $ref: '../../parameters/ingestion.yml#/EventID'
+  data:
+    type: array
+    description: |
+      This field is always null when used with the Push endpoint.
+      When used for a source discover or source validate run, it will include the sampled data of the source.
+    items:
+      type: object
+  events:
+    description: in case of error, observability events will be added to the response.
+    type: array
+    items:
+      $ref: './Observability.yml#/Event'
+  message:
+    description: a message describing the outcome of the operation that has been ran (push, discover or validate) run.
+    type: string
+  createdAt:
+    $ref: '../../parameters/ingestion.yml#/CreatedAt'
+required:
+  - runID

specs/ingestion/common/observabilityParameters.yml

@@ -5,7 +5,7 @@ eventStatus:
   schema:
     type: array
     items:
-      $ref: './schemas/event.yml#/EventStatus'
+      $ref: '../../common/parameters/ingestion.yml#/EventStatus'
 
 eventType:
   name: type
@@ -14,7 +14,7 @@ eventType:
   schema:
     type: array
     items:
-      $ref: './schemas/event.yml#/EventType'
+      $ref: '../../common/parameters/ingestion.yml#/EventType'
 
 runStatus:
   name: status

specs/ingestion/common/parameters.yml

@@ -44,15 +44,15 @@ pathRunID:
   required: true
   description: Unique identifier of a task run.
   schema:
-    $ref: './schemas/common.yml#/runID'
+    $ref: '../../common/parameters/ingestion.yml#/RunID'
 
 pathEventID:
   name: eventID
   in: path
   required: true
   description: Unique identifier of an event.
   schema:
-    $ref: './schemas/common.yml#/eventID'
+    $ref: '../../common/parameters/ingestion.yml#/EventID'
 
 itemsPerPage:
   name: itemsPerPage

specs/ingestion/common/schemas/authentication.yml

@@ -16,7 +16,7 @@ Authentication:
     input:
       $ref: '#/AuthInputPartial'
     createdAt:
-      $ref: './common.yml#/createdAt'
+      $ref: '../../../common/parameters/ingestion.yml#/CreatedAt'
     updatedAt:
       $ref: './common.yml#/updatedAt'
   required:
@@ -55,7 +55,7 @@ AuthenticationCreateResponse:
     name:
       $ref: './common.yml#/name'
     createdAt:
-      $ref: './common.yml#/createdAt'
+      $ref: '../../../common/parameters/ingestion.yml#/CreatedAt'
   required:
     - authenticationID
     - name

specs/ingestion/common/schemas/common.yml

@@ -1,7 +1,3 @@
-createdAt:
-  type: string
-  description: Date of creation in RFC 3339 format.
-
 updatedAt:
   type: string
   description: Date of last update in RFC 3339 format.
@@ -14,10 +10,6 @@ finishedAt:
   type: string
   description: Date of finish in RFC 3339 format.
 
-publishedAt:
-  type: string
-  description: Date of publish RFC 3339 format.
-
 cursor:
   type: string
   description: Date of the last cursor in RFC 3339 format.
@@ -66,18 +58,6 @@ transformationID:
   description: Universally unique identifier (UUID) of a transformation.
   example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f
 
-runID:
-  type: string
-  # format: uuid
-  description: Universally unique identifier (UUID) of a task run.
-  example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f
-
-eventID:
-  type: string
-  # format: uuid
-  description: Universally unique identifier (UUID) of an event.
-  example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f
-
 name:
   type: string
   description: Descriptive name for the resource.
@@ -102,29 +82,3 @@ Window:
   required:
     - startDate
     - endDate
-
-WatchResponse:
-  type: object
-  additionalProperties: false
-  properties:
-    runID:
-      $ref: '#/runID'
-    eventID:
-      $ref: '#/eventID'
-    data:
-      type: array
-      description: when used with discovering or validating sources, the sampled data of your source is returned.
-      items:
-        type: object
-    events:
-      description: in case of error, observability events will be added to the response, if any.
-      type: array
-      items:
-        $ref: '../../common/schemas/event.yml#/Event'
-    message:
-      description: a message describing the outcome of a validate run.
-      type: string
-    createdAt:
-      $ref: '#/createdAt'
-  required:
-    - runID

specs/ingestion/common/schemas/destination.yml

@@ -14,7 +14,7 @@ Destination:
     input:
       $ref: '#/DestinationInput'
     createdAt:
-      $ref: './common.yml#/createdAt'
+      $ref: '../../../common/parameters/ingestion.yml#/CreatedAt'
     updatedAt:
       $ref: './common.yml#/updatedAt'
     authenticationID:
@@ -59,7 +59,7 @@ DestinationCreateResponse:
     name:
       $ref: './common.yml#/name'
     createdAt:
-      $ref: './common.yml#/createdAt'
+      $ref: '../../../common/parameters/ingestion.yml#/CreatedAt'
   required:
     - destinationID
     - name

specs/ingestion/common/schemas/run.yml

@@ -4,9 +4,9 @@ RunResponse:
   description: API response for running a task.
   properties:
     runID:
-      $ref: './common.yml#/runID'
+      $ref: '../../../common/parameters/ingestion.yml#/RunID'
     createdAt:
-      $ref: './common.yml#/createdAt'
+      $ref: '../../../common/parameters/ingestion.yml#/CreatedAt'
   required:
     - runID
     - createdAt
@@ -33,7 +33,7 @@ Run:
   additionalProperties: false
   properties:
     runID:
-      $ref: './common.yml#/runID'
+      $ref: '../../../common/parameters/ingestion.yml#/RunID'
     appID:
       type: string
     taskID:
@@ -64,7 +64,7 @@ Run:
     type:
       $ref: '#/RunType'
     createdAt:
-      $ref: './common.yml#/createdAt'
+      $ref: '../../../common/parameters/ingestion.yml#/CreatedAt'
     startedAt:
       $ref: './common.yml#/startedAt'
     finishedAt:

specs/ingestion/common/schemas/source.yml

@@ -15,7 +15,7 @@ Source:
     authenticationID:
       $ref: './common.yml#/authenticationID'
     createdAt:
-      $ref: './common.yml#/createdAt'
+      $ref: '../../../common/parameters/ingestion.yml#/CreatedAt'
     updatedAt:
       $ref: './common.yml#/updatedAt'
   required:
@@ -52,7 +52,7 @@ SourceCreateResponse:
       type: string
       description: Descriptive name of the source.
     createdAt:
-      $ref: './common.yml#/createdAt'
+      $ref: '../../../common/parameters/ingestion.yml#/CreatedAt'
   required:
     - sourceID
     - name

specs/ingestion/common/schemas/task.yml

@@ -35,7 +35,7 @@ Task:
     policies:
       $ref: '#/Policies'
     createdAt:
-      $ref: './common.yml#/createdAt'
+      $ref: '../../../common/parameters/ingestion.yml#/CreatedAt'
     updatedAt:
       $ref: './common.yml#/updatedAt'
   required:
@@ -77,7 +77,7 @@ TaskV1:
     policies:
       $ref: '#/Policies'
     createdAt:
-      $ref: './common.yml#/createdAt'
+      $ref: '../../../common/parameters/ingestion.yml#/CreatedAt'
     updatedAt:
       $ref: './common.yml#/updatedAt'
   required:
@@ -174,7 +174,7 @@ TaskCreateResponse:
     taskID:
       $ref: './common.yml#/taskID'
     createdAt:
-      $ref: './common.yml#/createdAt'
+      $ref: '../../../common/parameters/ingestion.yml#/CreatedAt'
   required:
     - taskID
     - createdAt

specs/ingestion/common/schemas/transformation.yml

@@ -19,7 +19,7 @@ Transformation:
     owner:
       $ref: './common.yml#/owner'
     createdAt:
-      $ref: './common.yml#/createdAt'
+      $ref: '../../../common/parameters/ingestion.yml#/CreatedAt'
     updatedAt:
       $ref: './common.yml#/updatedAt'
   required:
@@ -118,7 +118,7 @@ TransformationCreateResponse:
     transformationID:
       $ref: './common.yml#/transformationID'
     createdAt:
-      $ref: './common.yml#/createdAt'
+      $ref: '../../../common/parameters/ingestion.yml#/CreatedAt'
   required:
     - transformationID
     - createdAt

specs/ingestion/paths/push.yml

@@ -32,6 +32,6 @@ post:
       content:
         application/json:
           schema:
-            $ref: '../common/schemas/common.yml#/WatchResponse'
+            $ref: '../../common/schemas/ingestion/WatchResponse.yml'
     '400':
       $ref: '../../common/responses/BadRequest.yml'

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

@@ -17,6 +17,6 @@ get:
       content:
         application/json:
           schema:
-            $ref: '../../../common/schemas/event.yml#/Event'
+            $ref: '../../../../common/schemas/ingestion/Observability.yml#/Event'
     '400':
       $ref: '../../../../common/responses/BadRequest.yml'

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

@@ -39,7 +39,7 @@ get:
               events:
                 type: array
                 items:
-                  $ref: '../../../common/schemas/event.yml#/Event'
+                  $ref: '../../../../common/schemas/ingestion/Observability.yml#/Event'
               pagination:
                 $ref: '../../../common/schemas/pagination.yml#/Pagination'
               window:

specs/ingestion/paths/sources/discover.yml

@@ -22,6 +22,6 @@ post:
       content:
         application/json:
           schema:
-            $ref: '../../common/schemas/common.yml#/WatchResponse'
+            $ref: '../../../common/schemas/ingestion/WatchResponse.yml'
     '400':
       $ref: '../../../common/responses/BadRequest.yml'

specs/ingestion/paths/sources/runSource.yml

@@ -31,7 +31,7 @@ post:
                 additionalProperties:
                   type: string
               createdAt:
-                $ref: '../../common/schemas/common.yml#/createdAt'
+                $ref: '../../../common/parameters/ingestion.yml#/CreatedAt'
             required:
               - taskWithRunID
               - createdAt

specs/ingestion/paths/sources/validate.yml

@@ -25,6 +25,6 @@ post:
       content:
         application/json:
           schema:
-            $ref: '../../common/schemas/common.yml#/WatchResponse'
+            $ref: '../../../common/schemas/ingestion/WatchResponse.yml'
     '400':
       $ref: '../../../common/responses/BadRequest.yml'