Skip to content

Commit

Permalink
- Removed line-wrap for all yaml files (#218)
Browse files Browse the repository at this point in the history
Signed-off-by: Theo Truong <[email protected]>
  • Loading branch information
nhtruong committed Apr 9, 2024
1 parent 5e24c72 commit aa82356
Show file tree
Hide file tree
Showing 33 changed files with 386 additions and 959 deletions.
330 changes: 89 additions & 241 deletions spec/namespaces/_core.yaml

Large diffs are not rendered by default.

15 changes: 5 additions & 10 deletions spec/namespaces/cat.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -955,8 +955,7 @@ components:
cat.aliases::path.name:
in: path
name: name
description: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit
this parameter or use `*` or `_all`.
description: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.
required: true
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Names'
Expand Down Expand Up @@ -2158,12 +2157,10 @@ components:
cat.segment_replication::query.allow_no_indices:
name: allow_no_indices
in: query
description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all`
string or when no indices have been specified).
description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).
schema:
type: boolean
description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all`
string or when no indices have been specified).
description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).
cat.segment_replication::query.bytes:
name: bytes
in: query
Expand Down Expand Up @@ -2588,15 +2585,13 @@ components:
cat.tasks::query.nodes:
name: nodes
in: query
description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return
information from the node you're connecting to, leave empty to get information from all nodes.
description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
style: form
schema:
type: array
items:
type: string
description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return
information from the node you're connecting to, leave empty to get information from all nodes.
description: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
explode: true
cat.tasks::query.parent_task_id:
in: query
Expand Down
49 changes: 15 additions & 34 deletions spec/namespaces/cluster.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -458,8 +458,7 @@ components:
type: object
properties:
current_node:
description: Specifies the node ID or the name of the node to only explain a shard that is currently located on the
specified node.
description: Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node.
type: string
index:
$ref: '../schemas/_common.yaml#/components/schemas/IndexName'
Expand Down Expand Up @@ -946,9 +945,7 @@ components:
cluster.health::path.index:
in: path
name: index
description: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard
expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use
_all or *.
description: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.
required: true
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Indices'
Expand Down Expand Up @@ -984,16 +981,14 @@ 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 master node.
schema:
type: boolean
style: form
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 master 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'
Expand All @@ -1003,48 +998,42 @@ components:
cluster.health::query.timeout:
in: query
name: timeout
description: Period to wait for a response. If no response is received before the timeout expires, the request fails and
returns an error.
description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
cluster.health::query.wait_for_active_shards:
in: query
name: wait_for_active_shards
description: A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be
active, or 0 to not wait.
description: A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards'
style: form
cluster.health::query.wait_for_events:
in: query
name: wait_for_events
description: Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with
the given priority are processed.
description: Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/WaitForEvents'
style: form
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
cluster.health::query.wait_for_nodes:
in: query
name: wait_for_nodes
description: The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N.
Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation.
description: The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation.
schema:
oneOf:
- type: string
Expand All @@ -1053,8 +1042,7 @@ components:
cluster.health::query.wait_for_status:
in: query
name: wait_for_status
description: One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes
to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status.
description: One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/HealthStatus'
style: form
Expand Down Expand Up @@ -1118,15 +1106,11 @@ components:
cluster.put_component_template::path.name:
in: path
name: name
description: >-
description: |-
Name of the component template to create.
Opensearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.
Opensearch Agent uses these templates to configure backing indices for its data streams.
If you use Opensearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.
If you don’t use Opensearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.
required: true
schema:
Expand Down Expand Up @@ -1246,8 +1230,7 @@ components:
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 master 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'
Expand All @@ -1271,8 +1254,7 @@ components:
cluster.reroute::query.timeout:
in: query
name: timeout
description: Period to wait for a response. If no response is received before the timeout expires, the request fails and
returns an error.
description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Duration'
style: form
Expand All @@ -1295,8 +1277,7 @@ components:
cluster.state::query.allow_no_indices:
in: query
name: allow_no_indices
description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all`
string or when no indices have been specified)
description: Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
schema:
type: boolean
style: form
Expand Down
Loading

0 comments on commit aa82356

Please sign in to comment.