Add 404 spec for delete index, get document, delete document APIs

Signed-off-by: Vatsal <vatsal.v.anand@gmail.com>
opensearch-project · Sep 28, 2024 · 9798e59 · 9798e59
1 parent 7d05664
commit 9798e59
Show file tree

Hide file tree

Showing 6 changed files with 66 additions and 1 deletion.
diff --git a/spec/namespaces/_core.yaml b/spec/namespaces/_core.yaml
@@ -1264,6 +1264,8 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/get@200'
+        '404':
+          $ref: '#/components/responses/get@200'
     head:
       operationId: exists.0
       x-operation-group: exists
@@ -1364,6 +1366,8 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/delete@200'
+        '404':
+          $ref: '#/components/responses/delete@200'
   /{index}/_explain/{id}:
     get:
       operationId: explain.0

diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml
@@ -1044,6 +1044,8 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/indices.delete@200'
+        '404':
+          $ref: '#/components/responses/indices.delete@404'
   /{index}/_alias:
     get:
       operationId: indices.get_alias.2
@@ -2400,6 +2402,11 @@ components:
         application/json:
           schema:
             $ref: '../schemas/_common.yaml#/components/schemas/IndicesResponseBase'
+    indices.delete@404:
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/indices._common.yaml#/components/schemas/IndexErrorCause'
     indices.delete_alias@200:
       content:
         application/json:

diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml
@@ -2238,3 +2238,7 @@ components:
       required:
         - reason
         - status
+    ResourceType:
+      type: string
+      enum:
+        - index_or_alias
diff --git a/spec/schemas/indices._common.yaml b/spec/schemas/indices._common.yaml
@@ -1010,3 +1010,29 @@ components:
         - mappings
         - order
         - settings
+    IndexErrorCause:
+      type: object
+      properties:
+        type:
+          description: The type of error
+          type: string
+        reason:
+          description: A human-readable explanation of the error, in english
+          type: string
+        root_cause:
+          type: array
+          items:
+            $ref: '#/components/schemas/IndexErrorCause'
+        index:
+          $ref: '_common.yaml#/components/schemas/IndexName'
+        index_uuid:
+          $ref: '_common.yaml#/components/schemas/Uuid'
+        resource.id:
+          $ref: '_common.yaml#/components/schemas/IndexName'
+        resource.type:
+          $ref: '_common.yaml#/components/schemas/ResourceType'
+      required:
+        - type
+      additionalProperties:
+        title: metadata
+        description: Additional details about the error.
diff --git a/tests/default/indices/doc.yaml b/tests/default/indices/doc.yaml
@@ -57,3 +57,19 @@ chapters:
       id: '1'
     response:
       status: 200
+  - synopsis: Retrieve a non existing document.
+    path: /{index}/_doc/{id}
+    method: GET
+    parameters:
+      index: movies
+      id: '1'
+    response:
+      status: 404
+  - synopsis: Delete a non existing document.
+    path: /{index}/_doc/{id}
+    method: DELETE
+    parameters:
+      index: movies
+      id: '1'
+    response:
+      status: 404
diff --git a/tests/default/indices/index.yaml b/tests/default/indices/index.yaml
@@ -84,4 +84,12 @@ chapters:
     version: '>= 2.0'
     parameters:
       index: books,games
-      cluster_manager_timeout: 10s     
+      cluster_manager_timeout: 10s
+
+  - synopsis: Delete non existing index `movies`.
+    path: /{index}
+    method: DELETE
+    parameters:
+      index: movies
+    response:
+      status: 404