Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removed default values from parameter descriptions #264

Merged
merged 1 commit into from
Apr 23, 2024
Merged

Removed default values from parameter descriptions #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions spec/namespaces/_core.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions spec/namespaces/cluster.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
11 changes: 7 additions & 4 deletions spec/namespaces/indices.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion spec/namespaces/snapshot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading