Additonal Cat description updates (#778)

Signed-off-by: Naarcha-AWS <[email protected]>
opensearch-project · Jan 10, 2025 · f021351 · f021351
1 parent 5177c0a
commit f021351
Showing 1 changed file with 42 additions and 42 deletions.
diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml
@@ -1156,11 +1156,11 @@ components:
     cat.all_pit_segments::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.all_pit_segments::query.s:
       name: s
       in: query
@@ -1292,11 +1292,11 @@ components:
     cat.cluster_manager::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.cluster_manager::query.local:
       name: local
       in: query
@@ -1364,11 +1364,11 @@ components:
     cat.count::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.count::query.s:
       name: s
       in: query
@@ -1433,11 +1433,11 @@ components:
     cat.fielddata::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.fielddata::query.s:
       name: s
       in: query
@@ -1478,11 +1478,11 @@ components:
     cat.health::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.health::query.s:
       name: s
       in: query
@@ -1544,7 +1544,7 @@ components:
     cat.indices::query.expand_wildcards:
       in: query
       name: expand_wildcards
-      description: The type of index that wildcard patterns can match.
+      description: The type of index that wildcard patterns can match.  Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
       style: form
@@ -1576,11 +1576,11 @@ components:
     cat.indices::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.indices::query.include_unloaded_segments:
       in: query
       name: include_unloaded_segments
@@ -1668,11 +1668,11 @@ components:
     cat.master::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.master::query.local:
       name: local
       in: query
@@ -1737,11 +1737,11 @@ components:
     cat.nodeattrs::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.nodeattrs::query.local:
       name: local
       in: query
@@ -1821,11 +1821,11 @@ components:
     cat.nodes::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.nodes::query.local:
       name: local
       in: query
@@ -1899,11 +1899,11 @@ components:
     cat.pending_tasks::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.pending_tasks::query.local:
       name: local
       in: query
@@ -1973,11 +1973,11 @@ components:
     cat.pit_segments::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.pit_segments::query.s:
       name: s
       in: query
@@ -2025,11 +2025,11 @@ components:
     cat.plugins::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.plugins::query.local:
       name: local
       in: query
@@ -2120,11 +2120,11 @@ components:
     cat.recovery::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.recovery::query.index:
       name: index
       in: query
@@ -2193,11 +2193,11 @@ components:
     cat.repositories::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.repositories::query.local:
       name: local
       in: query
@@ -2288,7 +2288,7 @@ components:
     cat.segment_replication::query.expand_wildcards:
       name: expand_wildcards
       in: query
-      description: Whether to expand the wildcard expression to include concrete indexes that are open, closed, or both.
+      description: The type of index that wildcard patterns can match. Supported values are `all`, `open`, `closed`, `hidden`, and `none`.
       schema:
         $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards'
     cat.segment_replication::query.format:
@@ -2312,11 +2312,11 @@ components:
     cat.segment_replication::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.segment_replication::query.ignore_throttled:
       name: ignore_throttled
       in: query
@@ -2513,11 +2513,11 @@ components:
     cat.shards::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.shards::query.local:
       name: local
       in: query
@@ -2611,11 +2611,11 @@ components:
     cat.snapshots::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.snapshots::query.ignore_unavailable:
       in: query
       name: ignore_unavailable
@@ -2696,11 +2696,11 @@ components:
     cat.tasks::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.tasks::query.nodes:
       name: nodes
       in: query
@@ -2785,11 +2785,11 @@ components:
     cat.templates::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.templates::query.local:
       name: local
       in: query
@@ -2864,11 +2864,11 @@ components:
     cat.thread_pool::query.help:
       name: help
       in: query
-      description: Return help information.
+      description: Returns help information.
       schema:
         type: boolean
         default: false
-        description: Return help information.
+        description: Returns help information.
     cat.thread_pool::query.local:
       name: local
       in: query