feat(specs): create ingestion specs

specs/ingestion/common/parameters.yml

@@ -0,0 +1,69 @@
+authenticationID:
+  name: authenticationID
+  in: path
+  description: The authentication uuid.
+  required: true
+  schema:
+    type: string
+    example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f
+
+destinationID:
+  name: destinationID
+  in: path
+  description: The destination uuid.
+  required: true
+  schema:
+    type: string
+    example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f
+
+sourceID:
+  name: sourceID
+  in: path
+  description: The source uuid.
+  required: true
+  schema:
+    type: string
+    example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f
+
+taskID:
+  name: taskID
+  in: path
+  description: The task uuid.
+  required: true
+  schema:
+    type: string
+    example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f
+
+runID:
+  name: runID
+  in: path
+  description: The run uuid.
+  required: true
+  schema:
+    type: string
+    example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f
+
+eventID:
+  name: eventID
+  in: path
+  description: The event uuid.
+  required: true
+  schema:
+    type: string
+    example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f
+
+itemsPerPage:
+  name: itemsPerPage
+  in: query
+  description: The number of items per page to return
+  required: false
+  schema:
+    type: integer
+
+page:
+  name: page
+  in: query
+  description: The page number to fetch, starting at 1
+  required: false
+  schema:
+    type: integer

specs/ingestion/common/schemas/authentication.yml

@@ -0,0 +1,163 @@
+Authentication:
+  type: object
+  additionalProperties: false
+  properties:
+    authenticationID:
+      type: string
+    type:
+      $ref: '#/AuthenticationType'
+    name:
+      type: string
+    platform:
+      $ref: '#/PlatformType'
+    input:
+      $ref: '#/AuthInput'
+    createdAt:
+      $ref: './common.yml#/createdAt'
+    updatedAt:
+      $ref: './common.yml#/updatedAt'
+  required:
+    - authenticationID
+    - type
+    - name
+    - input
+    - createdAt
+
+AuthenticationCreate:
+  type: object
+  additionalProperties: false
+  properties:
+    type:
+      $ref: '#/AuthenticationType'
+    name:
+      type: string
+    platform:
+      $ref: '#/PlatformType'
+    input:
+      $ref: '#/AuthInput'
+  required:
+    - type
+    - name
+    - input
+
+AuthenticationCreateResponse:
+  type: object
+  additionalProperties: false
+  properties:
+    authenticationID:
+      type: string
+    name:
+      type: string
+    createdAt:
+      $ref: './common.yml#/createdAt'
+  required:
+    - authenticationID
+    - name
+    - createdAt
+
+AuthenticationUpdate:
+  type: object
+  additionalProperties: false
+  properties:
+    type:
+      $ref: '#/AuthenticationType'
+    name:
+      type: string
+    platform:
+      $ref: '#/PlatformType'
+    input:
+      $ref: '#/AuthInput'
+
+AuthenticationUpdateResponse:
+  type: object
+  additionalProperties: false
+  properties:
+    authenticationID:
+      type: string
+    name:
+      type: string
+    updatedAt:
+      $ref: './common.yml#/updatedAt'
+  required:
+    - authenticationID
+    - name
+    - updatedAt
+
+AuthenticationType:
+  type: string
+  enum: ['googleServiceAccount', 'basic', 'apiKey', 'oauth', 'algolia']
+
+PlatformType:
+  type: string
+  enum: ['bigcommerce', 'commercetools']
+
+AuthGoogleServiceAccount:
+  type: object
+  additionalProperties: false
+  properties:
+    clientEmail:
+      type: string
+    privateKey:
+      type: string
+  required:
+    - clientEmail
+    - privateKey
+
+AuthBasic:
+  type: object
+  additionalProperties: false
+  properties:
+    username:
+      type: string
+    password:
+      type: string
+  required:
+    - username
+    - password
+
+AuthAPIKey:
+  type: object
+  additionalProperties: false
+  properties:
+    key:
+      type: string
+  required:
+    - key
+
+AuthOAuth:
+  type: object
+  additionalProperties: false
+  properties:
+    url:
+      type: string
+    client_id:
+      type: string
+    client_secret:
+      type: string
+    scope:
+      type: string
+  required:
+    - url
+    - client_id
+    - client_secret
+    - scope
+
+AuthAlgolia:
+  type: object
+  additionalProperties: false
+  properties:
+    appID:
+      type: string
+    apiKey:
+      type: string
+  required:
+    - appID
+    - apiKey
+
+AuthInput:
+  oneOf:
+    - $ref: '#/AuthGoogleServiceAccount'
+    - $ref: '#/AuthBasic'
+    - $ref: '#/AuthAPIKey'
+    - $ref: '#/AuthOAuth'
+    - $ref: '#/AuthAlgolia'

specs/ingestion/common/schemas/common.yml

@@ -0,0 +1,28 @@
+createdAt:
+  type: string
+  description: Date of creation (RFC3339 format).
+
+updatedAt:
+  type: string
+  description: Date of last update (RFC3339 format).
+
+startedAt:
+  type: string
+  description: Date of start (RFC3339 format).
+
+finishedAt:
+  type: string
+  description: Date of finish (RFC3339 format).
+
+publishedAt:
+  type: string
+  description: Date of publish (RFC3339 format).
+
+DeleteResponse:
+  type: object
+  properties:
+    deletedAt:
+      type: string
+      description: Date of deletion (RFC3339 format).
+  required:
+    - deletedAt

specs/ingestion/common/schemas/destination.yml

@@ -0,0 +1,113 @@
+Destination:
+  type: object
+  additionalProperties: false
+  properties:
+    destinationID:
+      type: string
+    type:
+      $ref: '#/DestinationType'
+    name:
+      type: string
+    input:
+      $ref: '#/DestinationInput'
+    createdAt:
+      $ref: './common.yml#/createdAt'
+    updatedAt:
+      $ref: './common.yml#/updatedAt'
+    authenticationID:
+      type: string
+  required:
+    - destinationID
+    - type
+    - name
+    - input
+    - createdAt
+    - authenticationID
+
+DestinationCreate:
+  type: object
+  additionalProperties: false
+  properties:
+    type:
+      $ref: '#/DestinationType'
+    name:
+      type: string
+    input:
+      $ref: '#/DestinationInput'
+    authenticationID:
+      type: string
+  required:
+    - type
+    - name
+    - input
+    - authenticationID
+
+DestinationCreateResponse:
+  type: object
+  additionalProperties: false
+  properties:
+    destinationID:
+      type: string
+    name:
+      type: string
+    createdAt:
+      $ref: './common.yml#/createdAt'
+  required:
+    - destinationID
+    - name
+    - createdAt
+
+DestinationUpdate:
+  type: object
+  additionalProperties: false
+  properties:
+    type:
+      $ref: '#/DestinationType'
+    name:
+      type: string
+    input:
+      $ref: '#/DestinationInput'
+    authenticationID:
+      type: string
+
+DestinationUpdateResponse:
+  type: object
+  additionalProperties: false
+  properties:
+    destinationID:
+      type: string
+    name:
+      type: string
+    updatedAt:
+      $ref: './common.yml#/updatedAt'
+  required:
+    - destinationID
+    - name
+    - updatedAt
+
+DestinationType:
+  type: string
+  enum: ['search', 'insights', 'flow', 'predict']
+
+DestinationIndexPrefix:
+  type: object
+  additionalProperties: false
+  properties:
+    indexPrefix:
+      type: string
+  required:
+    - indexPrefix
+
+DestinationIndexName:
+  type: object
+  additionalProperties: false
+  properties:
+    indexName:
+      type: string
+  required:
+    - indexName
+
+DestinationInput:
+  oneOf:
+    - $ref: '#/DestinationIndexPrefix'
+    - $ref: '#/DestinationIndexName'