Fixed index naming, description and changelog

Signed-off-by: Tatsuya Kawakami <43780506+hogesako@users.noreply.github.com>
opensearch-project · Oct 16, 2024 · c483acb · c483acb
1 parent f3e6158
commit c483acb
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -177,7 +177,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Fixed mapping and analysis types ([#600](https://github.com/opensearch-project/opensearch-api-specification/pull/600))
 - Fixed `RestStatus` responses in `DELETE /_plugins/_notifications/configs/{config_id}` ([#594](https://github.com/opensearch-project/opensearch-api-specification/pull/594))
 - Fixed `GET /_snapshot_/{repository}/{snapshot}` ([#608](https://github.com/opensearch-project/opensearch-api-specification/pull/608))
-- Fixed `POST /_snapshot/{repository}/{snapshot}/_restore` when wait_for_completion is false and `GET /{index}/_recovery` ([#611](https://github.com/opensearch-project/opensearch-api-specification/pull/611))
+- Fixed `POST /_snapshot/{repository}/{snapshot}/_restore` when `wait_for_completion` is `false` and `GET /{index}/_recovery` ([#611](https://github.com/opensearch-project/opensearch-api-specification/pull/611))
 
 ### Security
 

diff --git a/spec/namespaces/snapshot.yaml b/spec/namespaces/snapshot.yaml
@@ -383,7 +383,7 @@ components:
             type: object
             properties:
               accepted:
-                description: Equals `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false`
+                description: Returns `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false`.
                 type: boolean
               snapshot:
                 $ref: '../schemas/snapshot._common.yaml#/components/schemas/SnapshotInfo'
@@ -428,7 +428,7 @@ components:
             type: object
             properties:
               accepted:
-                description: Equals `true` if the restore was accepted. Present when the request had `wait_for_completion` set to `false`
+                description: Returns `true` if the restore was accepted. Present when the request had `wait_for_completion` set to `false`.
                 type: boolean
               snapshot:
                 $ref: '../schemas/snapshot.restore.yaml#/components/schemas/SnapshotRestore'

diff --git a/tests/snapshot/snapshot/restore.yaml b/tests/snapshot/snapshot/restore.yaml
@@ -13,10 +13,10 @@ epilogues:
     status: [200, 404]
     parameters:
       repository: my-fs-repository
-  - path: /restore-index-wait-true
+  - path: /movies
     method: DELETE
     status: [200, 404]
-  - path: /restore-index-wait-false
+  - path: /books
     method: DELETE
     status: [200, 404]
 prologues:
@@ -29,9 +29,9 @@ prologues:
         type: fs
         settings:
           location: /tmp/opensearch/repo
-  - path: /restore-index-wait-true
+  - path: /movies
     method: PUT
-  - path: /restore-index-wait-false
+  - path: /books
     method: PUT
   - path: /_snapshot/{repository}/{snapshot}
     method: PUT
@@ -42,15 +42,15 @@ prologues:
     request:
       payload:
         indices:
-          - restore-index-wait-false
-          - restore-index-wait-true
+          - books
+          - movies
         ignore_unavailable: true
         include_global_state: false
         partial: true
-  - path: /restore-index-wait-true
+  - path: /movies
     method: DELETE
     status: [200, 404]
-  - path: /restore-index-wait-false
+  - path: /books
     method: DELETE
     status: [200, 404]
 chapters:
@@ -63,7 +63,7 @@ chapters:
       wait_for_completion: true
     request:
       payload:
-        indices: restore-index-wait-true
+        indices: movies
     response:
       status: 200
       payload:
@@ -78,7 +78,7 @@ chapters:
       wait_for_completion: false
     request:
       payload:
-        indices: restore-index-wait-false
+        indices: books
     response:
       status: 200
       payload:
@@ -89,11 +89,11 @@ chapters:
       multiple-paths-detected: false
     method: GET
     parameters:
-      index: restore-index-wait-false
+      index: books
     response:
       status: 200
       payload:
-        restore-index-wait-false:
+        books:
           shards:
             - stage: DONE
               type: SNAPSHOT