Updating descriptions of specs

Signed-off-by: Harsh Garg <[email protected]>
opensearch-project · Oct 22, 2024 · f1d0e24 · f1d0e24
1 parent a8990d3
commit f1d0e24
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 22 deletions.
diff --git a/.github/workflows/test-spec.yml b/.github/workflows/test-spec.yml
@@ -40,10 +40,10 @@ jobs:
             tests: plugins/streaming
           - version: 2.18.0
             hub: opensearchstaging
-            ref: '@sha256:4445e195c53992038891519dc3be0d273cdaad1b047943d68921168ed243e7e9'
+            ref: '@sha256:83e56824438188322f2d477b262e4b55aa3e4d0c03c6f9b2f27de4ecfafc9a62'
           - version: 3.0.0
             hub: opensearchstaging
-            ref: '@sha256:727643acdfebed77bfdb26362dbcff536b7ea02a0cc4ae2da2521729171333de'
+            ref: '@sha256:dac5f937714616e99f698af9ce07610043c38e34abc9e19f48d1a12f0680ea17'
 
     name: test-opensearch-spec (version=${{ matrix.entry.version }}, hub=${{ matrix.entry.hub || 'opensearchproject' }}, tests=${{ matrix.entry.tests || 'default' }})
     runs-on: ubuntu-latest

diff --git a/spec/namespaces/list.yaml b/spec/namespaces/list.yaml
@@ -20,7 +20,7 @@ paths:
       operationId: list.indices.0
       x-operation-group: list.indices
       x-version-added: '2.18'
-      description: 'Returns information about indices in a paginated fashion: number of primaries and replicas, document counts, disk size, ...'
+      description: 'Returns paginated information about indices including number of primaries and replicas, document counts, disk size, etc.'
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/list/list-indices/
       parameters:
@@ -49,7 +49,7 @@ paths:
       operationId: list.indices.1
       x-operation-group: list.indices
       x-version-added: '2.18'
-      description: 'Returns information about indices in a paginated fashion: number of primaries and replicas, document counts, disk size, ...'
+      description: 'Returns paginated information about indices including number of primaries and replicas, document counts, disk size, etc.'
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/list/list-indices/
       parameters:
@@ -79,7 +79,7 @@ paths:
       operationId: list.shards.0
       x-operation-group: list.shards
       x-version-added: '2.18'
-      description: Provides a detailed view of shard allocation on nodes in a paginated fashion.
+      description: Returns paginated details of shard allocation on nodes.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/list/list-shards/
       parameters:
@@ -104,7 +104,7 @@ paths:
       operationId: list.shards.1
       x-operation-group: list.shards
       x-version-added: '2.18'
-      description: Provides a detailed view of shard allocation on nodes in a paginated fashion.
+      description: Returns paginated details of shard allocation on nodes.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/list/list-shards/
       parameters:
@@ -361,7 +361,7 @@ components:
     list.indices::query.sort:
       name: sort
       in: query
-      description: Defines order in which indices will be displayed. If "desc", most recently created indices would be displayed first.
+      description: Defines order in which indices will be displayed. Accepted values are `asc` and `desc`. If `desc`, most recently created indices would be displayed first.
       schema:
         type: string
         enum:
@@ -477,7 +477,7 @@ components:
     list.shards::query.sort:
       name: sort
       in: query
-      description: Defines order in which shards will be displayed. If "desc", most recently created shards would be displayed first.
+      description: Defines order in which shards will be displayed. Accepted values are `asc` and `desc`. If `desc`, most recently created shards would be displayed first.
       schema:
         type: string
         enum:

diff --git a/tests/default/list/indices.yaml b/tests/default/list/indices.yaml
@@ -1,6 +1,7 @@
 $schema: ../../../json_schemas/test_story.schema.yaml
 
 description: Test _list/indices endpoints.
+version: '>= 2.18'
 prologues:
   - path: /{index}
     method: PUT
@@ -29,14 +30,12 @@ epilogues:
     status: [200, 404]
 chapters:
   - synopsis: List information related to indexes (text/plain).
-    version: '>= 2.18'
     method: GET
     path: /_list/indices
     response:
       status: 200
       content_type: text/plain
   - synopsis: List information related to one index (text/plain).
-    version: '>= 2.18'
     method: GET
     path: /_list/indices/{index}
     parameters:
@@ -45,7 +44,6 @@ chapters:
       status: 200
       content_type: text/plain
   - synopsis: List information related to indexes with verbose output (v=true).
-    version: '>= 2.18'
     method: GET
     path: /_list/indices
     parameters:
@@ -54,7 +52,6 @@ chapters:
       status: 200
       content_type: text/plain
   - synopsis: List information related to indexes with headers (h=header1,header2).
-    version: '>= 2.18'
     method: GET
     path: /_list/indices
     parameters:
@@ -65,7 +62,6 @@ chapters:
       status: 200
       content_type: text/plain
   - synopsis: List information related to indexes displaying all available headers (help=true).
-    version: '>= 2.18'
     method: GET
     path: /_list/indices
     parameters:
@@ -74,7 +70,6 @@ chapters:
       status: 200
       content_type: text/plain
   - synopsis: List information related to indexes with sorted results.
-    version: '>= 2.18'
     method: GET
     path: /_list/indices
     parameters:
@@ -84,7 +79,6 @@ chapters:
       status: 200
       content_type: text/plain
   - synopsis: List information related to indexes with bytes, time and all fields.
-    version: '>= 2.18'
     method: GET
     path: /_list/indices
     parameters:
@@ -97,7 +91,6 @@ chapters:
       status: 200
       content_type: application/json
   - synopsis: List information related to indexes with all fields.
-    version: '>= 2.18'
     method: GET
     path: /_list/indices
     parameters:
@@ -106,7 +99,6 @@ chapters:
       status: 200
       content_type: application/json
   - synopsis: List information related to indexes in different formats (format=json).
-    version: '>= 2.18'
     method: GET
     path: /_list/indices
     parameters:
@@ -115,7 +107,6 @@ chapters:
       status: 200
       content_type: application/json
   - synopsis: List information related to indexes in different formats (format=yaml).
-    version: '>= 2.18'
     method: GET
     path: /_list/indices
     parameters:
@@ -124,7 +115,6 @@ chapters:
       status: 200
       content_type: application/yaml
   - synopsis: List information related to indexes in different formats (format=cbor).
-    version: '>= 2.18'
     distributions:
       excluded:
         - amazon-managed
@@ -137,7 +127,6 @@ chapters:
       status: 200
       content_type: application/cbor
   - synopsis: List information related to indexes in different formats (format=smile).
-    version: '>= 2.18'
     distributions:
       excluded:
         - amazon-managed

diff --git a/tests/default/list/shards.yaml b/tests/default/list/shards.yaml
@@ -1,6 +1,7 @@
 $schema: ../../../json_schemas/test_story.schema.yaml
 
 description: Test list/shards endpoints.
+version: '>= 2.18'
 prologues:
   - path: /{index}
     method: PUT
@@ -27,15 +28,13 @@ epilogues:
     status: [200, 404]
 chapters:
   - synopsis: List the state of all primary and replica shards and how they are distributed.
-    version: '>= 2.18'
     path: /_list/shards
     method: GET
     parameters:
       format: json
       h:
         - '*'
   - synopsis: List the state of all primary and replica shards and how they are distributed for an index.
-    version: '>= 2.18'
     path: /_list/shards/{index}
     method: GET
     parameters: