Fixed search_pipeline spec (#253)

Signed-off-by: saimedhi <[email protected]>
opensearch-project · Apr 18, 2024 · cecb187 · cecb187
1 parent 29faff0
commit cecb187
Show file tree

Hide file tree

Showing 2 changed files with 72 additions and 9 deletions.
diff --git a/spec/namespaces/search_pipeline.yaml b/spec/namespaces/search_pipeline.yaml
@@ -4,14 +4,15 @@ info:
   description: OpenSearch Search_pipeline API
   version: 1.0.0
 paths:
-  /_search/pipeline/{pipeline}:
+  /_search/pipeline/{id}:
     get:
       operationId: search_pipeline.get.0
       x-operation-group: search_pipeline.get
       x-version-added: '2.9'
       description: Retrieves information about a specified search pipeline.
       parameters:
-        - $ref: '#/components/parameters/search_pipeline.get::path.pipeline'
+        - $ref: '#/components/parameters/search_pipeline.get::query.cluster_manager_timeout'
+        - $ref: '#/components/parameters/search_pipeline.get::path.id'
       responses:
         '200':
           $ref: '#/components/responses/search_pipeline.get@200'
@@ -23,12 +24,26 @@ paths:
       externalDocs:
         url: https://opensearch.org/docs/latest/search-plugins/search-pipelines/creating-search-pipeline/
       parameters:
-        - $ref: '#/components/parameters/search_pipeline.create::path.pipeline'
+        - $ref: '#/components/parameters/search_pipeline.create::query.cluster_manager_timeout'
+        - $ref: '#/components/parameters/search_pipeline.create::query.timeout'
+        - $ref: '#/components/parameters/search_pipeline.create::path.id'
       requestBody:
         $ref: '#/components/requestBodies/search_pipeline.create'
       responses:
         '200':
           $ref: '#/components/responses/search_pipeline.create@200'
+    delete:
+      operationId: search_pipeline.delete.0
+      x-operation-group: search_pipeline.delete
+      x-version-added: '2.9'
+      description: Deletes the specified search pipeline.
+      parameters:
+        - $ref: '#/components/parameters/search_pipeline.delete::query.cluster_manager_timeout'
+        - $ref: '#/components/parameters/search_pipeline.delete::query.timeout'
+        - $ref: '#/components/parameters/search_pipeline.delete::path.id'
+      responses:
+        '200':
+          $ref: '#/components/responses/search_pipeline.delete@200'
 components:
   requestBodies:
     search_pipeline.create:
@@ -47,22 +62,70 @@ components:
             properties:
               acknowledged:
                 type: boolean
+    search_pipeline.delete@200:
+      description: ''
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              acknowledged:
+                type: boolean
     search_pipeline.get@200:
       description: ''
       content:
         application/json:
           schema:
             $ref: '../schemas/search_pipeline._common.yaml#/components/schemas/SearchPipelineMap'
   parameters:
-    search_pipeline.create::path.pipeline:
-      name: pipeline
+    search_pipeline.create::path.id:
+      name: id
       in: path
       schema:
         type: string
       required: true
-    search_pipeline.get::path.pipeline:
-      name: pipeline
+    search_pipeline.delete::path.id:
+      name: id
       in: path
       schema:
         type: string
       required: true
+    search_pipeline.get::path.id:
+      name: id
+      in: path
+      description: Comma-separated list of search pipeline ids. Wildcards supported.
+      schema:
+        type: string
+    search_pipeline.get::query.cluster_manager_timeout:
+      name: cluster_manager_timeout
+      in: query
+      description: operation timeout for connection to cluster-manager node.
+      schema:
+        $ref: '../schemas/_common.yaml#/components/schemas/Duration'
+      x-version-added: 2.0.0
+    search_pipeline.create::query.cluster_manager_timeout:
+      name: cluster_manager_timeout
+      in: query
+      description: operation timeout for connection to cluster-manager node.
+      schema:
+        $ref: '../schemas/_common.yaml#/components/schemas/Duration'
+      x-version-added: 2.0.0
+    search_pipeline.delete::query.cluster_manager_timeout:
+      name: cluster_manager_timeout
+      in: query
+      description: Operation timeout for connection to cluster-manager node.
+      schema:
+        $ref: '../schemas/_common.yaml#/components/schemas/Duration'
+      x-version-added: 2.0.0
+    search_pipeline.create::query.timeout:
+      name: timeout
+      in: query
+      description: Operation timeout.
+      schema:
+        $ref: '../schemas/_common.yaml#/components/schemas/Duration'
+    search_pipeline.delete::query.timeout:
+      name: timeout
+      in: query
+      description: Operation timeout.
+      schema:
+        $ref: '../schemas/_common.yaml#/components/schemas/Duration'
diff --git a/spec/opensearch-openapi.yaml b/spec/opensearch-openapi.yaml
@@ -468,8 +468,8 @@ paths:
     $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1health'
   /_remotestore/_restore:
     $ref: 'namespaces/remote_store.yaml#/paths/~1_remotestore~1_restore'
-  /_search/pipeline/{pipeline}:
-    $ref: 'namespaces/search_pipeline.yaml#/paths/~1_search~1pipeline~1{pipeline}'
+  /_search/pipeline/{id}:
+    $ref: 'namespaces/search_pipeline.yaml#/paths/~1_search~1pipeline~1{id}'
   /_snapshot:
     $ref: 'namespaces/snapshot.yaml#/paths/~1_snapshot'
   /_snapshot/_status: