adding changelog and fixing validate spec ci

Signed-off-by: Tokesh <[email protected]>
Tokesh · Aug 22, 2024 · 1952fd1 · 1952fd1
1 parent 22f6cc8
commit 1952fd1
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -79,6 +79,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added `cancelled_task_percentage` and `current_cancellation_eligible_tasks_count` to `ShardSearchBackpressureTaskCancellationStats` ([#483](https://github.com/opensearch-project/opensearch-api-specification/pull/483))
 - Added detailed test coverage report ([#513](https://github.com/opensearch-project/opensearch-api-specification/pull/513))
 - Added 404 responses to `/_alias/{name}` and `/{index}/_alias/{name}` ([#519](https://github.com/opensearch-project/opensearch-api-specification/pull/519))
+- Added `asynchronous_search` namespace API specifications ([#525](https://github.com/opensearch-project/opensearch-api-specification/pull/525))
 
 ### Changed
 

diff --git a/spec/namespaces/asynchronous_search.yaml b/spec/namespaces/asynchronous_search.yaml
@@ -13,18 +13,18 @@ paths:
       externalDocs:
         url: https://opensearch.org/docs/latest/search-plugins/async/index/#rest-api
       parameters:
-        - $ref: '#/components/parameters/asynchronous_search.search::query.wait_for_completion_timeout'
-        - $ref: '#/components/parameters/asynchronous_search.search::query.keep_on_completion'
-        - $ref: '#/components/parameters/asynchronous_search.search::query.keep_alive'
         - $ref: '#/components/parameters/asynchronous_search.search::query.index'
+        - $ref: '#/components/parameters/asynchronous_search.search::query.keep_alive'
+        - $ref: '#/components/parameters/asynchronous_search.search::query.keep_on_completion'
+        - $ref: '#/components/parameters/asynchronous_search.search::query.wait_for_completion_timeout'
       requestBody:
         $ref: '#/components/requestBodies/asynchronous_search.search'
       responses:
         '200':
           $ref: '#/components/responses/asynchronous_search.search@200'
   /_plugins/_asynchronous_search/{id}:
     get:
-      operationId: asynchronous_search.search.get.0
+      operationId: asynchronous_search.get.0
       x-operation-group: asynchronous_search.get
       x-version-added: '1.0'
       description: Get partial responses from asynchronous search.
@@ -36,7 +36,7 @@ paths:
         '200':
           $ref: '#/components/responses/asynchronous_search.get@200'
     delete:
-      operationId: asynchronous_search.search.delete.0
+      operationId: asynchronous_search.delete.0
       x-operation-group: asynchronous_search.delete
       x-version-added: '1.0'
       description: Delete asynchronous search.
@@ -49,7 +49,7 @@ paths:
           $ref: '#/components/responses/asynchronous_search.delete@200'
   /_plugins/_asynchronous_search/stats:
     get:
-      operationId: asynchronous_search.search.stats.0
+      operationId: asynchronous_search.stats.0
       x-operation-group: asynchronous_search.stats
       x-version-added: '1.0'
       description: Monitoring of asynchronous searches that are running, completed, and/or persisted.
@@ -95,15 +95,12 @@ components:
       in: path
       schema:
         type: string
-
   requestBodies:
     asynchronous_search.search:
       content:
         application/json:
           schema:
             $ref: '../schemas/asynchronous_search._common.yaml#/components/schemas/Search'
-            # $ref: '_core.yaml#/components/requestBodies/search'
-
   responses:
     asynchronous_search.search@200:
       content:

diff --git a/spec/schemas/asynchronous_search._common.yaml b/spec/schemas/asynchronous_search._common.yaml
@@ -183,4 +183,4 @@ components:
           type: array
           items:
             type: string
-      description: The search definition using the Query DSL
+      description: The search definition using the Query DSL.