feat(specs): source update changes (#1276)

algolia · Jan 31, 2023 · 859c0a9 · 859c0a9
1 parent e3c6b64
commit 859c0a9
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 4 deletions.
diff --git a/specs/ingestion/common/schemas/source.yml b/specs/ingestion/common/schemas/source.yml
@@ -60,12 +60,10 @@ SourceUpdate:
   type: object
   additionalProperties: false
   properties:
-    type:
-      $ref: '#/SourceType'
     name:
       type: string
     input:
-      $ref: '#/SourceInput'
+      $ref: '#/SourceUpdateInput'
     authenticationID:
       type: string
 
@@ -106,6 +104,7 @@ SourceCommercetools:
     storeKeys:
       type: array
       items:
+        description: Unique and immutable key of the referenced Store.
         type: string
     locales:
       type: array
@@ -127,6 +126,7 @@ SourceBigCommerce:
   properties:
     storeHash:
       type: string
+      description: The store hash identifying the store the shopper is signing in to.
   required:
     - store_hash
 
@@ -140,6 +140,7 @@ SourceJson:
   properties:
     url:
       type: string
+      description: The URL of the file.
     method:
       $ref: '#/MethodType'
   required:
@@ -150,3 +151,38 @@ SourceInput:
     - $ref: '#/SourceCommercetools'
     - $ref: '#/SourceBigCommerce'
     - $ref: '#/SourceJson'
+
+SourceUpdateCommercetools:
+  type: object
+  additionalProperties: false
+  properties:
+    storeKeys:
+      type: array
+      description: Unique and immutable key of the referenced Store.
+      items:
+        type: string
+    locales:
+      type: array
+      description: >
+        Array of locales that must match the following pattern: ^[a-z]{2}(-[A-Z]{2})?$. For example ["fr-FR", "en"].
+      items:
+        type: string
+
+SourceUpdateJson:
+  type: object
+  additionalProperties: false
+  properties:
+    url:
+      type: string
+      description: The URL of the file.
+    method:
+      $ref: '#/MethodType'
+  required:
+    - url
+
+
+SourceUpdateInput:
+  oneOf:
+    - $ref: '#/SourceUpdateCommercetools'
+    - $ref: '#/SourceUpdateJson'
+
diff --git a/specs/ingestion/paths/sources/sourceID.yml b/specs/ingestion/paths/sources/sourceID.yml
@@ -16,7 +16,7 @@ get:
     '400':
       $ref: '../../../common/responses/BadRequest.yml'
 
-post:
+put:
   tags:
     - sources
   summary: Update a source.