create common response file with taskID and objectID

algolia · Nov 10, 2021 · 4966251 · 4966251
1 parent f2a4845
commit 4966251
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 14 deletions.
diff --git a/openapi_spec/paths/indexes/batch.yml b/openapi_spec/paths/indexes/batch.yml
@@ -47,11 +47,9 @@ post:
             additionalProperties: false
             properties:
               taskID:
-                type: integer
+                $ref: '../../responses/common.yml#/taskID'
               objectIDs:
-                type: array
-                items:
-                  type: string
+                $ref: '../../responses/common.yml#/objectIDs'
     '400':
       $ref: '../../responses/BadRequest.yml'
     '404':

diff --git a/openapi_spec/paths/indexes/multipleQueries.yml b/openapi_spec/paths/indexes/multipleQueries.yml
@@ -69,14 +69,11 @@ post:
                         additionalProperties: false
                         properties:
                           objectID:
-                            type: string
-                            example: objectID1
+                            $ref: '../../responses/common.yml#/objectID'
                     nbHits:
                       type: integer
                     queryID:
-                      type: string
-                      pattern: '[a-f0-9]{32}'
-                      example: 43b15df305339e827f0ac0bdc5ebcaa7
+                      $ref: '../../responses/common.yml#/queryID'
     '400':
       $ref: '../../responses/BadRequest.yml'
     '404':

diff --git a/openapi_spec/paths/indexes/saveObject.yml b/openapi_spec/paths/indexes/saveObject.yml
@@ -27,9 +27,9 @@ post:
               createdAt:
                 type: string
               taskID:
-                type: integer
+                $ref: '../../responses/common.yml#/taskID'
               objectID:
-                type: string
+                $ref: '../../responses/common.yml#/objectID'
     '400':
       $ref: '../../responses/BadRequest.yml'
     '404':

diff --git a/openapi_spec/paths/indexes/search.yml b/openapi_spec/paths/indexes/search.yml
@@ -26,13 +26,12 @@ post:
                   additionalProperties: false
                   properties:
                     objectID:
-                      type: string
-                      example: objectID1
+                      $ref: '../../responses/common.yml#/objectID'
               nbHits:
                 type: integer
               queryID:
                 type: string
-                pattern: '[a-f0-9]{32}'
+                pattern: '^[a-f0-9]{32}$'
                 example: 43b15df305339e827f0ac0bdc5ebcaa7
     '400':
       $ref: '../../responses/BadRequest.yml'

diff --git a/openapi_spec/responses/common.yml b/openapi_spec/responses/common.yml
@@ -0,0 +1,15 @@
+taskID:
+  type: integer
+  description: taskID of the indexing task to wait for.
+objectID:
+  type: string
+  description: Unique identifier of the object
+objectIDs:
+  type: array
+  items:
+    type: string
+  description: List of objectID
+queryID:
+  type: string
+  pattern: '^[a-f0-9]{32}$'
+  example: 43b15df305339e827f0ac0bdc5ebcaa7