Removed default values from param description (#264)

Signed-off-by: saimedhi <saimedhi@amazon.com>
opensearch-project · Apr 23, 2024 · af4a34f · af4a34f
1 parent 20cdaa1
commit af4a34f
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 12 deletions.
diff --git a/spec/namespaces/_core.yaml b/spec/namespaces/_core.yaml
@@ -3757,7 +3757,7 @@ components:
     delete_by_query::query.from:
       in: query
       name: from
-      description: 'Starting offset (default: 0)'
+      description: Starting offset.
       schema:
         type: number
         default: 0
@@ -5017,10 +5017,10 @@ components:
     reindex::query.max_docs:
       name: max_docs
       in: query
-      description: 'Maximum number of documents to process (default: all documents).'
+      description: Maximum number of documents to process. By default, all documents.
       schema:
         type: integer
-        description: 'Maximum number of documents to process (default: all documents).'
+        description: Maximum number of documents to process. By default, all documents.
         format: int32
     reindex::query.refresh:
       in: query
@@ -6057,7 +6057,7 @@ components:
     update_by_query::query.from:
       in: query
       name: from
-      description: 'Starting offset (default: 0)'
+      description: Starting offset.
       schema:
         type: number
         default: 0

diff --git a/spec/namespaces/cluster.yaml b/spec/namespaces/cluster.yaml
@@ -1202,7 +1202,7 @@ components:
     cluster.put_settings::query.flat_settings:
       in: query
       name: flat_settings
-      description: 'Return settings in flat format (default: false)'
+      description: Return settings in flat format.
       schema:
         type: boolean
         default: false
@@ -1327,7 +1327,7 @@ components:
     cluster.state::query.flat_settings:
       in: query
       name: flat_settings
-      description: 'Return settings in flat format (default: false)'
+      description: Return settings in flat format.
       schema:
         type: boolean
         default: false
@@ -1342,7 +1342,7 @@ components:
     cluster.state::query.local:
       in: query
       name: local
-      description: 'Return local information, do not retrieve the state from cluster-manager node (default: false)'
+      description: Return local information, do not retrieve the state from cluster-manager node.
       schema:
         type: boolean
         default: false

diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml
@@ -3359,15 +3359,15 @@ components:
     indices.exists_template::query.flat_settings:
       in: query
       name: flat_settings
-      description: 'Return settings in flat format (default: false)'
+      description: Return settings in flat format.
       schema:
         type: boolean
         default: false
       style: form
     indices.exists_template::query.local:
       in: query
       name: local
-      description: 'Return local information, do not retrieve the state from cluster-manager node (default: false)'
+      description: Return local information, do not retrieve the state from cluster-manager node.
       schema:
         type: boolean
         default: false
@@ -3462,7 +3462,7 @@ components:
     indices.forcemerge::query.flush:
       in: query
       name: flush
-      description: 'Specify whether the index should be flushed after performing the operation (default: true)'
+      description: Specify whether the index should be flushed after performing the operation.
       schema:
         type: boolean
         default: true
@@ -3477,7 +3477,10 @@ components:
     indices.forcemerge::query.max_num_segments:
       in: query
       name: max_num_segments
-      description: 'The number of segments the index should be merged into (default: dynamic)'
+      description: |-
+        The number of larger segments into which smaller segments are merged.
+        Set this parameter to 1 to merge all segments into one segment.
+        The default behavior is to perform the merge as necessary.
       schema:
         type: number
       style: form

diff --git a/spec/namespaces/snapshot.yaml b/spec/namespaces/snapshot.yaml
@@ -765,7 +765,7 @@ components:
     snapshot.get_repository::query.local:
       in: query
       name: local
-      description: 'Return local information, do not retrieve the state from cluster-manager node (default: false)'
+      description: Return local information, do not retrieve the state from cluster-manager node.
       schema:
         type: boolean
         default: false