diff --git a/.cspell b/.cspell index bf297ec39..7e9cf8acc 100644 --- a/.cspell +++ b/.cspell @@ -1,227 +1,10 @@ -aarch -actiongroup -actiongroups -aggregatable aoss APIV -argjson -asciifolding -authc -authinfo -authtoken -autocut -autofollow -backendroles -backpressure -beider -Bobg -Boundsdouble -boxplot -Boxplot -caverphone -CBOR -charfilters -chisquared -chuhlomin -cpuacct -cuserr -daitch -dangoslen -dashboardsinfo -datarows -decompounder -Decompounder -dedup -deprovision -determinized -distilbert -DNFOF -docvalue -Downsample -downsampling -Downsampling +cbor evals -ewma -Ewma -faiss -fielddata -Fielddata -forcemerge -Formattable -fragmenter -Fragmenter -freqs -generateonbehalfoftoken -geodistance -geohash -geohex -Geohex -geoip -geopoint -geoshape -geospatial -geotile -gsub -Gsub -haasephonetik -hashcode -heteroscedastic -hnsw -homoscedastic -hotthreads -huggingface -hybridfs -ignorecase -integ -internalusers -Intertransport -ipam -Jelinek -kibanainfo -kibanaserver -koelnerphonetik -kstem -kuromoji -Kuromoji -languageset -latlon -Léon -localstats -Lovins lucene -Lucene -lycheeverse -marvinpinto -memlock -metaphone -mget millis -Millis -mlockall -mmap -mmapfs -mmdb -mokotoff -Moneyball -msearch -msmarco -mtermvectors -mult -Multisearch -multitenancy mxyz -nanos -Nanos -nbest -nfkc -ngram -nguyenvukhang -niofs -nmslib -nodeattrs -nodesdn -nonword -noops -nori -Nori -nysiis -ONNX opendistro opensearch -OPENSEARCH -opensearchproject -opensearchstaging -ords -OSCPU -oversample -Oversample -performanceanalyzer -permissionsinfo -pipefail -pipenv -preconfigure -preconfigured -prefilter -pretrain -pretrained -prirep -rawfile -readingform -rebalance -Rebalance -recoverysource -Refn -reindex -Reindex -relo -reloadcerts -remotestore -reprovision -rerank -Rerank -Reranker -rethrottle -Rethrottle -rolesmapping -Rolespan -rollup -Rollup -rollups -Rollups -romaji -roundtrips -Rudnick -ruleset -scriptless -securityconfig -signoff -slowlog -Slowlog -slurpfile -smartcn -Smartcn -snapshotted -softmax -softprops -Sorani -sslinfo -stoptags -stopwords -Stringifiedboolean -Stringifiedinteger -subqueries -subschemas -subword -syserr -tcnative -tdigest -tenantinfo -termvectors -tfidf -Tfidf -thomaseizinger -Tika -timeframe -tlbr -tokenfilters -translog -Translog -trbl -truststore -tubone -ulimits -Undeploys -unigrams -Unmanaged -unmatch -untriaged -updateable -upsert -urldecode -vectory -whoamiprotected -wordnet -yber -Yrtsd -جامد -جامدات \ No newline at end of file +OPENSEARCH \ No newline at end of file diff --git a/.vale.ini b/.vale.ini index 6e3ed73c7..9141bb025 100644 --- a/.vale.ini +++ b/.vale.ini @@ -2,7 +2,7 @@ StylesPath = ".github/vale/styles" Vocab = "OpenSearch" MinAlertLevel = warning -[*] +[*.{yaml,yml}] BasedOnStyles = Vale, OpenSearch Vale.Spelling = NO diff --git a/eslint.config.mjs b/eslint.config.mjs index f782d0a2b..d488ff842 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -113,8 +113,7 @@ export default [ parser: parserYml }, plugins: { - 'yml': pluginYml, - '@cspell': pluginCspell + 'yml': pluginYml }, rules: { 'yml/no-empty-document': 'off', @@ -122,7 +121,6 @@ export default [ 'yml/plain-scalar': ['error', 'always'], 'yml/no-trailing-zeros': 'error', 'yml/no-multiple-empty-lines': 'error', - '@cspell/spellchecker': ['error', { customWordListFile: '.cspell', autoFix: true }], 'yml/sort-sequence-values': ['error', { pathPattern: '.*', order: { type: 'asc' } }] } } diff --git a/spec/namespaces/_core.yaml b/spec/namespaces/_core.yaml index bd5afec8c..6f40a0bb1 100644 --- a/spec/namespaces/_core.yaml +++ b/spec/namespaces/_core.yaml @@ -2487,11 +2487,11 @@ components: source: description: |- An inline search template. - Supports the same parameters as the search API's request body. + Supports the same parameters as the search API request body. These parameters also support Mustache variables. If no `id` or `` is specified, this parameter is required. type: string - description: The search definition template and its params + description: The search definition template and its parameters. scripts_painless_execute: content: application/json: @@ -2533,7 +2533,7 @@ components: collapse: $ref: '../schemas/_core.search.yaml#/components/schemas/FieldCollapse' explain: - description: If true, returns detailed information about score computation as part of a hit. + description: If `true`, returns detailed information about score computation as part of a hit. type: boolean ext: description: Configuration of search extensions defined by OpenSearch plugins. @@ -2639,10 +2639,10 @@ components: Defaults to no timeout. type: string track_scores: - description: If true, calculate and return document scores, even if the scores are not used for sorting. + description: If `true`, calculate and return document scores, even if the scores are not used for sorting. type: boolean version: - description: If true, returns document version as part of a hit. + description: If `true`, returns document version as part of a hit. type: boolean seq_no_primary_term: description: If `true`, returns sequence number and primary term of the last modification of each hit. @@ -2684,11 +2684,11 @@ components: type: boolean source: description: |- - An inline search template. Supports the same parameters as the search API's + An inline search template. Supports the same parameters as the search API request body. Also supports Mustache variables. If no id is specified, this parameter is required. type: string - description: The search definition template and its params + description: The search definition template and its parameters. required: true termvectors: content: @@ -2715,19 +2715,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' @@ -3871,35 +3871,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 @@ -4076,10 +4076,10 @@ components: delete_by_query::query.size: name: size in: query - description: Deprecated, please use `max_docs` instead. + description: Deprecated, use `max_docs` instead. schema: type: integer - description: Deprecated, please use `max_docs` instead. + description: Deprecated, use `max_docs` instead. format: int32 delete_by_query::query.slices: in: query @@ -4190,7 +4190,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -4355,7 +4355,7 @@ components: exists_source::query.realtime: in: query name: realtime - description: If true, the request is real-time as opposed to near-real-time. + description: If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean style: form @@ -4410,7 +4410,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 @@ -4501,7 +4501,7 @@ components: field_caps::path.index: in: path name: index - description: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all. + description: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or `_all`. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -4510,7 +4510,7 @@ components: in: query name: allow_no_indices description: |- - If false, the request returns an error if any wildcard expression, index alias, + If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. schema: @@ -4540,7 +4540,7 @@ components: field_caps::query.include_unmapped: in: query name: include_unmapped - description: If true, unmapped fields are included in the response. + description: If `true`, unmapped fields are included in the response. schema: type: boolean default: false @@ -4564,7 +4564,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 @@ -4600,7 +4600,7 @@ components: get::query.refresh: in: query name: refresh - description: If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + description: If `true`, OpenSearch refreshes the affected shards to make this operation visible to search. If `false`, do nothing with refreshes. schema: $ref: '../schemas/_common.yaml#/components/schemas/Refresh' style: form @@ -4631,7 +4631,7 @@ components: get::query.version_type: in: query name: version_type - description: 'Specific version type: internal, external, external_gte.' + description: 'Specific version type: `internal`, `external`, `external_gte`.' schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionType' style: form @@ -4679,7 +4679,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 @@ -4708,14 +4708,14 @@ components: get_source::query.realtime: in: query name: realtime - description: Boolean) If true, the request is real-time as opposed to near-real-time. + description: Boolean) If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean style: form get_source::query.refresh: in: query name: refresh - description: If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + description: If `true`, OpenSearch refreshes the affected shards to make this operation visible to search. If `false`, do nothing with refreshes. schema: $ref: '../schemas/_common.yaml#/components/schemas/Refresh' style: form @@ -4736,7 +4736,7 @@ components: get_source::query.version_type: in: query name: version_type - description: 'Specific version type: internal, external, external_gte.' + description: Specific version type. One of `internal`, `external`, `external_gte`. schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionType' style: form @@ -4862,7 +4862,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 @@ -4932,7 +4932,7 @@ components: msearch::query.ccs_minimize_roundtrips: in: query name: ccs_minimize_roundtrips - description: If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. + description: If `true`, network round-trips between the coordinating node and remote clusters are minimized for cross-cluster search requests. schema: type: boolean default: true @@ -4965,7 +4965,7 @@ components: msearch::query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + description: If `true`, hits.total are returned as an integer in the response. Defaults to false, which returns an object. schema: type: boolean default: false @@ -5108,7 +5108,7 @@ components: mtermvectors::query.realtime: in: query name: realtime - description: If true, the request is real-time as opposed to near-real-time. + description: If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean default: true @@ -5123,7 +5123,7 @@ components: mtermvectors::query.term_statistics: in: query name: term_statistics - description: If true, the response includes term frequency and document frequency. + description: If `true`, the response includes term frequency and document frequency. schema: type: boolean default: false @@ -5181,7 +5181,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -5343,7 +5343,7 @@ components: scroll::query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: If true, the API response's hit.total property is returned as an integer. If false, the API response's hit.total property is returned as an object. + description: If `true`, the API response's `hit.total` property is returned as an integer. If `false`, the API response's `hit.total` property is returned as an object. schema: type: boolean default: false @@ -5421,7 +5421,7 @@ components: search::query.allow_partial_search_results: in: query name: allow_partial_search_results - description: If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. + description: If `true`, returns partial results if there are shard request timeouts or shard failures. If `false`, returns an error with no partial results. schema: type: boolean default: true @@ -5430,7 +5430,7 @@ components: in: query name: analyze_wildcard description: |- - If true, wildcard and prefix queries are analyzed. + If `true`, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified. schema: type: boolean @@ -5459,7 +5459,7 @@ components: search::query.ccs_minimize_roundtrips: in: query name: ccs_minimize_roundtrips - description: If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. + description: If `true`, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. schema: type: boolean default: true @@ -5536,11 +5536,11 @@ components: search::query.include_named_queries_score: name: include_named_queries_score in: query - description: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) + description: Indicates whether `hit.matched_queries` should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) schema: type: boolean default: false - description: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) + description: Indicates whether `hit.matched_queries` should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) search::query.lenient: in: query name: lenient @@ -5947,7 +5947,7 @@ components: search_template::query.rest_total_hits_as_int: in: query name: rest_total_hits_as_int - description: If true, hits.total are rendered as an integer in the response. + description: If `true`, hits.total are rendered as an integer in the response. schema: type: boolean default: false @@ -6052,7 +6052,7 @@ components: termvectors::query.realtime: in: query name: realtime - description: If true, the request is real-time as opposed to near-real-time. + description: If `true`, the request is real-time as opposed to near-real-time. schema: type: boolean default: true @@ -6106,7 +6106,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' @@ -6153,15 +6153,15 @@ components: name: refresh description: |- If 'true', OpenSearch refreshes the affected shards to make this operation - visible to search, if 'wait_for' then wait for a refresh to make this operation - visible to search, if 'false' do nothing with refreshes. + visible to search, if `wait_for` then wait for a refresh to make this operation + visible to search, if `false` do nothing with refreshes. schema: $ref: '../schemas/_common.yaml#/components/schemas/Refresh' style: form update::query.require_alias: in: query name: require_alias - description: If true, the destination must be an index alias. + description: If `true`, the destination must be an index alias. schema: type: boolean default: false @@ -6217,35 +6217,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 @@ -6427,10 +6427,10 @@ components: update_by_query::query.size: name: size in: query - description: Deprecated, please use `max_docs` instead. + description: Deprecated, use `max_docs` instead. schema: type: integer - description: Deprecated, please use `max_docs` instead. + description: Deprecated, use `max_docs` instead. format: int32 update_by_query::query.slices: in: query diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml index 7e05cdea5..e9036b721 100644 --- a/spec/namespaces/cat.yaml +++ b/spec/namespaces/cat.yaml @@ -268,7 +268,7 @@ paths: operationId: cat.master.0 x-operation-group: cat.master deprecated: true - x-deprecation-message: To promote inclusive language, please use '/_cat/cluster_manager' instead. + x-deprecation-message: To promote inclusive language, use '/_cat/cluster_manager' instead. x-version-added: '1.0' x-version-deprecated: '2.0' description: Returns information about the cluster-manager node. @@ -1073,10 +1073,10 @@ components: cat.aliases::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.aliases::query.h: name: h in: query @@ -1132,10 +1132,10 @@ components: cat.all_pit_segments::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.all_pit_segments::query.h: name: h in: query @@ -1199,10 +1199,10 @@ components: cat.allocation::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.allocation::query.h: name: h in: query @@ -1233,7 +1233,7 @@ components: cat.allocation::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1268,10 +1268,10 @@ components: cat.cluster_manager::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.cluster_manager::query.h: name: h in: query @@ -1302,7 +1302,7 @@ components: cat.cluster_manager::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1340,10 +1340,10 @@ components: cat.count::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.count::query.h: name: h in: query @@ -1409,10 +1409,10 @@ components: cat.fielddata::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.fielddata::query.h: name: h in: query @@ -1454,10 +1454,10 @@ components: cat.health::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.health::query.h: name: h in: query @@ -1498,7 +1498,7 @@ components: cat.health::query.ts: in: query name: ts - description: If true, returns `HH:MM:SS` and Unix epoch timestamps. + description: If `true`, returns `HH:MM:SS` and Unix epoch timestamps. schema: type: boolean default: true @@ -1545,10 +1545,10 @@ components: cat.indices::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.indices::query.h: name: h in: query @@ -1578,7 +1578,7 @@ components: cat.indices::query.include_unloaded_segments: in: query name: include_unloaded_segments - description: If true, the response includes information from segments that are not loaded into memory. + description: If `true`, the response includes information from segments that are not loaded into memory. schema: type: boolean default: false @@ -1594,7 +1594,7 @@ components: cat.indices::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1603,7 +1603,7 @@ components: cat.indices::query.pri: in: query name: pri - description: If true, the response only includes information from primary shards. + description: If `true`, the response only includes information from primary shards. schema: type: boolean default: false @@ -1644,10 +1644,10 @@ components: cat.master::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.master::query.h: name: h in: query @@ -1678,7 +1678,7 @@ components: cat.master::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1713,10 +1713,10 @@ components: cat.nodeattrs::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.nodeattrs::query.h: name: h in: query @@ -1747,7 +1747,7 @@ components: cat.nodeattrs::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1789,10 +1789,10 @@ components: cat.nodes::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.nodes::query.full_id: in: query name: full_id @@ -1836,7 +1836,7 @@ components: cat.nodes::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1877,10 +1877,10 @@ components: cat.pending_tasks::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.pending_tasks::query.h: name: h in: query @@ -1911,7 +1911,7 @@ components: cat.pending_tasks::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -1951,10 +1951,10 @@ components: cat.pit_segments::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.pit_segments::query.h: name: h in: query @@ -2003,10 +2003,10 @@ components: cat.plugins::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.plugins::query.h: name: h in: query @@ -2037,7 +2037,7 @@ components: cat.plugins::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2098,10 +2098,10 @@ components: cat.recovery::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.recovery::query.h: name: h in: query @@ -2167,10 +2167,10 @@ components: cat.repositories::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.repositories::query.h: name: h in: query @@ -2201,7 +2201,7 @@ components: cat.repositories::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2282,10 +2282,10 @@ components: cat.segment_replication::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.segment_replication::query.h: name: h in: query @@ -2400,10 +2400,10 @@ components: cat.segments::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.segments::query.h: name: h in: query @@ -2426,7 +2426,7 @@ components: cat.segments::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2479,10 +2479,10 @@ components: cat.shards::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.shards::query.h: name: h in: query @@ -2513,7 +2513,7 @@ components: cat.shards::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2566,10 +2566,10 @@ components: cat.snapshots::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.snapshots::query.h: name: h in: query @@ -2600,7 +2600,7 @@ components: cat.snapshots::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2651,10 +2651,10 @@ components: cat.tasks::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.tasks::query.h: name: h in: query @@ -2737,10 +2737,10 @@ components: cat.templates::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.templates::query.h: name: h in: query @@ -2771,7 +2771,7 @@ components: cat.templates::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -2816,10 +2816,10 @@ components: cat.thread_pool::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). cat.thread_pool::query.h: name: h in: query @@ -2850,7 +2850,7 @@ components: cat.thread_pool::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' diff --git a/spec/namespaces/cluster.yaml b/spec/namespaces/cluster.yaml index 30ac38284..61c103669 100644 --- a/spec/namespaces/cluster.yaml +++ b/spec/namespaces/cluster.yaml @@ -524,7 +524,7 @@ components: index: $ref: '../schemas/_common.yaml#/components/schemas/IndexName' primary: - description: If true, returns explanation for the primary shard for the given shard ID. + description: If `true`, returns explanation for the primary shard for the given shard ID. type: boolean shard: description: Specifies the ID of the shard that you would like an explanation for. @@ -802,7 +802,7 @@ components: cluster.allocation_explain::query.include_disk_info: in: query name: include_disk_info - description: If true, returns information about disk usage and shard sizes. + description: If `true`, returns information about disk usage and shard sizes. schema: type: boolean default: false @@ -810,7 +810,7 @@ components: cluster.allocation_explain::query.include_yes_decisions: in: query name: include_yes_decisions - description: If true, returns YES decisions in explanation. + description: If `true`, returns YES decisions in explanation. schema: type: boolean default: false @@ -836,14 +836,14 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager_timeout` instead. cluster.delete_component_template::query.timeout: in: query name: timeout @@ -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: @@ -888,8 +888,8 @@ components: in: query name: local description: |- - If true, the request retrieves information from the local node only. - Defaults to false, which means information is retrieved from the master node. + If `true`, the request retrieves information from the local node only. + Defaults to false, which means information is retrieved from the cluster-manager node. schema: type: boolean default: false @@ -898,7 +898,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. If no response is + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -929,7 +929,7 @@ components: name: local description: |- If `true`, the request retrieves information from the local node only. - If `false`, information is retrieved from the master node. + If `false`, information is retrieved from the cluster-manager node. schema: type: boolean default: false @@ -938,7 +938,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -981,7 +981,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -1045,7 +1045,7 @@ components: cluster.health::query.local: in: query name: local - description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + description: If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. schema: type: boolean default: false @@ -1053,7 +1053,7 @@ components: cluster.health::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -1123,7 +1123,7 @@ components: name: local description: |- If `true`, the request retrieves information from the local node only. - If `false`, information is retrieved from the master node. + If `false`, information is retrieved from the cluster-manager node. schema: type: boolean default: false @@ -1132,7 +1132,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -1201,7 +1201,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -1249,7 +1249,7 @@ components: cluster.put_settings::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -1281,21 +1281,21 @@ components: cluster.reroute::query.dry_run: in: query name: dry_run - description: If true, then the request simulates the operation only and returns the resulting state. + description: If `true`, then the request simulates the operation only and returns the resulting state. schema: type: boolean style: form cluster.reroute::query.explain: in: query name: explain - description: If true, then the response contains an explanation of why the commands can or cannot be executed. + description: If `true`, then the response contains an explanation of why the commands can or cannot be executed. schema: type: boolean style: form cluster.reroute::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -1316,7 +1316,7 @@ components: cluster.reroute::query.retry_failed: in: query name: retry_failed - description: If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. + description: If `true`, then retries allocation of shards that are blocked due to too many subsequent allocation failures. schema: type: boolean style: form diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml index a820e2621..159920447 100644 --- a/spec/namespaces/indices.yaml +++ b/spec/namespaces/indices.yaml @@ -2890,7 +2890,7 @@ components: x-version-added: '2.8' in: query name: file - description: If true, clears the unused entries from the file cache on nodes with the Search role. + description: If `true`, clears the unused entries from the file cache on nodes with the Search role. schema: type: boolean default: false @@ -2954,7 +2954,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -3041,7 +3041,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -3086,7 +3086,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -3189,7 +3189,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -3237,7 +3237,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -3280,7 +3280,7 @@ components: indices.delete_index_template::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -3315,7 +3315,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -3487,7 +3487,7 @@ components: indices.exists_index_template::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -3528,7 +3528,7 @@ components: indices.exists_template::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -3676,7 +3676,7 @@ components: in: query name: allow_no_indices description: |- - If false, the request returns an error if any wildcard expression, index alias, or _all value targets only + If `false`, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. schema: @@ -3703,7 +3703,7 @@ components: indices.get::query.flat_settings: in: query name: flat_settings - description: If true, returns settings in flat format. + description: If `true`, returns settings in flat format. schema: type: boolean default: false @@ -3711,7 +3711,7 @@ components: indices.get::query.ignore_unavailable: in: query name: ignore_unavailable - description: If false, requests that target a missing index return an error. + description: If `false`, requests that target a missing index return an error. schema: type: boolean default: false @@ -3719,7 +3719,7 @@ components: indices.get::query.include_defaults: in: query name: include_defaults - description: If true, return all default settings in the response. + description: If `true`, return all default settings in the response. schema: type: boolean default: false @@ -3727,7 +3727,7 @@ components: indices.get::query.local: in: query name: local - description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + description: If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. schema: type: boolean default: false @@ -3735,7 +3735,7 @@ components: indices.get::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -3888,7 +3888,7 @@ components: indices.get_index_template::query.flat_settings: in: query name: flat_settings - description: If true, returns settings in flat format. + description: If `true`, returns settings in flat format. schema: type: boolean default: false @@ -3896,7 +3896,7 @@ components: indices.get_index_template::query.local: in: query name: local - description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + description: If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node. schema: type: boolean default: false @@ -3904,7 +3904,7 @@ components: indices.get_index_template::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -3978,7 +3978,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -4062,7 +4062,7 @@ components: name: local description: |- If `true`, the request retrieves information from the local node only. If - `false`, information is retrieved from the master node. + `false`, information is retrieved from the cluster-manager node. schema: type: boolean default: false @@ -4071,7 +4071,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. If no response is + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -4118,7 +4118,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -4207,7 +4207,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -4281,7 +4281,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -4332,7 +4332,7 @@ components: indices.put_index_template::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to master node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -4384,7 +4384,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -4469,7 +4469,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. If no response is + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true @@ -4513,7 +4513,7 @@ components: indices.put_template::query.create: in: query name: create - description: If true, this request cannot replace or update existing index templates. + description: If `true`, this request cannot replace or update existing index templates. schema: type: boolean default: false @@ -4522,7 +4522,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. If no response is + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -4666,7 +4666,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -4750,7 +4750,7 @@ components: in: query name: allow_no_indices description: |- - If false, the request returns an error if any wildcard expression, index alias, or _all + If `false`, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. schema: @@ -4768,7 +4768,7 @@ components: indices.shard_stores::query.ignore_unavailable: in: query name: ignore_unavailable - description: If true, missing or closed indexes are not included in the response. + description: If `true`, missing or closed indexes are not included in the response. schema: type: boolean style: form @@ -4818,7 +4818,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -4899,7 +4899,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. If no response is received + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -4935,7 +4935,7 @@ components: indices.simulate_template::query.create: in: query name: create - description: If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. + description: If `true`, the template passed in the body is only used if no existing templates match the same index patterns. If `false`, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. schema: type: boolean default: false @@ -4943,7 +4943,7 @@ components: indices.simulate_template::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -4985,7 +4985,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -5080,7 +5080,7 @@ components: indices.stats::query.forbid_closed_indices: in: query name: forbid_closed_indices - description: If true, statistics are not collected from closed indexes. + description: If `true`, statistics are not collected from closed indexes. schema: type: boolean default: true @@ -5099,7 +5099,7 @@ components: indices.stats::query.include_segment_file_sizes: in: query name: include_segment_file_sizes - description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + description: If `true`, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). schema: type: boolean default: false @@ -5107,7 +5107,7 @@ components: indices.stats::query.include_unloaded_segments: in: query name: include_unloaded_segments - description: If true, the response includes information from segments that are not loaded into memory. + description: If `true`, the response includes information from segments that are not loaded into memory. schema: type: boolean default: false @@ -5130,7 +5130,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -5180,10 +5180,10 @@ components: indices.upgrade::query.only_ancient_segments: name: only_ancient_segments in: query - description: If true, only ancient (an older Lucene major release) segments will be upgraded. + description: If `true`, only ancient (an older Lucene major release) segments will be upgraded. schema: type: boolean - description: If true, only ancient (an older Lucene major release) segments will be upgraded. + description: If `true`, only ancient (an older Lucene major release) segments will be upgraded. indices.upgrade::query.wait_for_completion: x-version-added: '2.7' name: wait_for_completion diff --git a/spec/namespaces/ingest.yaml b/spec/namespaces/ingest.yaml index b1b550853..f5c55166a 100644 --- a/spec/namespaces/ingest.yaml +++ b/spec/namespaces/ingest.yaml @@ -243,7 +243,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -282,7 +282,7 @@ components: in: query name: master_timeout description: |- - Period to wait for a connection to the master node. + Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: @@ -308,7 +308,7 @@ components: ingest.put_pipeline::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' diff --git a/spec/namespaces/knn.yaml b/spec/namespaces/knn.yaml index 1a25c1a5d..37d03316b 100644 --- a/spec/namespaces/knn.yaml +++ b/spec/namespaces/knn.yaml @@ -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 @@ -477,10 +477,10 @@ components: knn.search_models::query.pre_filter_shard_size: name: pre_filter_shard_size in: query - description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method, that is if date filters are mandatory to match but the shard bounds and the query are disjoint. schema: type: integer - description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. + description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method, that is if date filters are mandatory to match but the shard bounds and the query are disjoint. format: int32 knn.search_models::query.preference: name: preference diff --git a/spec/namespaces/list.yaml b/spec/namespaces/list.yaml index b0dddcd86..efb5afc2d 100644 --- a/spec/namespaces/list.yaml +++ b/spec/namespaces/list.yaml @@ -290,7 +290,7 @@ components: list.indices::query.include_unloaded_segments: in: query name: include_unloaded_segments - description: If true, the response includes information from segments that are not loaded into memory. + description: If `true`, the response includes information from segments that are not loaded into memory. schema: type: boolean default: false @@ -306,7 +306,7 @@ components: list.indices::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to cluster manager node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' @@ -315,7 +315,7 @@ components: list.indices::query.pri: in: query name: pri - description: If true, the response only includes information from primary shards. + description: If `true`, the response only includes information from primary shards. schema: type: boolean default: false @@ -431,7 +431,7 @@ components: list.shards::query.master_timeout: name: master_timeout in: query - description: Operation timeout for connection to cluster manager node. + description: Operation timeout for connection to cluster-manager node. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' x-version-deprecated: '2.0' diff --git a/spec/namespaces/nodes.yaml b/spec/namespaces/nodes.yaml index 37b49cf1b..e48171410 100644 --- a/spec/namespaces/nodes.yaml +++ b/spec/namespaces/nodes.yaml @@ -474,7 +474,7 @@ components: nodes.info::query.flat_settings: in: query name: flat_settings - description: If true, returns settings in flat format. + description: If `true`, returns settings in flat format. schema: type: boolean default: false @@ -564,7 +564,7 @@ components: nodes.stats::query.include_segment_file_sizes: in: query name: include_segment_file_sizes - description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + description: If `true`, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). schema: type: boolean default: false diff --git a/spec/namespaces/ppl.yaml b/spec/namespaces/ppl.yaml index 02ef9e2bb..13741e007 100644 --- a/spec/namespaces/ppl.yaml +++ b/spec/namespaces/ppl.yaml @@ -70,7 +70,7 @@ components: ppl.query::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string ppl.query::query.sanitize: @@ -83,7 +83,7 @@ components: ppl.explain::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string ppl.explain::query.sanitize: @@ -96,7 +96,7 @@ components: ppl.get_stats::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string ppl.get_stats::query.sanitize: @@ -109,7 +109,7 @@ components: ppl.post_stats::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string ppl.post_stats::query.sanitize: diff --git a/spec/namespaces/query.yaml b/spec/namespaces/query.yaml index b055f4666..d2e76ba27 100644 --- a/spec/namespaces/query.yaml +++ b/spec/namespaces/query.yaml @@ -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: diff --git a/spec/namespaces/snapshot.yaml b/spec/namespaces/snapshot.yaml index b24c49466..af430968f 100644 --- a/spec/namespaces/snapshot.yaml +++ b/spec/namespaces/snapshot.yaml @@ -475,7 +475,7 @@ components: snapshot.cleanup_repository::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. + description: Period to wait for a connection to the cluster-manager node. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -523,7 +523,7 @@ components: snapshot.clone::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -556,7 +556,7 @@ components: snapshot.create::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -589,7 +589,7 @@ components: snapshot.create_repository::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -636,7 +636,7 @@ components: snapshot.delete::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -661,7 +661,7 @@ components: snapshot.delete_repository::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -704,7 +704,7 @@ components: snapshot.get::query.ignore_unavailable: in: query name: ignore_unavailable - description: If false, the request returns an error for any snapshots that are unavailable. + description: If `false`, the request returns an error for any snapshots that are unavailable. schema: type: boolean default: false @@ -712,7 +712,7 @@ components: snapshot.get::query.master_timeout: in: query name: master_timeout - description: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + description: Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -722,7 +722,7 @@ components: snapshot.get::query.verbose: in: query name: verbose - description: If true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + description: If `true`, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. schema: type: boolean style: form @@ -752,7 +752,7 @@ components: snapshot.get_repository::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -785,7 +785,7 @@ components: snapshot.restore::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -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 @@ -834,7 +834,7 @@ components: snapshot.status::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' @@ -859,7 +859,7 @@ components: snapshot.verify_repository::query.master_timeout: in: query name: master_timeout - description: Explicit operation timeout for connection to master node + description: Explicit operation timeout for connection to cluster-manager node deprecated: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' diff --git a/spec/namespaces/sql.yaml b/spec/namespaces/sql.yaml index 053ebead0..cfb41a967 100644 --- a/spec/namespaces/sql.yaml +++ b/spec/namespaces/sql.yaml @@ -101,13 +101,13 @@ components: sql.settings::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string sql.query::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string sql.query::query.sanitize: @@ -120,7 +120,7 @@ components: sql.explain::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string sql.explain::query.sanitize: @@ -133,7 +133,7 @@ components: sql.close::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string sql.close::query.sanitize: @@ -146,7 +146,7 @@ components: sql.get_stats::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string sql.get_stats::query.sanitize: @@ -159,7 +159,7 @@ components: sql.post_stats::query.format: name: format in: query - description: A short version of the Accept header, e.g. json, yaml. + description: A short version of the Accept header (for example, `json`, `yaml`). schema: type: string sql.post_stats::query.sanitize: diff --git a/spec/schemas/_common.aggregations.yaml b/spec/schemas/_common.aggregations.yaml index 2e64a19a6..c3624ac0b 100644 --- a/spec/schemas/_common.aggregations.yaml +++ b/spec/schemas/_common.aggregations.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _common.aggregations category - description: Schemas of _common.aggregations category + title: Schemas of `_common.aggregations` Category + description: Schemas of `_common.aggregations` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_common.analysis.yaml b/spec/schemas/_common.analysis.yaml index 07be175e7..fb332dffe 100644 --- a/spec/schemas/_common.analysis.yaml +++ b/spec/schemas/_common.analysis.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _common.analysis category - description: Schemas of _common.analysis category + title: Schemas of `_common.analysis` Category + description: Schemas of `_common.analysis` category. version: 1.0.0 paths: {} components: @@ -78,7 +78,7 @@ components: - type StopWords: description: |- - Language value, such as _arabic_ or _thai_. Defaults to _english_. + Language value, such as `arabic` or `thai`. Defaults to `english`. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by language for supported language values and their stop words. Also accepts an array of stop words. oneOf: diff --git a/spec/schemas/_common.mapping.yaml b/spec/schemas/_common.mapping.yaml index 12087d9ed..771955942 100644 --- a/spec/schemas/_common.mapping.yaml +++ b/spec/schemas/_common.mapping.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _common.mapping category - description: Schemas of _common.mapping category + title: Schemas of `_common.mapping` Category + description: Schemas of `_common.mapping` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_common.query_dsl.yaml b/spec/schemas/_common.query_dsl.yaml index e1e05cb42..45c744694 100644 --- a/spec/schemas/_common.query_dsl.yaml +++ b/spec/schemas/_common.query_dsl.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _common.query_dsl category - description: Schemas of _common.query_dsl category + title: Schemas of `_common.query_dsl` Category + description: Schemas of `_common.query_dsl` category. version: 1.0.0 paths: {} components: @@ -343,7 +343,7 @@ components: The `combined_fields` query analyzes the provided text before performing a search. type: string auto_generate_synonyms_phrase_query: - description: If true, match phrase queries are automatically created for multi-term synonyms. + description: If `true`, match phrase queries are automatically created for multi-term synonyms. type: boolean operator: $ref: '#/components/schemas/CombinedFieldsOperator' @@ -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' diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml index 229bdc970..7d9eb916a 100644 --- a/spec/schemas/_common.yaml +++ b/spec/schemas/_common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _common category - description: Schemas of _common category + title: Schemas of `_common` Category + description: Schemas of `_common` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core._common.yaml b/spec/schemas/_core._common.yaml index adb685ea9..4b1690c7e 100644 --- a/spec/schemas/_core._common.yaml +++ b/spec/schemas/_core._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core._common category - description: Schemas of _core._common category + title: Schemas of `_core._common` Category + description: Schemas of `_core._common` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.bulk.yaml b/spec/schemas/_core.bulk.yaml index 92e0a9200..6edfe319f 100644 --- a/spec/schemas/_core.bulk.yaml +++ b/spec/schemas/_core.bulk.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.bulk category - description: Schemas of _core.bulk category + title: Schemas of `_core.bulk` Category + description: Schemas of `_core.bulk` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.explain.yaml b/spec/schemas/_core.explain.yaml index f1e354551..5a3838a09 100644 --- a/spec/schemas/_core.explain.yaml +++ b/spec/schemas/_core.explain.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.explain category - description: Schemas of _core.explain category + title: Schemas of `_core.explain` Category + description: Schemas of `_core.explain` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.field_caps.yaml b/spec/schemas/_core.field_caps.yaml index 67d8b308c..3a0d4a589 100644 --- a/spec/schemas/_core.field_caps.yaml +++ b/spec/schemas/_core.field_caps.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.field_caps category - description: Schemas of _core.field_caps category + title: Schemas of `_core.field_caps` Category + description: Schemas of `_core.field_caps` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.get.yaml b/spec/schemas/_core.get.yaml index 42f70ce2a..616b6f42f 100644 --- a/spec/schemas/_core.get.yaml +++ b/spec/schemas/_core.get.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.get category - description: Schemas of _core.get category + title: Schemas of `_core.get` Category + description: Schemas of `_core.get` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.get_script_context.yaml b/spec/schemas/_core.get_script_context.yaml index c71c99689..f59ae4cb2 100644 --- a/spec/schemas/_core.get_script_context.yaml +++ b/spec/schemas/_core.get_script_context.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.get_script_context category - description: Schemas of _core.get_script_context category + title: Schemas of `_core.get_script_context` Category + description: Schemas of `_core.get_script_context` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.get_script_languages.yaml b/spec/schemas/_core.get_script_languages.yaml index 698c2490e..752c5ee9e 100644 --- a/spec/schemas/_core.get_script_languages.yaml +++ b/spec/schemas/_core.get_script_languages.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.get_script_languages category - description: Schemas of _core.get_script_languages category + title: Schemas of `_core.get_script_languages` Category + description: Schemas of `_core.get_script_languages` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.mget.yaml b/spec/schemas/_core.mget.yaml index b75afa420..5543e9adb 100644 --- a/spec/schemas/_core.mget.yaml +++ b/spec/schemas/_core.mget.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.mget category - description: Schemas of _core.mget category + title: Schemas of `_core.mget` Category + description: Schemas of `_core.mget` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.msearch.yaml b/spec/schemas/_core.msearch.yaml index 04405f280..f6a370454 100644 --- a/spec/schemas/_core.msearch.yaml +++ b/spec/schemas/_core.msearch.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.msearch category - description: Schemas of _core.msearch category + title: Schemas of `_core.msearch` Category + description: Schemas of `_core.msearch` category. version: 1.0.0 paths: {} components: @@ -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 diff --git a/spec/schemas/_core.msearch_template.yaml b/spec/schemas/_core.msearch_template.yaml index 762874379..f9e164e84 100644 --- a/spec/schemas/_core.msearch_template.yaml +++ b/spec/schemas/_core.msearch_template.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.msearch_template category - description: Schemas of _core.msearch_template category + title: Schemas of `_core.msearch_template` Category + description: Schemas of `_core.msearch_template` category. version: 1.0.0 paths: {} components: @@ -31,7 +31,7 @@ components: type: boolean source: description: |- - An inline search template that supports the same parameters as the Search API's + An inline search template that supports the same parameters as the Search API request body and Mustache variables. If no `id` is specified, this parameter is required. type: string diff --git a/spec/schemas/_core.mtermvectors.yaml b/spec/schemas/_core.mtermvectors.yaml index e130a31f5..deae8eda6 100644 --- a/spec/schemas/_core.mtermvectors.yaml +++ b/spec/schemas/_core.mtermvectors.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.mtermvectors category - description: Schemas of _core.mtermvectors category + title: Schemas of `_core.mtermvectors` Category + description: Schemas of `_core.mtermvectors` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.rank_eval.yaml b/spec/schemas/_core.rank_eval.yaml index 404d09c3f..872689551 100644 --- a/spec/schemas/_core.rank_eval.yaml +++ b/spec/schemas/_core.rank_eval.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.rank_eval category - description: Schemas of _core.rank_eval category + title: Schemas of `_core.rank_eval` Category + description: Schemas of `_core.rank_eval` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.reindex.yaml b/spec/schemas/_core.reindex.yaml index eaa2c1579..34fdbe13e 100644 --- a/spec/schemas/_core.reindex.yaml +++ b/spec/schemas/_core.reindex.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.reindex category - description: Schemas of _core.reindex category + title: Schemas of `_core.reindex` Category + description: Schemas of `_core.reindex` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.reindex_rethrottle.yaml b/spec/schemas/_core.reindex_rethrottle.yaml index 6275fef00..877dc024c 100644 --- a/spec/schemas/_core.reindex_rethrottle.yaml +++ b/spec/schemas/_core.reindex_rethrottle.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.reindex_rethrottle category - description: Schemas of _core.reindex_rethrottle category + title: Schemas of `_core.reindex_rethrottle` Category + description: Schemas of `_core.reindex_rethrottle` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.scripts_painless_execute.yaml b/spec/schemas/_core.scripts_painless_execute.yaml index 8aca44805..a913914a0 100644 --- a/spec/schemas/_core.scripts_painless_execute.yaml +++ b/spec/schemas/_core.scripts_painless_execute.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.scripts_painless_execute category - description: Schemas of _core.scripts_painless_execute category + title: Schemas of `_core.scripts_painless_execute` Category + description: Schemas of `_core.scripts_painless_execute` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.search.yaml b/spec/schemas/_core.search.yaml index ab84bebc0..29c753ed8 100644 --- a/spec/schemas/_core.search.yaml +++ b/spec/schemas/_core.search.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.search category - description: Schemas of _core.search category + title: Schemas of `_core.search` Category + description: Schemas of `_core.search` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.search_shards.yaml b/spec/schemas/_core.search_shards.yaml index ad83a3f18..33a85d3f8 100644 --- a/spec/schemas/_core.search_shards.yaml +++ b/spec/schemas/_core.search_shards.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.search_shards category - description: Schemas of _core.search_shards category + title: Schemas of `_core.search_shards` Category + description: Schemas of `_core.search_shards` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.termvectors.yaml b/spec/schemas/_core.termvectors.yaml index d7a309b9a..1b6d0a8c8 100644 --- a/spec/schemas/_core.termvectors.yaml +++ b/spec/schemas/_core.termvectors.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.termvectors category - description: Schemas of _core.termvectors category + title: Schemas of `_core.termvectors` Category + description: Schemas of `_core.termvectors` category. version: 1.0.0 paths: {} components: @@ -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: @@ -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 diff --git a/spec/schemas/_core.update.yaml b/spec/schemas/_core.update.yaml index f6a346c7e..6e6fc1436 100644 --- a/spec/schemas/_core.update.yaml +++ b/spec/schemas/_core.update.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.update category - description: Schemas of _core.update category + title: Schemas of `_core.update` Category + description: Schemas of `_core.update` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/_core.update_by_query_rethrottle.yaml b/spec/schemas/_core.update_by_query_rethrottle.yaml index c91fc4c57..f30fbf125 100644 --- a/spec/schemas/_core.update_by_query_rethrottle.yaml +++ b/spec/schemas/_core.update_by_query_rethrottle.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _core.update_by_query_rethrottle category - description: Schemas of _core.update_by_query_rethrottle category + title: Schemas of `_core.update_by_query_rethrottle` Category + description: Schemas of `_core.update_by_query_rethrottle` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/asynchronous_search._common.yaml b/spec/schemas/asynchronous_search._common.yaml index f103db5bd..dea304c3f 100644 --- a/spec/schemas/asynchronous_search._common.yaml +++ b/spec/schemas/asynchronous_search._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of asynchronous_search._common category - description: Schemas of asynchronous_search._common category + title: Schemas of `asynchronous_search._common` Category + description: Schemas of `asynchronous_search._common` category. version: 1.0.0 paths: {} components: @@ -48,7 +48,7 @@ components: collapse: $ref: '_core.search.yaml#/components/schemas/FieldCollapse' explain: - description: If true, returns detailed information about score computation as part of a hit. + description: If `true`, returns detailed information about score computation as part of a hit. type: boolean ext: description: Configuration of search extensions defined by OpenSearch plugins. @@ -143,10 +143,10 @@ components: Defaults to no timeout. type: string track_scores: - description: If true, calculate and return document scores, even if the scores are not used for sorting. + description: If `true`, calculate and return document scores, even if the scores are not used for sorting. type: boolean version: - description: If true, returns document version as part of a hit. + description: If `true`, returns document version as part of a hit. type: boolean seq_no_primary_term: description: If `true`, returns sequence number and primary term of the last modification of each hit. diff --git a/spec/schemas/cat._common.yaml b/spec/schemas/cat._common.yaml index 0eeda5f43..0c7df33ca 100644 --- a/spec/schemas/cat._common.yaml +++ b/spec/schemas/cat._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat._common category - description: Schemas of cat._common category + title: Schemas of `cat._common` Category + description: Schemas of `cat._common` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.aliases.yaml b/spec/schemas/cat.aliases.yaml index c8edd85d0..6fb15a7b4 100644 --- a/spec/schemas/cat.aliases.yaml +++ b/spec/schemas/cat.aliases.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.aliases category - description: Schemas of cat.aliases category + title: Schemas of `cat.aliases` Category + description: Schemas of `cat.aliases` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.allocation.yaml b/spec/schemas/cat.allocation.yaml index 6b499fb89..3a6ab6355 100644 --- a/spec/schemas/cat.allocation.yaml +++ b/spec/schemas/cat.allocation.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.allocation category - description: Schemas of cat.allocation category + title: Schemas of `cat.allocation` Category + description: Schemas of `cat.allocation` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.cluster_manager.yaml b/spec/schemas/cat.cluster_manager.yaml index 5b04fc472..c9d93847e 100644 --- a/spec/schemas/cat.cluster_manager.yaml +++ b/spec/schemas/cat.cluster_manager.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.cluster_manager category - description: Schemas of cat.cluster_manager category + title: Schemas of `cat.cluster_manager` Category + description: Schemas of `cat.cluster_manager` category. version: 1.0.0 paths: {} components: @@ -13,10 +13,10 @@ components: description: node id type: string host: - description: host name + description: hostname type: string ip: - description: ip address + description: IP address type: string node: description: node name diff --git a/spec/schemas/cat.count.yaml b/spec/schemas/cat.count.yaml index 97488a627..4d1904166 100644 --- a/spec/schemas/cat.count.yaml +++ b/spec/schemas/cat.count.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.count category - description: Schemas of cat.count category + title: Schemas of `cat.count` Category + description: Schemas of `cat.count` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.fielddata.yaml b/spec/schemas/cat.fielddata.yaml index 94dee473f..af3318a04 100644 --- a/spec/schemas/cat.fielddata.yaml +++ b/spec/schemas/cat.fielddata.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.fielddata category - description: Schemas of cat.fielddata category + title: Schemas of `cat.fielddata` Category + description: Schemas of `cat.fielddata` category. version: 1.0.0 paths: {} components: @@ -13,7 +13,7 @@ components: description: node id type: string host: - description: host name + description: hostname type: string ip: description: ip address diff --git a/spec/schemas/cat.health.yaml b/spec/schemas/cat.health.yaml index d0b61ad0d..c73f375eb 100644 --- a/spec/schemas/cat.health.yaml +++ b/spec/schemas/cat.health.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.health category - description: Schemas of cat.health category + title: Schemas of `cat.health` Category + description: Schemas of `cat.health` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.indices.yaml b/spec/schemas/cat.indices.yaml index 803253ad0..2ff16ab12 100644 --- a/spec/schemas/cat.indices.yaml +++ b/spec/schemas/cat.indices.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.indices category - description: Schemas of cat.indices category + title: Schemas of `cat.indices` Category + description: Schemas of `cat.indices` category. version: 1.0.0 paths: {} components: @@ -19,7 +19,7 @@ components: description: index name type: string uuid: - description: index uuid + description: index UUID type: string pri: description: number of primary shards @@ -40,7 +40,7 @@ components: description: index creation date (as string) type: string store.size: - description: store size of primaries & replicas + description: store size of primaries and replicas type: ['null', string] pri.store.size: description: store size of primaries @@ -52,16 +52,16 @@ components: description: size of completion type: ['null', string] fielddata.memory_size: - description: used fielddata cache + description: used field data cache type: ['null', string] pri.fielddata.memory_size: - description: used fielddata cache + description: used field data cache type: ['null', string] fielddata.evictions: - description: fielddata evictions + description: field data evictions type: ['null', string] pri.fielddata.evictions: - description: fielddata evictions + description: field data evictions type: ['null', string] query_cache.memory_size: description: used query cache @@ -380,10 +380,10 @@ components: description: memory used by version map type: ['null', string] segments.fixed_bitset_memory: - description: memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields + description: memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields type: ['null', string] pri.segments.fixed_bitset_memory: - description: memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields + description: memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields type: ['null', string] warmer.current: description: current warmer ops diff --git a/spec/schemas/cat.master.yaml b/spec/schemas/cat.master.yaml index 3dd491d16..a583b8102 100644 --- a/spec/schemas/cat.master.yaml +++ b/spec/schemas/cat.master.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.master category - description: Schemas of cat.master category + title: Schemas of `cat.master` Category + description: Schemas of `cat.master` category. version: 1.0.0 paths: {} components: @@ -13,10 +13,10 @@ components: description: node id type: string host: - description: host name + description: hostname type: string ip: - description: ip address + description: IP address type: string node: description: node name diff --git a/spec/schemas/cat.nodeattrs.yaml b/spec/schemas/cat.nodeattrs.yaml index 81506fc69..aa59f4246 100644 --- a/spec/schemas/cat.nodeattrs.yaml +++ b/spec/schemas/cat.nodeattrs.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.nodeattrs category - description: Schemas of cat.nodeattrs category + title: Schemas of `cat.nodeattrs` Category + description: Schemas of `cat.nodeattrs` category. version: 1.0.0 paths: {} components: @@ -19,7 +19,7 @@ components: description: The process identifier. type: string host: - description: The host name. + description: The hostname. type: string ip: description: The IP address. diff --git a/spec/schemas/cat.nodes.yaml b/spec/schemas/cat.nodes.yaml index 7187d5c14..a3c578578 100644 --- a/spec/schemas/cat.nodes.yaml +++ b/spec/schemas/cat.nodes.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.nodes category - description: Schemas of cat.nodes category + title: Schemas of `cat.nodes` Category + description: Schemas of `cat.nodes` category. version: 1.0.0 paths: {} components: @@ -101,7 +101,7 @@ components: type: string master: description: |- - Indicates whether the node is the elected master node. + Indicates whether the node is the elected cluster-manager node. Returned values include `*`(elected master) and `-`(not elected master). type: string x-version-deprecated: '2.0' @@ -291,7 +291,7 @@ components: description: The memory used by the version map. type: string segments.fixed_bitset_memory: - description: The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields. + description: The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields. type: string suggest.current: description: The number of current suggest operations. diff --git a/spec/schemas/cat.pending_tasks.yaml b/spec/schemas/cat.pending_tasks.yaml index 41e982935..86ddffbae 100644 --- a/spec/schemas/cat.pending_tasks.yaml +++ b/spec/schemas/cat.pending_tasks.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.pending_tasks category - description: Schemas of cat.pending_tasks category + title: Schemas of `cat.pending_tasks` Category + description: Schemas of `cat.pending_tasks` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.plugins.yaml b/spec/schemas/cat.plugins.yaml index 3e470dff0..4d64aa9b6 100644 --- a/spec/schemas/cat.plugins.yaml +++ b/spec/schemas/cat.plugins.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.plugins category - description: Schemas of cat.plugins category + title: Schemas of `cat.plugins` Category + description: Schemas of `cat.plugins` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.recovery.yaml b/spec/schemas/cat.recovery.yaml index 947dab27a..f4ab2be99 100644 --- a/spec/schemas/cat.recovery.yaml +++ b/spec/schemas/cat.recovery.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.recovery category - description: Schemas of cat.recovery category + title: Schemas of `cat.recovery` Category + description: Schemas of `cat.recovery` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.repositories.yaml b/spec/schemas/cat.repositories.yaml index c7163972d..78b5fa33f 100644 --- a/spec/schemas/cat.repositories.yaml +++ b/spec/schemas/cat.repositories.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.repositories category - description: Schemas of cat.repositories category + title: Schemas of `cat.repositories` Category + description: Schemas of `cat.repositories` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.segments.yaml b/spec/schemas/cat.segments.yaml index b0a119457..348740b32 100644 --- a/spec/schemas/cat.segments.yaml +++ b/spec/schemas/cat.segments.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.segments category - description: Schemas of cat.segments category + title: Schemas of `cat.segments` Category + description: Schemas of `cat.segments` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.shards.yaml b/spec/schemas/cat.shards.yaml index 312faf725..8d187d8be 100644 --- a/spec/schemas/cat.shards.yaml +++ b/spec/schemas/cat.shards.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.shards category - description: Schemas of cat.shards category + title: Schemas of `cat.shards` Category + description: Schemas of `cat.shards` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.snapshots.yaml b/spec/schemas/cat.snapshots.yaml index df5b3acd9..a13d3a29a 100644 --- a/spec/schemas/cat.snapshots.yaml +++ b/spec/schemas/cat.snapshots.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.snapshots category - description: Schemas of cat.snapshots category + title: Schemas of `cat.snapshots` Category + description: Schemas of `cat.snapshots` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.tasks.yaml b/spec/schemas/cat.tasks.yaml index ce54f2c51..52bdde9f3 100644 --- a/spec/schemas/cat.tasks.yaml +++ b/spec/schemas/cat.tasks.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.tasks category - description: Schemas of cat.tasks category + title: Schemas of `cat.tasks` Category + description: Schemas of `cat.tasks` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.templates.yaml b/spec/schemas/cat.templates.yaml index ebc269250..734f2c0b2 100644 --- a/spec/schemas/cat.templates.yaml +++ b/spec/schemas/cat.templates.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.templates category - description: Schemas of cat.templates category + title: Schemas of `cat.templates` Category + description: Schemas of `cat.templates` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cat.thread_pool.yaml b/spec/schemas/cat.thread_pool.yaml index 510c5ba22..23fdc8e18 100644 --- a/spec/schemas/cat.thread_pool.yaml +++ b/spec/schemas/cat.thread_pool.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cat.thread_pool category - description: Schemas of cat.thread_pool category + title: Schemas of `cat.thread_pool` Category + description: Schemas of `cat.thread_pool` category. version: 1.0.0 paths: {} components: @@ -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. diff --git a/spec/schemas/cluster._common.yaml b/spec/schemas/cluster._common.yaml index b70f69ce7..9c42b0948 100644 --- a/spec/schemas/cluster._common.yaml +++ b/spec/schemas/cluster._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cluster._common category - description: Schemas of cluster._common category + title: Schemas of `cluster._common` Category + description: Schemas of `cluster._common` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cluster.allocation_explain.yaml b/spec/schemas/cluster.allocation_explain.yaml index 97b36f6ef..f90f94d7d 100644 --- a/spec/schemas/cluster.allocation_explain.yaml +++ b/spec/schemas/cluster.allocation_explain.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cluster.allocation_explain category - description: Schemas of cluster.allocation_explain category + title: Schemas of `cluster.allocation_explain` Category + description: Schemas of `cluster.allocation_explain` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cluster.health.yaml b/spec/schemas/cluster.health.yaml index 3af259176..c62ccbb37 100644 --- a/spec/schemas/cluster.health.yaml +++ b/spec/schemas/cluster.health.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cluster.health category - description: Schemas of cluster.health category + title: Schemas of `cluster.health` Category + description: Schemas of `cluster.health` category. version: 1.0.0 paths: {} components: @@ -31,11 +31,11 @@ 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: - description: True if the cluster manager node has been discovered. + description: True if the cluster-manager node has been discovered. type: boolean x-version-added: '2.0' indices: @@ -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. diff --git a/spec/schemas/cluster.pending_tasks.yaml b/spec/schemas/cluster.pending_tasks.yaml index be221e8e3..efe552281 100644 --- a/spec/schemas/cluster.pending_tasks.yaml +++ b/spec/schemas/cluster.pending_tasks.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cluster.pending_tasks category - description: Schemas of cluster.pending_tasks category + title: Schemas of `cluster.pending_tasks` Category + description: Schemas of `cluster.pending_tasks` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cluster.remote_info.yaml b/spec/schemas/cluster.remote_info.yaml index d0fb00ac5..a92160bc8 100644 --- a/spec/schemas/cluster.remote_info.yaml +++ b/spec/schemas/cluster.remote_info.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cluster.remote_info category - description: Schemas of cluster.remote_info category + title: Schemas of `cluster.remote_info` Category + description: Schemas of `cluster.remote_info` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cluster.reroute.yaml b/spec/schemas/cluster.reroute.yaml index 2e569fae8..55ac62278 100644 --- a/spec/schemas/cluster.reroute.yaml +++ b/spec/schemas/cluster.reroute.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cluster.reroute category - description: Schemas of cluster.reroute category + title: Schemas of `cluster.reroute` Category + description: Schemas of `cluster.reroute` category. version: 1.0.0 paths: {} components: @@ -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 diff --git a/spec/schemas/cluster.state.yaml b/spec/schemas/cluster.state.yaml index 9b02836dc..fc0149a1b 100644 --- a/spec/schemas/cluster.state.yaml +++ b/spec/schemas/cluster.state.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cluster.state category - description: Schemas of cluster.state category + title: Schemas of `cluster.state` Category + description: Schemas of `cluster.state` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/cluster.stats.yaml b/spec/schemas/cluster.stats.yaml index 34f983c14..70cab97e5 100644 --- a/spec/schemas/cluster.stats.yaml +++ b/spec/schemas/cluster.stats.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of cluster.stats category - description: Schemas of cluster.stats category + title: Schemas of `cluster.stats` Category + description: Schemas of `cluster.stats` category. version: 1.0.0 paths: {} components: @@ -122,13 +122,13 @@ components: description: The number of indexes containing the field type in selected nodes. type: number indexed_vector_count: - description: For dense_vector field types, number of indexed vector types in selected nodes. + description: For `dense_vector` field types, number of indexed vector types in selected nodes. type: number indexed_vector_dim_max: - description: For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes. + description: For `dense_vector` field types, the maximum dimension of all indexed vector types in selected nodes. type: number indexed_vector_dim_min: - description: For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes. + description: For `dense_vector` field types, the minimum dimension of all indexed vector types in selected nodes. type: number script_count: description: The number of fields that declare a script. @@ -189,7 +189,7 @@ components: items: $ref: '#/components/schemas/FieldTypes' total_field_count: - description: Total number of fields in all non-system indices. + description: Total number of fields in all non-system indexes. type: number total_deduplicated_field_count: description: Total number of fields in all non-system indexes, accounting for mapping deduplication. diff --git a/spec/schemas/dangling_indices.list_dangling_indices.yaml b/spec/schemas/dangling_indices.list_dangling_indices.yaml index a9f3a42cd..552bf607e 100644 --- a/spec/schemas/dangling_indices.list_dangling_indices.yaml +++ b/spec/schemas/dangling_indices.list_dangling_indices.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of dangling_indices.list_dangling_indices category - description: Schemas of dangling_indices.list_dangling_indices category + title: Schemas of `dangling_indices.list_dangling_indices` Category + description: Schemas of `dangling_indices.list_dangling_indices` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/flow_framework.common.yaml b/spec/schemas/flow_framework.common.yaml index 2c3678921..d31caa059 100644 --- a/spec/schemas/flow_framework.common.yaml +++ b/spec/schemas/flow_framework.common.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: - title: Schemas of flow_framework.common category - description: Schemas of flow_framework.common category + title: Schemas of `flow_framework.common` Category + description: Schemas of `flow_framework.common` category. version: 1.0.0 paths: { } components: @@ -56,7 +56,7 @@ components: $ref: '#/components/schemas/version' workflows: type: object - description: A map of workflows. Presently, only the provision key is supported. The value for the workflow key is a key-value map that includes fields for user_params and lists of nodes and edges. + description: A map of workflows. Presently, only the provision key is supported. The value for the workflow key is a key-value map that includes fields for `user_params` and lists of nodes and edges. required: - name FlowFrameworkUpdate: diff --git a/spec/schemas/flow_framework.errors.yaml b/spec/schemas/flow_framework.errors.yaml index c91ed0e1d..1ca8965af 100644 --- a/spec/schemas/flow_framework.errors.yaml +++ b/spec/schemas/flow_framework.errors.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of flow_framework._errors category - description: Schemas of flow_framework._errors category + title: Schemas of `flow_framework._errors` Category + description: Schemas of `flow_framework._errors` category. version: 1.0.0 paths: {} components: @@ -156,8 +156,8 @@ components: properties: error: type: string - description: Describes the resources that require the allow_delete parameter for deprovisioning - # example: These resources require the allow_delete parameter to deprovision [index_name my-index]. + description: Describes the resources that require the `allow_delete` parameter for deprovisioning + # example: These resources require the `allow_delete` parameter to deprovision [index_name my-index]. required: - error RequestTimeoutError: diff --git a/spec/schemas/indices._common.yaml b/spec/schemas/indices._common.yaml index 0041d7d7f..c1b6940a4 100644 --- a/spec/schemas/indices._common.yaml +++ b/spec/schemas/indices._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices._common category - description: Schemas of indices._common category + title: Schemas of `indices._common` Category + description: Schemas of `indices._common` category. version: 1.0.0 paths: {} components: @@ -375,8 +375,8 @@ 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 - for its phase transitions. The index name must match the pattern ^.*-{date_format}-\\d+, where the date_format is + 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. type: boolean @@ -941,10 +941,10 @@ components: type: object properties: hidden: - description: If true, the data stream is hidden. + description: If `true`, the data stream is hidden. type: boolean allow_custom_routing: - description: If true, the data stream supports custom routing. + description: If `true`, the data stream supports custom routing. type: boolean timestamp_field: $ref: '#/components/schemas/DataStreamTimestampField' diff --git a/spec/schemas/indices.add_block.yaml b/spec/schemas/indices.add_block.yaml index 7fdc4bb9f..b16c97623 100644 --- a/spec/schemas/indices.add_block.yaml +++ b/spec/schemas/indices.add_block.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.add_block category - description: Schemas of indices.add_block category + title: Schemas of `indices.add_block` Category + description: Schemas of `indices.add_block` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.analyze.yaml b/spec/schemas/indices.analyze.yaml index bd1492d8f..fb9b0d49e 100644 --- a/spec/schemas/indices.analyze.yaml +++ b/spec/schemas/indices.analyze.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.analyze category - description: Schemas of indices.analyze category + title: Schemas of `indices.analyze` Category + description: Schemas of `indices.analyze` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.close.yaml b/spec/schemas/indices.close.yaml index d1ba7f4c1..72ad6c07a 100644 --- a/spec/schemas/indices.close.yaml +++ b/spec/schemas/indices.close.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.close category - description: Schemas of indices.close category + title: Schemas of `indices.close` Category + description: Schemas of `indices.close` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.data_streams_stats.yaml b/spec/schemas/indices.data_streams_stats.yaml index db7a59a39..216fa77ea 100644 --- a/spec/schemas/indices.data_streams_stats.yaml +++ b/spec/schemas/indices.data_streams_stats.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.data_streams_stats category - description: Schemas of indices.data_streams_stats category + title: Schemas of `indices.data_streams_stats` Category + description: Schemas of `indices.data_streams_stats` category. version: 1.0.0 paths: {} components: @@ -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 diff --git a/spec/schemas/indices.get_alias.yaml b/spec/schemas/indices.get_alias.yaml index 50aa52f73..f77de3af5 100644 --- a/spec/schemas/indices.get_alias.yaml +++ b/spec/schemas/indices.get_alias.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.get_alias category - description: Schemas of indices.get_alias category + title: Schemas of `indices.get_alias` Category + description: Schemas of `indices.get_alias` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.get_field_mapping.yaml b/spec/schemas/indices.get_field_mapping.yaml index 24f11fd2a..73af373b8 100644 --- a/spec/schemas/indices.get_field_mapping.yaml +++ b/spec/schemas/indices.get_field_mapping.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.get_field_mapping category - description: Schemas of indices.get_field_mapping category + title: Schemas of `indices.get_field_mapping` Category + description: Schemas of `indices.get_field_mapping` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.get_index_template.yaml b/spec/schemas/indices.get_index_template.yaml index 41baff1f4..43e1688ee 100644 --- a/spec/schemas/indices.get_index_template.yaml +++ b/spec/schemas/indices.get_index_template.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.get_index_template category - description: Schemas of indices.get_index_template category + title: Schemas of `indices.get_index_template` Category + description: Schemas of `indices.get_index_template` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.get_mapping.yaml b/spec/schemas/indices.get_mapping.yaml index 4ba669fe4..b63e4be56 100644 --- a/spec/schemas/indices.get_mapping.yaml +++ b/spec/schemas/indices.get_mapping.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.get_mapping category - description: Schemas of indices.get_mapping category + title: Schemas of `indices.get_mapping` Category + description: Schemas of `indices.get_mapping` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.put_index_template.yaml b/spec/schemas/indices.put_index_template.yaml index e8383c2b2..57d1d82f3 100644 --- a/spec/schemas/indices.put_index_template.yaml +++ b/spec/schemas/indices.put_index_template.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.put_index_template category - description: Schemas of indices.put_index_template category + title: Schemas of `indices.put_index_template` Category + description: Schemas of `indices.put_index_template` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.recovery.yaml b/spec/schemas/indices.recovery.yaml index 17019bfad..bda47b369 100644 --- a/spec/schemas/indices.recovery.yaml +++ b/spec/schemas/indices.recovery.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.recovery category - description: Schemas of indices.recovery category + title: Schemas of `indices.recovery` Category + description: Schemas of `indices.recovery` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.resolve_index.yaml b/spec/schemas/indices.resolve_index.yaml index 6e3b096a8..f8cd9e57b 100644 --- a/spec/schemas/indices.resolve_index.yaml +++ b/spec/schemas/indices.resolve_index.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.resolve_index category - description: Schemas of indices.resolve_index category + title: Schemas of `indices.resolve_index` Category + description: Schemas of `indices.resolve_index` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.rollover.yaml b/spec/schemas/indices.rollover.yaml index f78347fe4..29158a356 100644 --- a/spec/schemas/indices.rollover.yaml +++ b/spec/schemas/indices.rollover.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.rollover category - description: Schemas of indices.rollover category + title: Schemas of `indices.rollover` Category + description: Schemas of `indices.rollover` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.segments.yaml b/spec/schemas/indices.segments.yaml index ae2c62292..e2e8230ba 100644 --- a/spec/schemas/indices.segments.yaml +++ b/spec/schemas/indices.segments.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.segments category - description: Schemas of indices.segments category + title: Schemas of `indices.segments` Category + description: Schemas of `indices.segments` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.shard_stores.yaml b/spec/schemas/indices.shard_stores.yaml index 8e4268a58..0745101db 100644 --- a/spec/schemas/indices.shard_stores.yaml +++ b/spec/schemas/indices.shard_stores.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.shard_stores category - description: Schemas of indices.shard_stores category + title: Schemas of `indices.shard_stores` Category + description: Schemas of `indices.shard_stores` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.simulate_template.yaml b/spec/schemas/indices.simulate_template.yaml index 0265ecc2d..33e87f80b 100644 --- a/spec/schemas/indices.simulate_template.yaml +++ b/spec/schemas/indices.simulate_template.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.simulate_template category - description: Schemas of indices.simulate_template category + title: Schemas of `indices.simulate_template` Category + description: Schemas of `indices.simulate_template` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.stats.yaml b/spec/schemas/indices.stats.yaml index cb13ae0b3..367ce207f 100644 --- a/spec/schemas/indices.stats.yaml +++ b/spec/schemas/indices.stats.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.stats category - description: Schemas of indices.stats category + title: Schemas of `indices.stats` Category + description: Schemas of `indices.stats` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.update_aliases.yaml b/spec/schemas/indices.update_aliases.yaml index ee273091c..5f3de9d9c 100644 --- a/spec/schemas/indices.update_aliases.yaml +++ b/spec/schemas/indices.update_aliases.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.update_aliases category - description: Schemas of indices.update_aliases category + title: Schemas of `indices.update_aliases` Category + description: Schemas of `indices.update_aliases` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/indices.validate_query.yaml b/spec/schemas/indices.validate_query.yaml index 4c13bfa57..5d95f20ca 100644 --- a/spec/schemas/indices.validate_query.yaml +++ b/spec/schemas/indices.validate_query.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of indices.validate_query category - description: Schemas of indices.validate_query category + title: Schemas of `indices.validate_query` Category + description: Schemas of `indices.validate_query` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/ingest._common.yaml b/spec/schemas/ingest._common.yaml index 820b17e33..2f89ace33 100644 --- a/spec/schemas/ingest._common.yaml +++ b/spec/schemas/ingest._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of ingest._common category - description: Schemas of ingest._common category + title: Schemas of `ingest._common` Category + description: Schemas of `ingest._common` category. version: 1.0.0 paths: {} components: @@ -258,7 +258,7 @@ components: $ref: '_common.yaml#/components/schemas/Field' timezone: description: |- - The timezone to use when parsing the date. + The time zone to use when parsing the date. Supports template snippets. type: string required: @@ -299,7 +299,7 @@ components: description: The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. type: string timezone: - description: The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + description: The time zone to use when parsing the date and when date math index supports resolves expressions into concrete index names. type: string required: - date_formats @@ -332,7 +332,7 @@ components: max_matches: description: |- The maximum number of matched documents to include under the configured target field. - The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object. + The `target_field` will be turned into a JSON array if `max_matches` is higher than 1, otherwise `target_field` will become a JSON object. In order to avoid documents getting too large, the maximum allowed value is 128. type: number override: diff --git a/spec/schemas/ingest.simulate.yaml b/spec/schemas/ingest.simulate.yaml index 1efcc86d0..4b525dbf6 100644 --- a/spec/schemas/ingest.simulate.yaml +++ b/spec/schemas/ingest.simulate.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of ingest.simulate category - description: Schemas of ingest.simulate category + title: Schemas of `ingest.simulate` Category + description: Schemas of `ingest.simulate` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/insights._common.yaml b/spec/schemas/insights._common.yaml index f7180c7b4..26907f160 100644 --- a/spec/schemas/insights._common.yaml +++ b/spec/schemas/insights._common.yaml @@ -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' @@ -92,7 +92,7 @@ components: collapse: $ref: '_core.search.yaml#/components/schemas/FieldCollapse' explain: - description: If true, returns detailed information about score computation as part of a hit. + description: If `true`, returns detailed information about score computation as part of a hit. type: boolean ext: description: Configuration of search extensions defined by OpenSearch plugins. @@ -185,10 +185,10 @@ components: Defaults to no timeout. type: string track_scores: - description: If true, calculate and return document scores, even if the scores are not used for sorting. + description: If `true`, calculate and return document scores, even if the scores are not used for sorting. type: boolean version: - description: If true, returns document version as part of a hit. + description: If `true`, returns document version as part of a hit. type: boolean seq_no_primary_term: description: If `true`, returns sequence number and primary term of the last modification of each hit. diff --git a/spec/schemas/ism._common.yaml b/spec/schemas/ism._common.yaml index 73cb42071..9c59ff375 100644 --- a/spec/schemas/ism._common.yaml +++ b/spec/schemas/ism._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Schemas of ism._common Category - description: Schemas of ism._common category. + description: Schemas of `ism._common` category.. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/knn._common.yaml b/spec/schemas/knn._common.yaml index 9b3c1b44a..b4cbeaa36 100644 --- a/spec/schemas/knn._common.yaml +++ b/spec/schemas/knn._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of knn._common category - description: Schemas of knn._common category + title: Schemas of `knn._common` Category + description: Schemas of `knn._common` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/ml._common.yaml b/spec/schemas/ml._common.yaml index 36f6c4954..ffe3b7bf3 100644 --- a/spec/schemas/ml._common.yaml +++ b/spec/schemas/ml._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of ml category - description: Schemas of ml category + title: Schemas of `ml` Category + description: Schemas of `ml` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/nodes._common.yaml b/spec/schemas/nodes._common.yaml index 4c071b743..c79563e7a 100644 --- a/spec/schemas/nodes._common.yaml +++ b/spec/schemas/nodes._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of nodes._common category - description: Schemas of nodes._common category + title: Schemas of `nodes._common` Category + description: Schemas of `nodes._common` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/nodes.info.yaml b/spec/schemas/nodes.info.yaml index 2d27da447..789efa969 100644 --- a/spec/schemas/nodes.info.yaml +++ b/spec/schemas/nodes.info.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of nodes.info category - description: Schemas of nodes.info category + title: Schemas of `nodes.info` Category + description: Schemas of `nodes.info` category. version: 1.0.0 paths: {} components: @@ -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' diff --git a/spec/schemas/nodes.reload_secure_settings.yaml b/spec/schemas/nodes.reload_secure_settings.yaml index d748653b2..f1b106024 100644 --- a/spec/schemas/nodes.reload_secure_settings.yaml +++ b/spec/schemas/nodes.reload_secure_settings.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of nodes.reload_secure_settings category - description: Schemas of nodes.reload_secure_settings category + title: Schemas of `nodes.reload_secure_settings` Category + description: Schemas of `nodes.reload_secure_settings` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/nodes.stats.yaml b/spec/schemas/nodes.stats.yaml index 52dd278d0..0c5a1ee19 100644 --- a/spec/schemas/nodes.stats.yaml +++ b/spec/schemas/nodes.stats.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of nodes.stats category - description: Schemas of nodes.stats category + title: Schemas of `nodes.stats` Category + description: Schemas of `nodes.stats` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/nodes.usage.yaml b/spec/schemas/nodes.usage.yaml index bf397bfbf..2ce22876e 100644 --- a/spec/schemas/nodes.usage.yaml +++ b/spec/schemas/nodes.usage.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of nodes.usage category - description: Schemas of nodes.usage category + title: Schemas of `nodes.usage` Category + description: Schemas of `nodes.usage` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/notifications._common.yaml b/spec/schemas/notifications._common.yaml index 667eb0847..791816731 100644 --- a/spec/schemas/notifications._common.yaml +++ b/spec/schemas/notifications._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of notifications._common category - description: Schemas of notifications._common category + title: Schemas of `notifications._common` Category + description: Schemas of `notifications._common` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/query._common.yaml b/spec/schemas/query._common.yaml index ef4e315f4..e6511cc8f 100644 --- a/spec/schemas/query._common.yaml +++ b/spec/schemas/query._common.yaml @@ -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: diff --git a/spec/schemas/remote_store._common.yaml b/spec/schemas/remote_store._common.yaml index 3c0ca5057..cb4616efa 100644 --- a/spec/schemas/remote_store._common.yaml +++ b/spec/schemas/remote_store._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of remote_store._common category - description: Schemas of remote_store._common category + title: Schemas of `remote_store._common` Category + description: Schemas of `remote_store._common` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/replication._common.yaml b/spec/schemas/replication._common.yaml index e2b965b0e..49f5f6402 100644 --- a/spec/schemas/replication._common.yaml +++ b/spec/schemas/replication._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of replication._common category. - description: Schemas of replication._common category. + title: Schemas of `replication._common` Category. + description: Schemas of `replication._common` category.. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/rollups._common.yaml b/spec/schemas/rollups._common.yaml index cc12292bc..6e6da5704 100644 --- a/spec/schemas/rollups._common.yaml +++ b/spec/schemas/rollups._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of rollup._common category - description: Schemas of rollup._common category + title: Schemas of `rollup._common` Category + description: Schemas of `rollup._common` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/search_pipeline._common.yaml b/spec/schemas/search_pipeline._common.yaml index ebb14ee9a..1b6d32666 100644 --- a/spec/schemas/search_pipeline._common.yaml +++ b/spec/schemas/search_pipeline._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of search_pipeline._common category - description: Schemas of search_pipeline._common category + title: Schemas of `search_pipeline._common` Category + description: Schemas of `search_pipeline._common` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/security._common.yaml b/spec/schemas/security._common.yaml index fde8ffb39..c754e2325 100644 --- a/spec/schemas/security._common.yaml +++ b/spec/schemas/security._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of security._common category. - description: Schemas of security._common category. + title: Schemas of `security._common` Category. + description: Schemas of `security._common` category.. version: 1.0.0 paths: {} components: @@ -64,7 +64,7 @@ components: type: boolean requests: type: object - description: An object with APIs as key and array of http methods as values. + description: An object with APIs as key and array of HTTP methods as values. AuditConfig: type: object @@ -131,7 +131,7 @@ components: properties: user: type: string - description: Stringified User object. + description: A User object as a string. user_name: type: string description: User's name. @@ -167,7 +167,7 @@ components: description: Number of peer certificates. sso_logout_url: type: ['null', string] - description: Logout url. + description: Logout URL. size_of_user: type: string description: Size of user in memory. @@ -420,7 +420,7 @@ components: description: The generated OBO token. durationSeconds: type: string - description: The duration of the token, defaulted to 300s. + description: The duration of the token. Default is `300s`. HealthInfo: type: object @@ -550,7 +550,7 @@ components: type: boolean disabled_endpoints: type: object - description: An object with disabled APIs as key and array of http methods as values. + description: An object with disabled APIs as key and array of HTTP methods as values. Role: type: object @@ -639,22 +639,22 @@ components: type: string ssl_protocol: type: ['null',string] - description: Protocol for this ssl setup. + description: Protocol for this SSL setup. ssl_cipher: type: ['null',string] - description: Cipher for this ssl setup. + description: Cipher for this SSL setup. ssl_openssl_available: type: boolean - description: A boolean to indicate if OpenSSL is available. + description: A Boolean to indicate if OpenSSL is available. ssl_openssl_version: type: [number, string] - description: Version of openssl. + description: Version of OpenSSL. ssl_openssl_version_string: type: ['null', string] - description: Full version string for openssl version. + description: Full version string for OpenSSL version. ssl_openssl_non_available_cause: type: ['null', string] - description: Reason for openssl unavailability. + description: Reason for OpenSSL unavailability. ssl_openssl_supports_key_manager_factory: type: boolean description: Indicates where KMF is supported. @@ -663,7 +663,7 @@ components: description: Indicates whether hostname validation is supported. ssl_provider_http: type: ['null',string] - description: Returns http provider's name. + description: Returns HTTP provider's name. ssl_provider_transport_server: type: string description: Returns transport server's name. diff --git a/spec/schemas/snapshot._common.yaml b/spec/schemas/snapshot._common.yaml index b6caade7f..8eae7a0ea 100644 --- a/spec/schemas/snapshot._common.yaml +++ b/spec/schemas/snapshot._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of snapshot._common category - description: Schemas of snapshot._common category + title: Schemas of `snapshot._common` Category + description: Schemas of `snapshot._common` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/snapshot.cleanup_repository.yaml b/spec/schemas/snapshot.cleanup_repository.yaml index de41cadb0..9560ee07c 100644 --- a/spec/schemas/snapshot.cleanup_repository.yaml +++ b/spec/schemas/snapshot.cleanup_repository.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of snapshot.cleanup_repository category - description: Schemas of snapshot.cleanup_repository category + title: Schemas of `snapshot.cleanup_repository` Category + description: Schemas of `snapshot.cleanup_repository` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/snapshot.restore.yaml b/spec/schemas/snapshot.restore.yaml index 57f8c4fe1..368d50852 100644 --- a/spec/schemas/snapshot.restore.yaml +++ b/spec/schemas/snapshot.restore.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of snapshot.restore category - description: Schemas of snapshot.restore category + title: Schemas of `snapshot.restore` Category + description: Schemas of `snapshot.restore` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/snapshot.verify_repository.yaml b/spec/schemas/snapshot.verify_repository.yaml index 92eb0a2c1..1ff0443dc 100644 --- a/spec/schemas/snapshot.verify_repository.yaml +++ b/spec/schemas/snapshot.verify_repository.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of snapshot.verify_repository category - description: Schemas of snapshot.verify_repository category + title: Schemas of `snapshot.verify_repository` Category + description: Schemas of `snapshot.verify_repository` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/sql._common.yaml b/spec/schemas/sql._common.yaml index d9f50ade1..fbb153c44 100644 --- a/spec/schemas/sql._common.yaml +++ b/spec/schemas/sql._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of sql._common category. - description: Schemas of sql._common category. + title: Schemas of `sql._common` Category. + description: Schemas of `sql._common` category.. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/tasks._common.yaml b/spec/schemas/tasks._common.yaml index c5afaccda..eed56d652 100644 --- a/spec/schemas/tasks._common.yaml +++ b/spec/schemas/tasks._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of tasks._common category - description: Schemas of tasks._common category + title: Schemas of `tasks._common` Category + description: Schemas of `tasks._common` category. version: 1.0.0 paths: {} components: diff --git a/spec/schemas/transforms._common.yaml b/spec/schemas/transforms._common.yaml index 5d44ef5d9..bee81dc00 100644 --- a/spec/schemas/transforms._common.yaml +++ b/spec/schemas/transforms._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of transforms._common category - description: Schemas of transforms._common category + title: Schemas of `transforms._common` Category + description: Schemas of `transforms._common` category. version: 1.0.0 components: schemas: diff --git a/spec/schemas/wlm._common.yaml b/spec/schemas/wlm._common.yaml index ab6f8816a..2272f590c 100644 --- a/spec/schemas/wlm._common.yaml +++ b/spec/schemas/wlm._common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of wlm._common category - description: Schemas of wlm._common category + title: Schemas of `wlm._common` Category + description: Schemas of `wlm._common` category. version: 1.0.0 paths: {} components: diff --git a/tests/default/cat/cluster_manager.yaml b/tests/default/cat/cluster_manager.yaml index d35e9361e..2db2ad13e 100644 --- a/tests/default/cat/cluster_manager.yaml +++ b/tests/default/cat/cluster_manager.yaml @@ -2,7 +2,7 @@ $schema: ../../../json_schemas/test_story.schema.yaml description: Test cat/cluster_manager endpoints. chapters: - - synopsis: List information that helps identify the elected cluster manager node. + - synopsis: List information that helps identify the elected cluster-manager node. version: '>= 2.0' path: /_cat/cluster_manager method: GET diff --git a/tests/default/cat/master.yaml b/tests/default/cat/master.yaml index ea193902d..d4324cb58 100644 --- a/tests/default/cat/master.yaml +++ b/tests/default/cat/master.yaml @@ -3,7 +3,7 @@ $schema: ../../../json_schemas/test_story.schema.yaml description: Test cat/master endpoints. version: < 2.0 chapters: - - synopsis: List information that helps identify the elected master node. + - synopsis: List information that helps identify the elected cluster-manager node. path: /_cat/master method: GET parameters: diff --git a/tests/default/cluster/stats/nodes.yaml b/tests/default/cluster/stats/nodes.yaml index 42ea942f3..5fae79247 100644 --- a/tests/default/cluster/stats/nodes.yaml +++ b/tests/default/cluster/stats/nodes.yaml @@ -3,7 +3,7 @@ $schema: ../../../../json_schemas/test_story.schema.yaml description: Test cluster manager stats. version: '>= 2.0' chapters: - - synopsis: Returns information about the cluster manager node. + - synopsis: Returns information about the cluster-manager node. path: /_cluster/stats/nodes/{node_id} method: GET parameters: diff --git a/tests/default/query/datasources.yaml b/tests/default/query/datasources.yaml index 80ad12800..7ea3fead4 100644 --- a/tests/default/query/datasources.yaml +++ b/tests/default/query/datasources.yaml @@ -1,6 +1,6 @@ $schema: ../../../json_schemas/test_story.schema.yaml -description: Test various operations of the OpenSearch Query Datasources API. +description: Test various operations of the OpenSearch Query Data Sources API. version: '>=2.7' distributions: excluded: diff --git a/tests/plugins/analysis/indices/mapping/icu_collation_keyword.yaml b/tests/plugins/analysis/indices/mapping/icu_collation_keyword.yaml index 1b4d78dda..3fa7dd601 100644 --- a/tests/plugins/analysis/indices/mapping/icu_collation_keyword.yaml +++ b/tests/plugins/analysis/indices/mapping/icu_collation_keyword.yaml @@ -49,10 +49,8 @@ chapters: content_type: application/x-ndjson payload: - {create: {_id: '1'}} - # eslint-disable-next-line @cspell/spellchecker - {phrase: I WİLL USE TURKİSH CASING} - {create: {_id: '2'}} - # eslint-disable-next-line @cspell/spellchecker - {phrase: ı will use turkish casıng} - synopsis: Search for values with ICU collation. @@ -64,7 +62,6 @@ chapters: payload: query: term: - # eslint-disable-next-line @cspell/spellchecker phrase: I WİLL USE TURKİSH CASING sort: - phrase @@ -78,9 +75,7 @@ chapters: hits: - _id: '2' _source: - # eslint-disable-next-line @cspell/spellchecker phrase: ı will use turkish casıng - _id: '1' _source: - # eslint-disable-next-line @cspell/spellchecker phrase: I WİLL USE TURKİSH CASING diff --git a/tools/src/prepare-for-vale/KeepDescriptions.ts b/tools/src/prepare-for-vale/KeepDescriptions.ts index 8995f8df5..f3f7149cb 100644 --- a/tools/src/prepare-for-vale/KeepDescriptions.ts +++ b/tools/src/prepare-for-vale/KeepDescriptions.ts @@ -38,18 +38,25 @@ export default class KeepDescriptions { var inside_description = false contents.split(/\r?\n/).forEach((line) => { + // TODO: keep x-deprecation-message if (line.match(/^[\s]+(description: \|)/)) { inside_description = true } else if (line.match(/^[\s]+(description:)[\s]+/)) { - fs.writeSync(writer, line.replace("description:", " ")) + fs.writeSync(writer, this.prune(line).replace("description:", " ")) } else if (inside_description && line.match(/^[\s]*[\w]*:/)) { inside_description = false } else if (inside_description) { - fs.writeSync(writer, line) + fs.writeSync(writer, this.prune(line)) } if (line.length > 0) { fs.writeSync(writer, "\n") } }) } + + prune(line: string): string { + return line.replace(/([`])(?:(?=(\\?))\2.)*?\1/g, (match) => { + return Array(match.length + 1).join('*') + }) + } } diff --git a/tools/tests/merger/fixtures/specs/opensearch/schemas/_common.yaml b/tools/tests/merger/fixtures/specs/opensearch/schemas/_common.yaml index c3a4e41f3..55109176f 100644 --- a/tools/tests/merger/fixtures/specs/opensearch/schemas/_common.yaml +++ b/tools/tests/merger/fixtures/specs/opensearch/schemas/_common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _common category - description: Schemas of _common category + title: Schemas of `_common` Category + description: Schemas of `_common` category. version: 1.0.0 components: schemas: diff --git a/tools/tests/prepare-for-vale/fixtures/spec.txt b/tools/tests/prepare-for-vale/fixtures/spec.txt index a54608e03..55fb7ab28 100644 --- a/tools/tests/prepare-for-vale/fixtures/spec.txt +++ b/tools/tests/prepare-for-vale/fixtures/spec.txt @@ -24,3 +24,9 @@ Line one Line with a description: that describes itself. + + + + Line one + Line with backticks: that includes *******. + Line with two backticks: that includes ******* and *******. diff --git a/tools/tests/prepare-for-vale/fixtures/spec.yaml b/tools/tests/prepare-for-vale/fixtures/spec.yaml index 8801c55e2..09b51c951 100644 --- a/tools/tests/prepare-for-vale/fixtures/spec.yaml +++ b/tools/tests/prepare-for-vale/fixtures/spec.yaml @@ -24,3 +24,9 @@ components: description: |- Line one Line with a description: that describes itself. + ObjectWithCode: + type: object + description: |- + Line one + Line with backticks: that includes `x.y.z`. + Line with two backticks: that includes `x.y.z` and `z.y.x`. diff --git a/tools/tests/tester/fixtures/specs/complete/schemas/_common.yaml b/tools/tests/tester/fixtures/specs/complete/schemas/_common.yaml index c3a4e41f3..55109176f 100644 --- a/tools/tests/tester/fixtures/specs/complete/schemas/_common.yaml +++ b/tools/tests/tester/fixtures/specs/complete/schemas/_common.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: Schemas of _common category - description: Schemas of _common category + title: Schemas of `_common` Category + description: Schemas of `_common` category. version: 1.0.0 components: schemas: