review

Author: millotp

specs/ingestion/common/schemas/authentication.yml

@@ -13,9 +13,9 @@ Authentication:
     input:
       $ref: '#/AuthInput'
     createdAt:
-      type: string
+      $ref: './common.yml#/createdAt'
     updatedAt:
-      type: string
+      $ref: './common.yml#/updatedAt'
   required:
     - authenticationID
     - type
@@ -49,7 +49,7 @@ AuthenticationCreateResponse:
     name:
       type: string
     createdAt:
-      type: string
+      $ref: './common.yml#/createdAt'
   required:
     - authenticationID
     - name
@@ -77,15 +77,15 @@ AuthenticationUpdateResponse:
     name:
       type: string
     updatedAt:
-      type: string
+      $ref: './common.yml#/updatedAt'
   required:
     - authenticationID
     - name
     - updatedAt
 
 AuthenticationType:
   type: string
-  enum: ['google_service_account', 'basic', 'apiKey', 'oauth', 'algolia']
+  enum: ['googleServiceAccount', 'basic', 'apiKey', 'oauth', 'algolia']
 
 PlatformType:
   type: string

specs/ingestion/common/schemas/common.yml

@@ -0,0 +1,16 @@
+createdAt:
+  type: string
+  description: Date of creation (RFC3339 format).
+
+updatedAt:
+  type: string
+  description: Date of last update (RFC3339 format).
+
+DeleteResponse:
+  type: object
+  properties:
+    deletedAt:
+      type: string
+      description: Date of deletion (RFC3339 format)
+  required:
+    - deletedAt

specs/ingestion/common/schemas/destination.yml

@@ -11,9 +11,9 @@ Destination:
     input:
       $ref: '#/DestinationInput'
     createdAt:
-      type: string
+      $ref: './common.yml#/createdAt'
     updatedAt:
-      type: string
+      $ref: './common.yml#/updatedAt'
     authenticationID:
       type: string
   required:
@@ -51,7 +51,7 @@ DestinationCreateResponse:
     name:
       type: string
     createdAt:
-      type: string
+      $ref: './common.yml#/createdAt'
   required:
     - destinationID
     - name
@@ -79,7 +79,7 @@ DestinationUpdateResponse:
     name:
       type: string
     updatedAt:
-      type: string
+      $ref: './common.yml#/updatedAt'
   required:
     - destinationID
     - name

specs/ingestion/common/schemas/source.yml

@@ -13,9 +13,9 @@ Source:
     authenticationID:
       type: string
     createdAt:
-      type: string
+      $ref: './common.yml#/createdAt'
     updatedAt:
-      type: string
+      $ref: './common.yml#/updatedAt'
   required:
     - sourceID
     - type
@@ -51,7 +51,7 @@ SourceCreateResponse:
     name:
       type: string
     createdAt:
-      type: string
+      $ref: './common.yml#/createdAt'
   required:
     - sourceID
     - name
@@ -79,22 +79,15 @@ SourceUpdateResponse:
     name:
       type: string
     updatedAt:
-      type: string
+      $ref: './common.yml#/updatedAt'
   required:
     - sourceID
     - name
     - updatedAt
 
 SourceType:
   type: string
-  enum:
-    - 'csv'
-    - 'json'
-    - 'bigquery'
-    - 'bigquery_ga4'
-    - 'bigquery_ua'
-    - 'bigcommerce'
-    - 'commercetools'
+  enum: ['bigcommerce', 'commercetools']
 
 SourceCommercetools:
   type: object
@@ -117,7 +110,7 @@ SourceBigCommerce:
   type: object
   additionalProperties: false
   properties:
-    store_hash:
+    storeHash:
       type: string
   required:
     - store_hash

specs/ingestion/common/schemas/task.yml

@@ -23,9 +23,9 @@ Task:
     nextRun:
       type: string
     createdAt:
-      type: string
+      $ref: './common.yml#/createdAt'
     updatedAt:
-      type: string
+      $ref: './common.yml#/updatedAt'
   required:
     - taskID
     - sourceID
@@ -64,7 +64,7 @@ TaskCreateResponse:
     taskID:
       type: string
     createdAt:
-      type: string
+      $ref: './common.yml#/createdAt'
   required:
     - taskID
     - createdAt
@@ -87,7 +87,7 @@ TaskUpdateResponse:
     taskID:
       type: string
     updatedAt:
-      type: string
+      $ref: './common.yml#/updatedAt'
   required:
     - taskID
     - updatedAt

specs/ingestion/paths/authentications/authenticationID.yml

@@ -51,5 +51,9 @@ delete:
   responses:
     '204':
       description: OK
+      content:
+        application/json:
+          schema:
+            $ref: '../../common/schemas/common.yml#/DeleteResponse'
     '400':
       $ref: '../../../common/responses/BadRequest.yml'

specs/ingestion/paths/destinations/destinationID.yml

@@ -51,5 +51,9 @@ delete:
   responses:
     '204':
       description: OK
+      content:
+        application/json:
+          schema:
+            $ref: '../../common/schemas/common.yml#/DeleteResponse'
     '400':
       $ref: '../../../common/responses/BadRequest.yml'

specs/ingestion/paths/sources/sourceID.yml

@@ -51,5 +51,9 @@ delete:
   responses:
     '204':
       description: OK
+      content:
+        application/json:
+          schema:
+            $ref: '../../common/schemas/common.yml#/DeleteResponse'
     '400':
       $ref: '../../../common/responses/BadRequest.yml'

specs/ingestion/paths/tasks/taskID.yml

@@ -51,5 +51,9 @@ delete:
   responses:
     '204':
       description: OK
+      content:
+        application/json:
+          schema:
+            $ref: '../../common/schemas/common.yml#/DeleteResponse'
     '400':
       $ref: '../../../common/responses/BadRequest.yml'

specs/ingestion/spec.yml

@@ -1,8 +1,7 @@
 openapi: 3.0.2
 info:
   title: Ingestion API
-  description: >-
-    [Documentation](https://docs.google.com/document/d/13UnFi4Osfw4vOJr5iN4P4RJDZdslpFs4OgM4F1VBwQc/edit#heading=h.kp12qj1w1lig)
+  description: API powering the Data Ingestion feature of Algolia
   version: '1.0'
 components:
   securitySchemes:
@@ -32,7 +31,7 @@ tags:
     description: Sources describe the platform informations.
   - name: tasks
     x-displayName: Tasks
-    description: Tasks refers to all type on Ingestion we can do (Reindex, On demand update, ...).
+    description: Tasks refers to all type of Ingestion we can do (Reindex, On demand update, ...).
 paths:
   /1/authentications:
     $ref: 'paths/authentications/authentications.yml'