Skip to content

Commit

Permalink
Fixed several Vale violations.
Browse files Browse the repository at this point in the history
Signed-off-by: dblock <[email protected]>
  • Loading branch information
dblock committed Nov 18, 2024
1 parent 1c23126 commit de43481
Show file tree
Hide file tree
Showing 18 changed files with 62 additions and 58 deletions.
42 changes: 21 additions & 21 deletions spec/namespaces/_core.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2711,19 +2711,19 @@ components:
properties:
detect_noop:
description: |-
Set to false to disable setting 'result' in the response
to 'noop' if no change to the document occurred.
Set to `false` to disable setting `result` in the response
to `noop` if no change to the document occurred.
type: boolean
doc:
description: A partial update to an existing document.
type: object
doc_as_upsert:
description: Set to true to use the contents of 'doc' as the value of 'upsert'
description: Set to `true` to use the contents of 'doc' as the value of 'upsert'
type: boolean
script:
$ref: '../schemas/_common.yaml#/components/schemas/Script'
scripted_upsert:
description: Set to true to execute the script whether or not the document exists.
description: Set to `true` to execute the script whether or not the document exists.
type: boolean
_source:
$ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfig'
Expand Down Expand Up @@ -3859,35 +3859,35 @@ components:
delete_by_query::query._source:
name: _source
in: query
description: True or false to return the _source field or not, or a list of fields to return.
description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
style: form
schema:
type: array
items:
type: string
description: True or false to return the _source field or not, or a list of fields to return.
description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
explode: true
delete_by_query::query._source_excludes:
name: _source_excludes
in: query
description: List of fields to exclude from the returned _source field.
description: List of fields to exclude from the returned `_source` field.
style: form
schema:
type: array
items:
type: string
description: List of fields to exclude from the returned _source field.
description: List of fields to exclude from the returned `_source` field.
explode: true
delete_by_query::query._source_includes:
name: _source_includes
in: query
description: List of fields to extract and return from the _source field.
description: List of fields to extract and return from the `_source` field.
style: form
schema:
type: array
items:
type: string
description: List of fields to extract and return from the _source field.
description: List of fields to extract and return from the `_source` field.
explode: true
delete_by_query::query.allow_no_indices:
in: query
Expand Down Expand Up @@ -4398,7 +4398,7 @@ components:
explain::query._source:
in: query
name: _source
description: True or false to return the `_source` field or not, or a list of fields to return.
description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
schema:
$ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam'
style: form
Expand Down Expand Up @@ -4552,7 +4552,7 @@ components:
get::query._source:
in: query
name: _source
description: True or false to return the _source field or not, or a list of fields to return.
description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
schema:
$ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam'
style: form
Expand Down Expand Up @@ -4667,7 +4667,7 @@ components:
get_source::query._source:
in: query
name: _source
description: True or false to return the _source field or not, or a list of fields to return.
description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
schema:
$ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam'
style: form
Expand Down Expand Up @@ -4850,7 +4850,7 @@ components:
mget::query._source:
in: query
name: _source
description: True or false to return the `_source` field or not, or a list of fields to return.
description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
schema:
$ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam'
style: form
Expand Down Expand Up @@ -6094,7 +6094,7 @@ components:
in: query
name: _source
description: |-
Set to false to disable source retrieval. You can also specify a comma-separated
Set to `false` to disable source retrieval. You can also specify a comma-separated
list of the fields you want to retrieve.
schema:
$ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam'
Expand Down Expand Up @@ -6205,35 +6205,35 @@ components:
update_by_query::query._source:
name: _source
in: query
description: True or false to return the _source field or not, or a list of fields to return.
description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
style: form
schema:
type: array
items:
type: string
description: True or false to return the _source field or not, or a list of fields to return.
description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
explode: true
update_by_query::query._source_excludes:
name: _source_excludes
in: query
description: List of fields to exclude from the returned _source field.
description: List of fields to exclude from the returned `_source` field.
style: form
schema:
type: array
items:
type: string
description: List of fields to exclude from the returned _source field.
description: List of fields to exclude from the returned `_source` field.
explode: true
update_by_query::query._source_includes:
name: _source_includes
in: query
description: List of fields to extract and return from the _source field.
description: List of fields to extract and return from the `_source` field.
style: form
schema:
type: array
items:
type: string
description: List of fields to extract and return from the _source field.
description: List of fields to extract and return from the `_source` field.
explode: true
update_by_query::query.allow_no_indices:
in: query
Expand Down
2 changes: 1 addition & 1 deletion spec/namespaces/cluster.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -860,7 +860,7 @@ components:
Specifies whether to wait for all excluded nodes to be removed from the
cluster before clearing the voting configuration exclusions list.
Defaults to true, meaning that all excluded nodes must be removed from
the cluster before this API takes any action. If set to false then the
the cluster before this API takes any action. If set to `false` then the
voting configuration exclusions list is cleared even if some excluded
nodes are still in the cluster.
schema:
Expand Down
12 changes: 6 additions & 6 deletions spec/namespaces/knn.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -321,35 +321,35 @@ components:
knn.search_models::query._source:
name: _source
in: query
description: True or false to return the _source field or not, or a list of fields to return.
description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
style: form
schema:
type: array
items:
type: string
description: True or false to return the _source field or not, or a list of fields to return.
description: Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
explode: true
knn.search_models::query._source_excludes:
name: _source_excludes
in: query
description: List of fields to exclude from the returned _source field.
description: List of fields to exclude from the returned `_source` field.
style: form
schema:
type: array
items:
type: string
description: List of fields to exclude from the returned _source field.
description: List of fields to exclude from the returned `_source` field.
explode: true
knn.search_models::query._source_includes:
name: _source_includes
in: query
description: List of fields to extract and return from the _source field.
description: List of fields to extract and return from the `_source` field.
style: form
schema:
type: array
items:
type: string
description: List of fields to extract and return from the _source field.
description: List of fields to extract and return from the `_source` field.
explode: true
knn.search_models::query.allow_no_indices:
name: allow_no_indices
Expand Down
4 changes: 2 additions & 2 deletions spec/namespaces/query.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.1.0
info:
title: OpenSearch Query Datasources API
description: OpenSearch Query Datasources API.
title: OpenSearch Query Data Sources API
description: OpenSearch Query Data Sources API.
version: 2.7.0
paths:
/_plugins/_query/_datasources:
Expand Down
2 changes: 1 addition & 1 deletion spec/namespaces/snapshot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -826,7 +826,7 @@ components:
snapshot.status::query.ignore_unavailable:
in: query
name: ignore_unavailable
description: Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
description: Whether to ignore unavailable snapshots, defaults to `false` which means a SnapshotMissingException is thrown
schema:
type: boolean
default: false
Expand Down
2 changes: 1 addition & 1 deletion spec/schemas/_common.query_dsl.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,7 @@ components:
rewrite:
$ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite'
transpositions:
description: Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`).
description: Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`).
type: boolean
fuzziness:
$ref: '_common.yaml#/components/schemas/Fuzziness'
Expand Down
2 changes: 1 addition & 1 deletion spec/schemas/_core.msearch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ components:
items:
$ref: '_common.query_dsl.yaml#/components/schemas/FieldAndFormat'
knn:
description: Defines the approximate kNN search to run.
description: Defines the approximate k-NN search to run.
oneOf:
- $ref: '_common.query_dsl.yaml#/components/schemas/KnnQuery'
- type: array
Expand Down
8 changes: 6 additions & 2 deletions spec/schemas/_core.termvectors.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ components:
type: number
max_word_length:
description: |-
The maximum word length above which words will be ignored.
The maximum word length.
Words longer than this value will be ignored.
Default is `unbounded`.
type: number
min_doc_freq:
Expand All @@ -34,7 +35,10 @@ components:
description: Ignore words with less than this frequency in the source doc.
type: number
min_word_length:
description: The minimum word length below which words will be ignored.
description: |-
The minimum word length.
Words shorter than this value will be ignored.
Default is 0.
type: number
TermVector:
type: object
Expand Down
2 changes: 1 addition & 1 deletion spec/schemas/cat.thread_pool.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ components:
description: The process identifier.
type: string
host:
description: The host name for the current node.
description: The hostname for the current node.
type: string
ip:
description: The IP address for the current node.
Expand Down
4 changes: 2 additions & 2 deletions spec/schemas/cluster.health.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ components:
description: The number of shards whose allocation has been delayed by the timeout settings.
type: number
discovered_master:
description: True if the master node has been discovered.
description: True if the cluster manager node has been discovered.
type: boolean
x-version-deprecated: '2.0'
discovered_cluster_manager:
Expand Down Expand Up @@ -67,7 +67,7 @@ components:
task_max_waiting_in_queue_millis:
$ref: '_common.yaml#/components/schemas/DurationValueUnitMillis'
timed_out:
description: If false the response returned within the period of time that is specified by the timeout parameter (30s by default).
description: If `false` the response returned within the period of time that is specified by the timeout parameter (`30s` by default).
type: boolean
unassigned_shards:
description: The number of shards that are not allocated.
Expand Down
2 changes: 1 addition & 1 deletion spec/schemas/cluster.reroute.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ components:
node:
type: string
accept_data_loss:
description: If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true
description: If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag `accept_data_loss` to be explicitly set to `true`.
type: boolean
required:
- accept_data_loss
Expand Down
2 changes: 1 addition & 1 deletion spec/schemas/indices._common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ components:
$ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitMillis'
parse_origination_date:
description: |-
Set to true to parse the origination date from the index name. This origination date is used to calculate the index age
Set to `true` to parse the origination date from the index name. This origination date is used to calculate the index age
for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is
yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format,
for example logs-2016.10.31-000002). If the index name doesn't match the pattern, index creation fails.
Expand Down
2 changes: 1 addition & 1 deletion spec/schemas/indices.data_streams_stats.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ components:
store_size:
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
store_size_bytes:
description: Total size, in bytes, of all shards for the data stream's backing indices.
description: Total size, in bytes, of all shards for the data stream's backing indexes.
$ref: '_common.yaml#/components/schemas/ByteCount'
required:
- backing_indices
Expand Down
2 changes: 1 addition & 1 deletion spec/schemas/insights._common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ components:
description: Additional labels for the query.
search_type:
type: string
description: The search query type (e.g., query_then_fetch).
description: The search query type (for example, `query_then_fetch`).
source:
type: object
$ref: '#/components/schemas/Source'
Expand Down
2 changes: 1 addition & 1 deletion spec/schemas/nodes.info.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ components:
description: Number of processors available to the Java virtual machine
type: number
allocated_processors:
description: The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS.
description: The number of processors actually used to calculate thread pool size. This number can be set with the `node.processors` setting of a node and defaults to the number of processors reported by the OS.
type: number
name:
$ref: '_common.yaml#/components/schemas/Name'
Expand Down
4 changes: 2 additions & 2 deletions spec/schemas/query._common.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.1.0
info:
title: Schemas for OpenSearch Query Datasources API
description: Schemas for OpenSearch Query Datasources API
title: Schemas for OpenSearch Query Data Sources API
description: Schemas for OpenSearch Query Data Sources API
version: 1.0.0
paths: {}
components:
Expand Down
Loading

0 comments on commit de43481

Please sign in to comment.