From a22a61da13fe92e708f6b1b53d18fd05edb186aa Mon Sep 17 00:00:00 2001 From: "Daniel (dB.) Doubrovkine" Date: Tue, 19 Nov 2024 16:50:08 -0500 Subject: [PATCH] Misc Vale fixes. (#682) Signed-off-by: dblock --- spec/namespaces/_core.yaml | 10 +- spec/namespaces/cat.yaml | 32 +++---- spec/namespaces/cluster.yaml | 34 +++---- spec/namespaces/dangling_indices.yaml | 24 ++--- spec/namespaces/flow_framework.yaml | 6 +- spec/namespaces/indices.yaml | 96 +++++++++---------- spec/namespaces/ingest.yaml | 6 +- spec/namespaces/ism.yaml | 8 +- spec/namespaces/knn.yaml | 8 +- spec/namespaces/list.yaml | 2 +- spec/namespaces/nodes.yaml | 14 +-- spec/namespaces/remote_store.yaml | 4 +- spec/namespaces/search_pipeline.yaml | 4 +- spec/namespaces/security.yaml | 24 ++--- spec/namespaces/snapshot.yaml | 28 +++--- spec/namespaces/transforms.yaml | 2 +- spec/schemas/_common.aggregations.yaml | 24 ++--- spec/schemas/_common.query_dsl.yaml | 22 ++--- spec/schemas/_common.yaml | 2 +- spec/schemas/_core.bulk.yaml | 10 +- spec/schemas/cat.fielddata.yaml | 2 +- spec/schemas/cat.nodes.yaml | 8 +- spec/schemas/cat.shards.yaml | 4 +- spec/schemas/indices._common.yaml | 10 +- spec/schemas/ingest._common.yaml | 8 +- spec/schemas/nodes._common.yaml | 4 +- tests/default/nodes/hot_threads.yaml | 2 +- tests/default/nodes/stats.yaml | 2 +- tests/default/security/api/allowlist.yaml | 2 +- tests/default/security/api/certificates.yaml | 2 +- .../default/security/api/securityconfig.yaml | 2 +- .../security/api/securityconfig/config.yaml | 2 +- tests/default/security/api/ssl/certs.yaml | 2 +- .../security/api/ssl/http/reloadcerts.yaml | 2 +- .../api/ssl/transport/reloadcerts.yaml | 2 +- tests/default/security/api/upgrade_check.yaml | 2 +- .../default/security/api/upgrade_perform.yaml | 2 +- tests/snapshot/snapshot/restore.yaml | 4 +- .../fixtures/evals/passed/value_type.yaml | 4 +- .../fixtures/stories/passed/value_type.yaml | 4 +- 40 files changed, 215 insertions(+), 215 deletions(-) diff --git a/spec/namespaces/_core.yaml b/spec/namespaces/_core.yaml index 6f40a0bb1..569b69b11 100644 --- a/spec/namespaces/_core.yaml +++ b/spec/namespaces/_core.yaml @@ -4197,7 +4197,7 @@ components: $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. delete_script::query.timeout: in: query name: timeout @@ -4659,7 +4659,7 @@ components: $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. get_source::path.id: in: path name: id @@ -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 @@ -5188,7 +5188,7 @@ components: $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. put_script::query.timeout: in: query name: timeout @@ -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 diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml index e9036b721..e9981e972 100644 --- a/spec/namespaces/cat.yaml +++ b/spec/namespaces/cat.yaml @@ -157,7 +157,7 @@ paths: operationId: cat.fielddata.0 x-operation-group: cat.fielddata x-version-added: '1.0' - description: Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + description: Shows how much heap memory is currently being used by field data on every data node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/ parameters: @@ -176,7 +176,7 @@ paths: operationId: cat.fielddata.1 x-operation-group: cat.fielddata x-version-added: '1.0' - description: Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + description: Shows how much heap memory is currently being used by field data on every data node in the cluster. externalDocs: url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/ parameters: @@ -1237,7 +1237,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true cat.allocation::query.s: name: s @@ -1306,7 +1306,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true cat.cluster_manager::query.s: name: s @@ -1598,7 +1598,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true cat.indices::query.pri: in: query @@ -1682,7 +1682,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true cat.master::query.s: name: s @@ -1751,7 +1751,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true cat.nodeattrs::query.s: name: s @@ -1840,7 +1840,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true cat.nodes::query.s: name: s @@ -1915,7 +1915,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true cat.pending_tasks::query.s: name: s @@ -2041,7 +2041,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true cat.plugins::query.s: name: s @@ -2205,7 +2205,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true cat.repositories::query.s: name: s @@ -2430,7 +2430,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true cat.segments::query.s: name: s @@ -2517,7 +2517,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true cat.shards::query.s: name: s @@ -2604,7 +2604,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true cat.snapshots::query.s: name: s @@ -2775,7 +2775,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true cat.templates::query.s: name: s @@ -2854,7 +2854,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true cat.thread_pool::query.s: name: s diff --git a/spec/namespaces/cluster.yaml b/spec/namespaces/cluster.yaml index 61c103669..3ae08403a 100644 --- a/spec/namespaces/cluster.yaml +++ b/spec/namespaces/cluster.yaml @@ -906,7 +906,7 @@ components: $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.get_component_template::path.name: in: path name: name @@ -945,7 +945,7 @@ components: $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.get_decommission_awareness::path.awareness_attribute_name: name: awareness_attribute_name in: path @@ -988,7 +988,7 @@ components: $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.get_settings::query.timeout: in: query name: timeout @@ -1059,7 +1059,7 @@ components: $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.health::query.timeout: in: query name: timeout @@ -1084,14 +1084,14 @@ components: cluster.health::query.wait_for_no_initializing_shards: in: query name: wait_for_no_initializing_shards - description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + description: A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. schema: type: boolean style: form cluster.health::query.wait_for_no_relocating_shards: in: query name: wait_for_no_relocating_shards - description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + description: A Boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. schema: type: boolean style: form @@ -1139,13 +1139,13 @@ components: $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.post_voting_config_exclusions::query.node_ids: in: query name: node_ids description: |- A comma-separated list of the persistent ids of the nodes to exclude - from the voting configuration. If specified, you may not also specify node_names. + from the voting configuration. If specified, you may not also specify `node_names`. schema: $ref: '../schemas/_common.yaml#/components/schemas/Ids' style: form @@ -1154,7 +1154,7 @@ components: name: node_names description: |- A comma-separated list of the names of the nodes to exclude from the - voting configuration. If specified, you may not also specify node_ids. + voting configuration. If specified, you may not also specify `node_ids`. schema: $ref: '../schemas/_common.yaml#/components/schemas/Names' style: form @@ -1208,7 +1208,7 @@ components: $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.put_component_template::query.timeout: name: timeout in: query @@ -1255,7 +1255,7 @@ components: $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.put_settings::query.timeout: in: query name: timeout @@ -1301,7 +1301,7 @@ components: $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.reroute::query.metric: in: query name: metric @@ -1392,24 +1392,24 @@ components: cluster.state::query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: Specify timeout for connection to cluster manager. 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.state::query.wait_for_metadata_version: in: query name: wait_for_metadata_version - description: Wait for the metadata version to be equal or greater than the specified metadata version + description: Wait for the metadata version to be equal or greater than the specified metadata version. schema: $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' style: form cluster.state::query.wait_for_timeout: in: query name: wait_for_timeout - description: The maximum time to wait for wait_for_metadata_version before timing out + description: The maximum time to wait for `wait_for_metadata_version` before timing out. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form @@ -1426,7 +1426,7 @@ components: cluster.stats::path.metric: in: path name: metric - description: Limit the information returned to the specified metrics + description: Limit the information returned to the specified metrics. required: true schema: type: array diff --git a/spec/namespaces/dangling_indices.yaml b/spec/namespaces/dangling_indices.yaml index c81970e84..09a15e697 100644 --- a/spec/namespaces/dangling_indices.yaml +++ b/spec/namespaces/dangling_indices.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: OpenSearch Dangling_indices API - description: OpenSearch Dangling_indices API. + title: OpenSearch Dangling Indices API + description: OpenSearch Dangling Indices API. version: 1.0.0 paths: /_dangling: @@ -82,7 +82,7 @@ components: dangling_indices.delete_dangling_index::path.index_uuid: in: path name: index_uuid - description: The UUID of the dangling index + description: The UUID of the dangling index. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Uuid' @@ -90,7 +90,7 @@ components: dangling_indices.delete_dangling_index::query.accept_data_loss: in: query name: accept_data_loss - description: Must be set to true in order to delete the dangling index + description: Must be set to true in order to delete the dangling index. required: true schema: type: boolean @@ -105,24 +105,24 @@ components: dangling_indices.delete_dangling_index::query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: Specify timeout for connection to cluster manager. 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. dangling_indices.delete_dangling_index::query.timeout: in: query name: timeout - description: Explicit operation timeout + description: Explicit operation timeout. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form dangling_indices.import_dangling_index::path.index_uuid: in: path name: index_uuid - description: The UUID of the dangling index + description: The UUID of the dangling index. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Uuid' @@ -130,7 +130,7 @@ components: dangling_indices.import_dangling_index::query.accept_data_loss: in: query name: accept_data_loss - description: Must be set to true in order to import the dangling index + description: Must be set to true in order to import the dangling index. required: true schema: type: boolean @@ -145,17 +145,17 @@ components: dangling_indices.import_dangling_index::query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: Specify timeout for connection to cluster manager. 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. dangling_indices.import_dangling_index::query.timeout: in: query name: timeout - description: Explicit operation timeout + description: Explicit operation timeout. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form diff --git a/spec/namespaces/flow_framework.yaml b/spec/namespaces/flow_framework.yaml index 7d3616220..b0a47a30a 100644 --- a/spec/namespaces/flow_framework.yaml +++ b/spec/namespaces/flow_framework.yaml @@ -61,7 +61,7 @@ paths: responses: '201': $ref: '#/components/responses/flow_framework.update@201' - description: It returns the workflow_id + description: It returns the `workflow_id`. '404': $ref: '#/components/responses/flow_framework.update@404' '400': @@ -301,7 +301,7 @@ components: schema: $ref: '../schemas/flow_framework.common.yaml#/components/schemas/Reprovision' flow_framework.create::query.use_case: - description: To use a workflow template, specify it in the use_case query parameter when creating a workflow. + description: To use a workflow template, specify it in the `use_case` query parameter when creating a workflow. in: query name: use_case schema: @@ -313,7 +313,7 @@ components: schema: $ref: '../schemas/flow_framework.common.yaml#/components/schemas/All' flow_framework.update::query.use_case: - description: To use a workflow template, specify it in the use_case query parameter when creating a workflow. + description: To use a workflow template, specify it in the `use_case` query parameter when creating a workflow. in: query name: use_case schema: diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml index 159920447..5c35abfd8 100644 --- a/spec/namespaces/indices.yaml +++ b/spec/namespaces/indices.yaml @@ -844,7 +844,7 @@ paths: operationId: indices.get_upgrade.0 x-operation-group: indices.get_upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -858,7 +858,7 @@ paths: operationId: indices.upgrade.0 x-operation-group: indices.upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1827,7 +1827,7 @@ paths: operationId: indices.get_upgrade.1 x-operation-group: indices.get_upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -1842,7 +1842,7 @@ paths: operationId: indices.upgrade.1 x-operation-group: indices.upgrade x-version-added: '1.0' - description: The _upgrade API is no longer useful and will be removed. + description: The `_upgrade` API is no longer useful and will be removed. externalDocs: url: https://opensearch.org/docs/latest parameters: @@ -2066,7 +2066,7 @@ components: dynamic_date_formats: description: |- If date detection is enabled then new string fields are checked - against 'dynamic_date_formats' and if the value matches then + against `dynamic_date_formats` and if the value matches then a new date field is added instead of string. type: array items: @@ -2458,8 +2458,8 @@ components: properties: task: description: |- - task contains a task id returned when wait_for_completion=false, - you can use the task_id to get the status of the task at _tasks/ + Task contains a task id returned when `wait_for_completion=false`, + you can use the `task_id` to get the status of the task at _tasks/. type: string indices.get@200: content: @@ -2763,7 +2763,7 @@ components: indices.add_block::path.block: in: path name: block - description: The block to add (one of read, write, read_only or metadata) + description: The block to add (one of `read`, `write`, `read_only` or `metadata`). required: true schema: $ref: '../schemas/indices.add_block.yaml#/components/schemas/IndicesBlockOptions' @@ -2771,7 +2771,7 @@ components: indices.add_block::path.index: in: path name: index - description: A comma separated list of indexes to add a block to + description: A comma separated list of indexes to add a block to. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Indices' @@ -2779,7 +2779,7 @@ components: indices.add_block::query.allow_no_indices: in: query name: allow_no_indices - description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified) + description: Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified). schema: type: boolean style: form @@ -2800,20 +2800,20 @@ components: indices.add_block::query.ignore_unavailable: in: query name: ignore_unavailable - description: Whether specified concrete indexes should be ignored when unavailable (missing or closed) + description: Whether specified concrete indexes should be ignored when unavailable (missing or closed). schema: type: boolean style: form indices.add_block::query.master_timeout: in: query name: master_timeout - description: Specify timeout for connection to master + description: Specify timeout for connection to cluster manager. 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. indices.add_block::query.timeout: in: query name: timeout @@ -2961,11 +2961,11 @@ components: $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. indices.clone::query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' indices.clone::query.timeout: @@ -3048,7 +3048,7 @@ components: $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. indices.close::query.timeout: in: query name: timeout @@ -3093,7 +3093,7 @@ components: $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. indices.create::query.timeout: in: query name: timeout @@ -3196,7 +3196,7 @@ components: $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. indices.delete::query.timeout: in: query name: timeout @@ -3244,7 +3244,7 @@ components: $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. indices.delete_alias::query.timeout: in: query name: timeout @@ -3286,7 +3286,7 @@ components: $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. indices.delete_index_template::query.timeout: in: query name: timeout @@ -3322,7 +3322,7 @@ components: $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. indices.delete_template::query.timeout: in: query name: timeout @@ -3493,7 +3493,7 @@ components: $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. indices.exists_template::path.name: in: path name: name @@ -3534,7 +3534,7 @@ components: $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. indices.flush::path.index: in: path name: index @@ -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: @@ -3696,7 +3696,7 @@ components: description: |- Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, - such as open,hidden. + such as `open,hidden`. schema: $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' style: form @@ -3741,7 +3741,7 @@ components: $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. indices.get_alias::path.index: in: path name: index @@ -3910,7 +3910,7 @@ components: $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. indices.get_mapping::path.index: in: path name: index @@ -3985,7 +3985,7 @@ components: $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. indices.get_settings::path.index: in: path name: index @@ -4079,7 +4079,7 @@ components: $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. indices.get_template::path.name: in: path name: name @@ -4125,7 +4125,7 @@ components: $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. indices.get_upgrade::path.index: name: index in: path @@ -4214,11 +4214,11 @@ components: $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. indices.open::query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' indices.open::query.timeout: @@ -4288,7 +4288,7 @@ components: $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. indices.put_alias::query.timeout: in: query name: timeout @@ -4336,7 +4336,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true indices.put_mapping::path.index: in: path @@ -4391,7 +4391,7 @@ components: $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. indices.put_mapping::query.timeout: in: query name: timeout @@ -4477,7 +4477,7 @@ components: $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. indices.put_settings::query.preserve_existing: in: query name: preserve_existing @@ -4529,7 +4529,7 @@ components: $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. indices.put_template::query.order: in: query name: order @@ -4673,7 +4673,7 @@ components: $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. indices.rollover::query.timeout: in: query name: timeout @@ -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: @@ -4825,11 +4825,11 @@ components: $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. indices.shrink::query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' indices.shrink::query.timeout: @@ -4906,7 +4906,7 @@ components: $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. indices.simulate_template::path.name: in: path name: name @@ -4949,7 +4949,7 @@ components: $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. indices.split::path.index: in: path name: index @@ -4992,11 +4992,11 @@ components: $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. indices.split::query.task_execution_timeout: name: task_execution_timeout in: query - description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + description: Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`. schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' indices.split::query.timeout: @@ -5049,7 +5049,7 @@ components: indices.stats::query.completion_fields: in: query name: completion_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + description: Comma-separated list or wildcard expressions of fields to include in field data and suggest statistics. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form @@ -5066,7 +5066,7 @@ components: indices.stats::query.fielddata_fields: in: query name: fielddata_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + description: Comma-separated list or wildcard expressions of fields to include in field data statistics. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form @@ -5137,7 +5137,7 @@ components: $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. indices.update_aliases::query.timeout: in: query name: timeout diff --git a/spec/namespaces/ingest.yaml b/spec/namespaces/ingest.yaml index f5c55166a..ed6f3c380 100644 --- a/spec/namespaces/ingest.yaml +++ b/spec/namespaces/ingest.yaml @@ -250,7 +250,7 @@ components: $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. ingest.delete_pipeline::query.timeout: in: query name: timeout @@ -289,7 +289,7 @@ components: $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. ingest.put_pipeline::path.id: in: path name: id @@ -314,7 +314,7 @@ components: $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. ingest.put_pipeline::query.timeout: in: query name: timeout diff --git a/spec/namespaces/ism.yaml b/spec/namespaces/ism.yaml index f2102c4e0..c97b3e917 100644 --- a/spec/namespaces/ism.yaml +++ b/spec/namespaces/ism.yaml @@ -169,7 +169,7 @@ paths: get: operationId: ism.explain_policy.0 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: @@ -180,7 +180,7 @@ paths: post: operationId: ism.explain_policy.1 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index requestBody: @@ -192,7 +192,7 @@ paths: get: operationId: ism.explain_policy.3 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: @@ -205,7 +205,7 @@ paths: post: operationId: ism.explain_policy.4 x-operation-group: ism.explain_policy - description: Gets the currently applied policy on indices. + description: Gets the currently applied policy on indexes. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index parameters: diff --git a/spec/namespaces/knn.yaml b/spec/namespaces/knn.yaml index 37d03316b..563f4f783 100644 --- a/spec/namespaces/knn.yaml +++ b/spec/namespaces/knn.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: OpenSearch Knn API - description: OpenSearch Knn API. + title: OpenSearch Vector API + description: OpenSearch Vector API. version: 1.0.0 paths: /_plugins/_knn/models/_search: @@ -507,11 +507,11 @@ components: knn.search_models::query.rest_total_hits_as_int: name: rest_total_hits_as_int in: query - description: Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + description: Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. schema: type: boolean default: false - description: Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + description: Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. knn.search_models::query.routing: name: routing in: query diff --git a/spec/namespaces/list.yaml b/spec/namespaces/list.yaml index efb5afc2d..14bd8a6a1 100644 --- a/spec/namespaces/list.yaml +++ b/spec/namespaces/list.yaml @@ -435,7 +435,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' 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. deprecated: true list.shards::query.s: name: s diff --git a/spec/namespaces/nodes.yaml b/spec/namespaces/nodes.yaml index e48171410..31fec73a0 100644 --- a/spec/namespaces/nodes.yaml +++ b/spec/namespaces/nodes.yaml @@ -357,7 +357,7 @@ components: properties: secure_settings_password: $ref: '../schemas/_common.yaml#/components/schemas/Password' - description: An object containing the password for the opensearch keystore + description: An object containing the password for the OpenSearch keystore. responses: nodes.hot_threads@200: content: @@ -410,11 +410,11 @@ components: nodes.hot_threads::query.snapshots: name: snapshots in: query - description: Number of samples of thread stacktrace. + description: Number of samples of thread stack trace. schema: type: integer default: 10 - description: Number of samples of thread stacktrace. + description: Number of samples of thread stack trace. format: int32 nodes.hot_threads::query.threads: name: threads @@ -442,7 +442,7 @@ components: name: node_id_or_metric description: | Limits the information returned to a list of node IDs or specific metrics. - Supports a comma-separated list, such as node1,node2 or http,ingest. + Supports a comma-separated list, such as `node1,node2` or `http,ingest`. required: true schema: anyOf: @@ -464,7 +464,7 @@ components: nodes.info::path.metric: in: path name: metric - description: Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. + description: Limits the information returned to the specific metrics. Supports a comma-separated list, such as `http,ingest`. required: true schema: type: array @@ -534,14 +534,14 @@ components: nodes.stats::query.completion_fields: in: query name: completion_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + description: Comma-separated list or wildcard expressions of fields to include in field data and suggest statistics. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form nodes.stats::query.fielddata_fields: in: query name: fielddata_fields - description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + description: Comma-separated list or wildcard expressions of fields to include in field data statistics. schema: $ref: '../schemas/_common.yaml#/components/schemas/Fields' style: form diff --git a/spec/namespaces/remote_store.yaml b/spec/namespaces/remote_store.yaml index 4202d5cdf..878633466 100644 --- a/spec/namespaces/remote_store.yaml +++ b/spec/namespaces/remote_store.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: OpenSearch Remote_store API - description: OpenSearch Remote_store API. + title: OpenSearch Remote Store API + description: OpenSearch Remote Store API. version: 1.0.0 paths: /_remotestore/_restore: diff --git a/spec/namespaces/search_pipeline.yaml b/spec/namespaces/search_pipeline.yaml index a2b5bd5fd..94aa9c907 100644 --- a/spec/namespaces/search_pipeline.yaml +++ b/spec/namespaces/search_pipeline.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: OpenSearch Search_pipeline API - description: OpenSearch Search_pipeline API. + title: OpenSearch Search Pipeline API + description: OpenSearch Search Pipeline API. version: 1.0.0 paths: /_search/pipeline: diff --git a/spec/namespaces/security.yaml b/spec/namespaces/security.yaml index 173344688..2a63cd0d9 100644 --- a/spec/namespaces/security.yaml +++ b/spec/namespaces/security.yaml @@ -1031,7 +1031,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: A PATCH call is used to update the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. + description: A `PATCH` call is used to update the existing configuration using the REST API. Only accessible by admins and users with REST API access and only when put or patch is enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#patch-configuration requestBody: @@ -1049,7 +1049,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Adds or updates the existing configuration using the REST API. Only accessible by admins and users with rest api access and only when put or patch is enabled. + description: Adds or updates the existing configuration using the REST API. Only accessible by admins and users with REST API access and only when put or patch is enabled. externalDocs: url: https://opensearch.org/docs/latest/security/access-control/api/#update-configuration requestBody: @@ -1316,7 +1316,7 @@ paths: x-distributions-excluded: - amazon-managed - amazon-serverless - description: Generates authorization token for the given user. Legacy API. Not Implemented. + description: Generates authorization token for the given user. Legacy API. Not Implemented. parameters: - $ref: '#/components/parameters/security.generate_user_token_legacy::path.username' responses: @@ -1839,7 +1839,7 @@ components: schema: $ref: '../schemas/security._common.yaml#/components/schemas/InternalServerError' security.get_distinguished_name@200: - description: Show nodesDn setting for given cluster. + description: Show `nodesDn` setting for given cluster. content: application/json: schema: @@ -1860,7 +1860,7 @@ components: schema: $ref: '../schemas/security._common.yaml#/components/schemas/DistinguishedNamesMap' security.get_distinguished_names@400: - description: Show nodesDn setting for given cluster. + description: Show `nodesDn` setting for given cluster. content: application/json: schema: @@ -2395,14 +2395,14 @@ components: security.get_distinguished_name::query.show_all: name: show_all in: query - description: A boolean flag to include/exclude static nodes DN from final result. + description: A Boolean flag to include/exclude static nodes DN from final result. schema: type: boolean required: false security.get_distinguished_names::query.show_all: name: show_all in: query - description: A boolean flag to include/exclude static nodes DN from final result. + description: A Boolean flag to include/exclude static nodes DN from final result. schema: type: boolean required: false @@ -2421,7 +2421,7 @@ components: security.get_sslinfo::query.show_dn: name: show_dn in: query - description: A boolean flag to indicate whether all domain names should be returned. + description: A Boolean flag to indicate whether all domain names should be returned. schema: type: [boolean, string] required: false @@ -2449,7 +2449,7 @@ components: security.health::query.mode: name: mode in: query - description: A flag to indicate whether service should consider security-plugin's status before returning health response. `strict` mode indicates service should check security plugin status. + description: A flag to indicate whether service should consider security-plugin's status before returning health response. `strict` mode indicates service should check Security plugin status. schema: type: string required: false @@ -2463,7 +2463,7 @@ components: security.patch_distinguished_name::path.cluster_name: name: cluster_name in: path - description: The cluster-name to update nodesDn value. + description: The cluster name to update `nodesDn` value. schema: type: string required: true @@ -2498,14 +2498,14 @@ components: security.update_distinguished_name::path.cluster_name: name: cluster_name in: path - description: The cluster-name to create/update nodesDn value for. + description: The cluster-name to create/update `nodesDn` value for. schema: type: string required: true security.validate::query.accept_invalid: name: accept_invalid in: query - description: A boolean flag to indicate whether invalid v6 configuration should be allowed. + description: A Boolean flag to indicate whether invalid v6 configuration should be allowed. schema: type: boolean required: false diff --git a/spec/namespaces/snapshot.yaml b/spec/namespaces/snapshot.yaml index af430968f..735beeb6c 100644 --- a/spec/namespaces/snapshot.yaml +++ b/spec/namespaces/snapshot.yaml @@ -481,7 +481,7 @@ components: $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. snapshot.cleanup_repository::query.timeout: in: query name: timeout @@ -529,7 +529,7 @@ components: $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. snapshot.create::path.repository: in: path name: repository @@ -562,7 +562,7 @@ components: $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. snapshot.create::query.wait_for_completion: in: query name: wait_for_completion @@ -595,7 +595,7 @@ components: $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. snapshot.create_repository::query.timeout: in: query name: timeout @@ -642,7 +642,7 @@ components: $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. snapshot.delete_repository::path.repository: in: path name: repository @@ -667,7 +667,7 @@ components: $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. snapshot.delete_repository::query.timeout: in: query name: timeout @@ -687,9 +687,9 @@ components: in: path name: snapshot description: |- - Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*). - - To get information about all snapshots in a registered repository, use a wildcard (*) or _all. - - To get information about any snapshots that are currently running, use _current. + Comma-separated list of snapshot names to retrieve. Also accepts wildcards (`*`). + - To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`. + - To get information about any snapshots that are currently running, use `_current`. required: true schema: $ref: '../schemas/_common.yaml#/components/schemas/Names' @@ -718,7 +718,7 @@ components: $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. snapshot.get::query.verbose: in: query name: verbose @@ -758,7 +758,7 @@ components: $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. snapshot.restore::path.repository: in: path name: repository @@ -791,7 +791,7 @@ components: $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. snapshot.restore::query.wait_for_completion: in: query name: wait_for_completion @@ -840,7 +840,7 @@ components: $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. snapshot.verify_repository::path.repository: in: path name: repository @@ -865,7 +865,7 @@ components: $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. snapshot.verify_repository::query.timeout: in: query name: timeout diff --git a/spec/namespaces/transforms.yaml b/spec/namespaces/transforms.yaml index 00c3fd4e6..abc3da786 100644 --- a/spec/namespaces/transforms.yaml +++ b/spec/namespaces/transforms.yaml @@ -38,7 +38,7 @@ paths: operationId: transforms.put.0 x-operation-group: transforms.put x-version-added: '1.0' - description: Create an index transform, or update a transform if if_seq_no and if_primary_term are provided. + description: Create an index transform, or update a transform if `if_seq_no` and `if_primary_term` are provided. externalDocs: url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#create-a-transform-job parameters: diff --git a/spec/schemas/_common.aggregations.yaml b/spec/schemas/_common.aggregations.yaml index c3624ac0b..6281b97d2 100644 --- a/spec/schemas/_common.aggregations.yaml +++ b/spec/schemas/_common.aggregations.yaml @@ -954,7 +954,7 @@ components: to_as_string: type: string key: - description: The bucket key. Present if the aggregation is _not_ keyed + description: The bucket key. Present if the aggregation is not keyed. type: string DateRangeAggregate: allOf: @@ -1845,7 +1845,7 @@ components: BucketsPath: description: |- Buckets path can be expressed in different ways, and an aggregation may accept some or all of these - forms depending on its type. Please refer to each aggregation's documentation to know what buckets + forms depending on its type. Refer to each aggregation's documentation to know what buckets path forms they accept. oneOf: - type: string @@ -1953,7 +1953,7 @@ components: doc_count: description: |- The total number of documents that initially created the expectations. It's required to be greater - than or equal to the sum of all values in the buckets_path as this is the originating superset of data + than or equal to the sum of all values in the `buckets_path` as this is the originating superset of data to which the term values are correlated. type: number expectations: @@ -1966,7 +1966,7 @@ components: fractions: description: |- An array of fractions to use when averaging and calculating variance. This should be used if - the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided, + the pre-calculated data and the `buckets_path` have known gaps. The length of fractions, if provided, must equal expectations. type: array items: @@ -2005,7 +2005,7 @@ components: $ref: '_common.yaml#/components/schemas/Field' max_unique_tokens: description: |- - The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1. + The maximum number of unique tokens at any position up to `max_matched_tokensg`. Must be larger than 1. Smaller values use less memory and create fewer categories. Larger values will use more memory and create narrower categories. Max allowed value is 100. type: number @@ -2025,10 +2025,10 @@ components: This property expects an array of regular expressions. The expressions are used to filter out matching sequences from the categorization field values. You can use this functionality to fine tune the categorization by excluding sequences from consideration when categories are defined. For example, you can exclude SQL - statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer. + statements that appear in your log files. This property cannot be used at the same time as `categorization_analyzer`. If you only want to define simple regular expression filters that are applied prior to tokenization, setting this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering, - use the categorization_analyzer property instead and include the filters as pattern_replace character filters. + use the `categorization_analyzer` property instead and include the filters as `pattern_replace` character filters. type: array items: type: string @@ -2557,7 +2557,7 @@ components: precision: description: |- Integer zoom of the key used to defined cells or buckets - in the results. Value should be between 0-15. + in the results. Value should be between 0 and 15. type: number bounds: $ref: '_common.yaml#/components/schemas/GeoBounds' @@ -2714,13 +2714,13 @@ components: description: Specifies the maximum number of feature importance values per document. type: number prediction_field_type: - description: 'Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.' + description: 'Specifies the type of the predicted field to write. Acceptable values are: string, number, Boolean. When Boolean is provided 1.0 is transformed to true and 0.0 to false.' type: string results_field: - description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + description: The field that is added to incoming documents to contain the inference prediction. Defaults to `predicted_value`. type: string top_classes_results_field: - description: Specifies the field to which the top classes are written. Defaults to top_classes. + description: Specifies the field to which the top classes are written. Defaults to `top_classes`. type: string MatrixStatsAggregation: allOf: @@ -3297,7 +3297,7 @@ components: $ref: '#/components/schemas/ScriptedHeuristic' shard_min_doc_count: description: |- - Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. + Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the `min_doc_count`. Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. type: number shard_size: diff --git a/spec/schemas/_common.query_dsl.yaml b/spec/schemas/_common.query_dsl.yaml index 45c744694..34206b155 100644 --- a/spec/schemas/_common.query_dsl.yaml +++ b/spec/schemas/_common.query_dsl.yaml @@ -69,7 +69,7 @@ components: $ref: '#/components/schemas/KnnQuery' match: description: |- - Returns documents that match a provided text, number, date or boolean value. + Returns documents that match a provided text, number, date or Boolean value. The provided text is analyzed before matching. type: object additionalProperties: @@ -181,7 +181,7 @@ components: term: description: |- Returns documents that contain an exact term in a provided field. - To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization. + To return a document, the query term must exactly match the queried field's value, including white space and capitalization. type: object additionalProperties: anyOf: @@ -196,7 +196,7 @@ components: terms_set: description: |- Returns documents that contain a minimum number of exact terms in a provided field. - To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization. + To return a document, a required number of terms must exactly match the field values, including white space and capitalization. type: object additionalProperties: $ref: '#/components/schemas/TermsSetQuery' @@ -212,7 +212,7 @@ components: type: $ref: '#/components/schemas/TypeQuery' weighted_tokens: - description: Supports returning text_expansion query results by sending in precomputed tokens with the query. + description: Supports returning `text_expansion` query results by sending in precomputed tokens with the query. type: object additionalProperties: $ref: '#/components/schemas/WeightedTokensQuery' @@ -272,8 +272,8 @@ components: $ref: '#/components/schemas/QueryContainer' adjust_pure_negative: description: |- - Ensures correct behavior when a query contains only must_not clauses. - By default set to true, OpenSearch adds a match-all clause to ensure results are returned from Lucene, with the must_not conditions applied as filters. + Ensures correct behavior when a query contains only `must_not` clauses. + By default set to true, OpenSearch adds a match-all clause to ensure results are returned from Lucene, with the `must_not` conditions applied as filters. If set to false, the query may return no results, as Lucene typically requires at least one positive condition. type: boolean default: true @@ -990,7 +990,7 @@ components: type: integer format: int32 query: - description: Text, number, boolean value or date you wish to find in the provided field. + description: Text, number, Boolean value or date you wish to find in the provided field. oneOf: - type: string - type: number @@ -1250,7 +1250,7 @@ components: type: integer format: int32 query: - description: Text, number, boolean value or date you wish to find in the provided field. + description: Text, number, Boolean value or date you wish to find in the provided field. type: string slop: description: Maximum number of positions allowed between matching tokens. @@ -1700,7 +1700,7 @@ components: description: If `true`, the query attempts to analyze wildcard terms in the query string. type: boolean auto_generate_synonyms_phrase_query: - description: If `true`, the parser creates a match_phrase query for each multi-position token. + description: If `true`, the parser creates a `match_phrase` query for each multi-position token. type: boolean default_operator: $ref: '#/components/schemas/Operator' @@ -1740,7 +1740,7 @@ components: required: - query SimpleQueryStringFlags: - description: Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`. + description: Query flags can be either a single flag or a combination of flags (e.g. `OR|AND|PREFIX`). allOf: - $ref: '_common.yaml#/components/schemas/PipeSeparatedFlagsSimpleQueryStringFlag' SimpleQueryStringFlag: @@ -1828,7 +1828,7 @@ components: - end - match SpanGapQuery: - description: Can only be used as a clause in a span_near query. + description: Can only be used as a clause in a `span_near` query. type: object additionalProperties: type: integer diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml index 7d9eb916a..45d8e901f 100644 --- a/spec/schemas/_common.yaml +++ b/spec/schemas/_common.yaml @@ -2043,7 +2043,7 @@ components: - master deprecated: true x-version-deprecated: '2.0' - x-deprecation-message: Use 'cluster_manager' instead. + x-deprecation-message: Use `cluster_manager` instead. - type: string enum: - cluster_manager diff --git a/spec/schemas/_core.bulk.yaml b/spec/schemas/_core.bulk.yaml index 6edfe319f..c0649db10 100644 --- a/spec/schemas/_core.bulk.yaml +++ b/spec/schemas/_core.bulk.yaml @@ -81,14 +81,14 @@ components: properties: detect_noop: description: |- - When `false` disables the setting 'result' in the response - to 'noop' if no change to the document occurred. + When `false` disables the 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: When `true`, uses the contents of 'doc' as the value of 'upsert'. + description: When `true`, uses the contents of `doc` as the value of `upsert`. type: boolean script: $ref: '_common.yaml#/components/schemas/Script' @@ -99,8 +99,8 @@ components: $ref: '_core.search.yaml#/components/schemas/SourceConfig' upsert: description: |- - If the document does not already exist, the contents of 'upsert' are inserted as a - new document. If the document exists, the 'script' is executed. + If the document does not already exist, the contents of `upsert` are inserted as a + new document. If the document exists, the `script` is executed. type: object ResponseItem: type: object diff --git a/spec/schemas/cat.fielddata.yaml b/spec/schemas/cat.fielddata.yaml index af3318a04..bc317db4e 100644 --- a/spec/schemas/cat.fielddata.yaml +++ b/spec/schemas/cat.fielddata.yaml @@ -16,7 +16,7 @@ components: description: hostname type: string ip: - description: ip address + description: IP address type: string node: description: node name diff --git a/spec/schemas/cat.nodes.yaml b/spec/schemas/cat.nodes.yaml index a3c578578..079452f01 100644 --- a/spec/schemas/cat.nodes.yaml +++ b/spec/schemas/cat.nodes.yaml @@ -102,20 +102,20 @@ components: master: description: |- Indicates whether the node is the elected cluster-manager node. - Returned values include `*`(elected master) and `-`(not elected master). + Returned values include `*`(elected cluster manager) and `-`(not elected cluster manager). type: string x-version-deprecated: '2.0' - x-deprecation-message: To promote inclusive language, use 'cluster_manager' instead. + x-deprecation-message: To promote inclusive language, use `cluster_manager` instead. name: $ref: '_common.yaml#/components/schemas/Name' completion.size: description: The size of completion. type: string fielddata.memory_size: - description: The used fielddata cache. + description: The used field data cache. type: string fielddata.evictions: - description: The fielddata evictions. + description: The field data evictions. type: string query_cache.memory_size: description: The used query cache. diff --git a/spec/schemas/cat.shards.yaml b/spec/schemas/cat.shards.yaml index 8d187d8be..c154792da 100644 --- a/spec/schemas/cat.shards.yaml +++ b/spec/schemas/cat.shards.yaml @@ -86,10 +86,10 @@ components: description: The size of completion. type: ['null', string] fielddata.memory_size: - description: The used fielddata cache memory. + description: The used field data cache memory. type: ['null', string] fielddata.evictions: - description: The fielddata cache evictions. + description: The field data cache evictions. type: ['null', string] query_cache.memory_size: description: The used query cache memory. diff --git a/spec/schemas/indices._common.yaml b/spec/schemas/indices._common.yaml index c1b6940a4..a9b4b7614 100644 --- a/spec/schemas/indices._common.yaml +++ b/spec/schemas/indices._common.yaml @@ -376,9 +376,9 @@ components: 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 - 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. + 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 step: $ref: '#/components/schemas/IndexSettingsLifecycleStep' @@ -625,7 +625,7 @@ components: limit: description: |- The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined - at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc. + at the root object level, then the depth is `1`. If there is one object mapping, then the depth is `2`. type: integer format: int64 IndexSettingsMappingLimitNestedFields: @@ -709,7 +709,7 @@ components: allow_mmap: description: |- You can restrict the use of the `mmapfs` and the related `hybridfs` store types with the setting `node.store.allow_mmap`. - This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This + This is a Boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This setting is useful, for example, if you are in an environment where you can not control the ability to create a lot of memory maps so you need disable the ability to use memory-mapping. type: boolean diff --git a/spec/schemas/ingest._common.yaml b/spec/schemas/ingest._common.yaml index 2f89ace33..735ad690a 100644 --- a/spec/schemas/ingest._common.yaml +++ b/spec/schemas/ingest._common.yaml @@ -203,7 +203,7 @@ components: target_fields: $ref: '_common.yaml#/components/schemas/Fields' trim: - description: Trim whitespaces in unquoted fields. + description: Trim white spaces in unquoted fields. type: boolean required: - field @@ -271,8 +271,8 @@ components: properties: date_formats: description: |- - An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. - Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + An array of the expected date formats for parsing dates/timestamps in the document being preprocessed. + Can be a java time pattern or one of the following formats: `ISO8601`, `UNIX`, `UNIX_MS`, or `TAI64N`. type: array items: type: string @@ -492,7 +492,7 @@ components: - type: object properties: database_file: - description: The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + description: The database filename referring to a database the module ships with (`GeoLite2-City.mmdb`, `GeoLite2-Country.mmdb`, or `GeoLite2-ASN.mmdb`) or a custom database in the `ingest-geoip` config directory. type: string field: $ref: '_common.yaml#/components/schemas/Field' diff --git a/spec/schemas/nodes._common.yaml b/spec/schemas/nodes._common.yaml index c79563e7a..8b4e8ba17 100644 --- a/spec/schemas/nodes._common.yaml +++ b/spec/schemas/nodes._common.yaml @@ -1008,8 +1008,8 @@ components: $ref: '#/components/schemas/PublishedClusterStates' cluster_state_update: description: |- - Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master. - Omitted if the node is not master-eligible. + Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected cluster manager. + Omitted if the node is not cluster-manager-eligible. Every field whose name ends in `_time` within this object is also represented as a raw number of milliseconds in a field whose name ends in `_time_millis`. The human-readable fields with a `_time` suffix are only returned if requested with the `?human=true` query parameter. type: object diff --git a/tests/default/nodes/hot_threads.yaml b/tests/default/nodes/hot_threads.yaml index a496228c7..f4c0a7b11 100644 --- a/tests/default/nodes/hot_threads.yaml +++ b/tests/default/nodes/hot_threads.yaml @@ -21,7 +21,7 @@ chapters: response: status: 200 content_type: text/plain - - synopsis: Get _all node busy JVM threads (node_id). + - synopsis: Get `_all` node busy JVM threads (node_id). path: /_nodes/{node_id}/hot_threads method: GET parameters: diff --git a/tests/default/nodes/stats.yaml b/tests/default/nodes/stats.yaml index aeddd5364..a54f284ae 100644 --- a/tests/default/nodes/stats.yaml +++ b/tests/default/nodes/stats.yaml @@ -21,7 +21,7 @@ chapters: include_segment_file_sizes: true response: status: 200 - - synopsis: Get _all node stats (node_id). + - synopsis: Get `_all` node stats (node_id). path: /_nodes/{node_id}/stats method: GET parameters: diff --git a/tests/default/security/api/allowlist.yaml b/tests/default/security/api/allowlist.yaml index 5c0b29a8e..a11583866 100644 --- a/tests/default/security/api/allowlist.yaml +++ b/tests/default/security/api/allowlist.yaml @@ -7,7 +7,7 @@ distributions: - amazon-managed - amazon-serverless -# ADMIN-CERT only. These tests require explicit rest api admin privileges. +# ADMIN-CERT only. These tests require explicit REST API admin privileges. chapters: - synopsis: Create an allowlist. path: /_plugins/_security/api/allowlist diff --git a/tests/default/security/api/certificates.yaml b/tests/default/security/api/certificates.yaml index a1e868157..5fefc85f0 100644 --- a/tests/default/security/api/certificates.yaml +++ b/tests/default/security/api/certificates.yaml @@ -7,7 +7,7 @@ distributions: - amazon-managed - amazon-serverless -# ADMIN-CERT only. These tests require explicit rest api admin privileges. +# ADMIN-CERT only. These tests require explicit REST API admin privileges. prologues: - path: /_cat/nodes id: node diff --git a/tests/default/security/api/securityconfig.yaml b/tests/default/security/api/securityconfig.yaml index 3c961343b..ad4ef61d9 100644 --- a/tests/default/security/api/securityconfig.yaml +++ b/tests/default/security/api/securityconfig.yaml @@ -7,7 +7,7 @@ distributions: - amazon-managed - amazon-serverless -# ADMIN-CERT only (except GET). These tests require explicit rest api admin privileges. +# ADMIN-CERT only (except GET). These tests require explicit REST API admin privileges. chapters: - synopsis: Get a security config. path: /_plugins/_security/api/securityconfig diff --git a/tests/default/security/api/securityconfig/config.yaml b/tests/default/security/api/securityconfig/config.yaml index 8b888f277..6da49012d 100644 --- a/tests/default/security/api/securityconfig/config.yaml +++ b/tests/default/security/api/securityconfig/config.yaml @@ -7,7 +7,7 @@ distributions: - amazon-managed - amazon-serverless -# ADMIN-CERT only (except GET). These tests require explicit rest api admin privileges. +# ADMIN-CERT only (except GET). These tests require explicit REST API admin privileges. chapters: - synopsis: Update a security config. path: /_plugins/_security/api/securityconfig/config diff --git a/tests/default/security/api/ssl/certs.yaml b/tests/default/security/api/ssl/certs.yaml index c888789cb..6eec0e9e2 100644 --- a/tests/default/security/api/ssl/certs.yaml +++ b/tests/default/security/api/ssl/certs.yaml @@ -7,7 +7,7 @@ distributions: - amazon-managed - amazon-serverless -# ADMIN-CERT only. These tests require explicit rest api admin privileges. +# ADMIN-CERT only. These tests require explicit REST API admin privileges. chapters: - synopsis: Get ssl certificates. path: /_plugins/_security/api/ssl/certs diff --git a/tests/default/security/api/ssl/http/reloadcerts.yaml b/tests/default/security/api/ssl/http/reloadcerts.yaml index 6c16242b0..34800b6c0 100644 --- a/tests/default/security/api/ssl/http/reloadcerts.yaml +++ b/tests/default/security/api/ssl/http/reloadcerts.yaml @@ -7,7 +7,7 @@ distributions: - amazon-managed - amazon-serverless -# ADMIN-CERT only. These tests require explicit rest api admin privileges. +# ADMIN-CERT only. These tests require explicit REST API admin privileges. chapters: - synopsis: Reload http certs. path: /_plugins/_security/api/ssl/http/reloadcerts diff --git a/tests/default/security/api/ssl/transport/reloadcerts.yaml b/tests/default/security/api/ssl/transport/reloadcerts.yaml index 41431e00b..26f78fd63 100644 --- a/tests/default/security/api/ssl/transport/reloadcerts.yaml +++ b/tests/default/security/api/ssl/transport/reloadcerts.yaml @@ -7,7 +7,7 @@ distributions: - amazon-managed - amazon-serverless -# ADMIN-CERT only. These tests require explicit rest api admin privileges. +# ADMIN-CERT only. These tests require explicit REST API admin privileges. chapters: - synopsis: Reload transport certs. path: /_plugins/_security/api/ssl/transport/reloadcerts diff --git a/tests/default/security/api/upgrade_check.yaml b/tests/default/security/api/upgrade_check.yaml index 8cb9c7789..a7d5d8755 100644 --- a/tests/default/security/api/upgrade_check.yaml +++ b/tests/default/security/api/upgrade_check.yaml @@ -1,6 +1,6 @@ $schema: ../../../../json_schemas/test_story.schema.yaml -description: Test _upgrade_check endpoint. +description: Test `_upgrade_check` endpoint. version: '> 2.13' distributions: excluded: diff --git a/tests/default/security/api/upgrade_perform.yaml b/tests/default/security/api/upgrade_perform.yaml index 39e452f83..c320ca6cf 100644 --- a/tests/default/security/api/upgrade_perform.yaml +++ b/tests/default/security/api/upgrade_perform.yaml @@ -1,6 +1,6 @@ $schema: ../../../../json_schemas/test_story.schema.yaml -description: Test _upgrade_perform endpoint. +description: Test `_upgrade_perform` endpoint. version: '> 2.13' distributions: excluded: diff --git a/tests/snapshot/snapshot/restore.yaml b/tests/snapshot/snapshot/restore.yaml index 970a39f00..475070290 100644 --- a/tests/snapshot/snapshot/restore.yaml +++ b/tests/snapshot/snapshot/restore.yaml @@ -54,7 +54,7 @@ prologues: method: DELETE status: [200, 404] chapters: - - synopsis: Restore snapshot with wait_for_completion true. + - synopsis: Restore snapshot with `wait_for_completion` true. path: /_snapshot/{repository}/{snapshot}/_restore method: POST parameters: @@ -69,7 +69,7 @@ chapters: payload: snapshot: snapshot: my-test-snapshot - - synopsis: Restore snapshot with wait_for_completion false. + - synopsis: Restore snapshot with `wait_for_completion` false. path: /_snapshot/{repository}/{snapshot}/_restore method: POST parameters: diff --git a/tools/tests/tester/fixtures/evals/passed/value_type.yaml b/tools/tests/tester/fixtures/evals/passed/value_type.yaml index e2ad0269c..ec5a64be9 100644 --- a/tools/tests/tester/fixtures/evals/passed/value_type.yaml +++ b/tools/tests/tester/fixtures/evals/passed/value_type.yaml @@ -20,7 +20,7 @@ epilogues: result: PASSED title: DELETE /movies chapters: - - title: This chapter requires a boolean in the parameters. + - title: This chapter requires a Boolean in the parameters. overall: result: PASSED path: GET /_cat/health @@ -44,7 +44,7 @@ chapters: result: PASSED output_values: result: SKIPPED - - title: This chapter requires a boolean in the body. + - title: This chapter requires a Boolean in the body. overall: result: PASSED path: PUT /{index} diff --git a/tools/tests/tester/fixtures/stories/passed/value_type.yaml b/tools/tests/tester/fixtures/stories/passed/value_type.yaml index ffc7b6b85..e69cec486 100644 --- a/tools/tests/tester/fixtures/stories/passed/value_type.yaml +++ b/tools/tests/tester/fixtures/stories/passed/value_type.yaml @@ -13,13 +13,13 @@ epilogues: path: /movies status: [200, 404] chapters: - - synopsis: This chapter requires a boolean in the parameters. + - synopsis: This chapter requires a Boolean in the parameters. method: GET path: /_cat/health parameters: format: json v: ${root.boolean} - - synopsis: This chapter requires a boolean in the body. + - synopsis: This chapter requires a Boolean in the body. method: PUT path: /{index} parameters: