diff --git a/CLIENT_GENERATOR_GUIDE.md b/CLIENT_GENERATOR_GUIDE.md index 0d4f2e0d5..bcee89ad0 100644 --- a/CLIENT_GENERATOR_GUIDE.md +++ b/CLIENT_GENERATOR_GUIDE.md @@ -52,3 +52,9 @@ Some operations accept a bulk of data in the request body. For example, the `bul As of right now, most clients only validate whether required parameters are present. The clients do not validate the values of parameters against the enum values or regex patterns. This is to reduce performance overhead for the clients as the validation is already done on the server. However, the list of enum values and regex patterns are often written into the parameter description. Some clients also check for the validity of query string parameter names to guard the users from typos. If you decide to implement this feature, make sure that it's performant. Scripting languages like Python and Ruby require the code to be loaded into memory at runtime, and constructs used for this feature can be expensive to load, as far as micro-services are concerned. + +## Global Parameters +All operations in the spec contain a set of parameters that are common across all operations. These parameters are denoted with `x-global: true` vendor extension. The generated clients should find a way to DRY these parameters. + +## Default Parameter Values +Parameters can have default values either through schema or the `x-default` vendor extension. When both are present, `x-default` will takes precedence. \ No newline at end of file diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 2b6a5dbfd..06520a13d 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -82,6 +82,7 @@ This repository includes several penAPI Specification Extensions to fill in any - `x-deprecation-message`: Reason for deprecation and guidance on how to prepare for the next major version. - `x-ignorable`: Denotes that the operation should be ignored by the client generator. This is used in operation groups where some operations have been replaced by newer ones, but we still keep them in the specs because the server still supports them. - `x-global`: Denotes that the parameter is a global parameter that is included in every operation. These parameters are listed in the [root file](spec/opensearch-openapi.yaml). +- `x-default`: Contains the default value of a parameter. This is often used to override the default value specified in the schema, or to avoid accidentally changing the default value when updating a shared schema. ## Linting We have a linter that validates every `yaml` file in the `./spec` folder to assure that they follow the guidelines we have set. Check out the [Linter](tools/README.md#linter) tool for more information on how to run it locally. Make sure to run the linter before submitting a PR. diff --git a/spec/namespaces/_core.yaml b/spec/namespaces/_core.yaml index f20320723..c612d1590 100644 --- a/spec/namespaces/_core.yaml +++ b/spec/namespaces/_core.yaml @@ -3277,6 +3277,7 @@ components: description: If `true`, the request’s actions must target an index alias. schema: type: boolean + default: false style: form bulk::query.routing: in: query @@ -3308,6 +3309,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' style: form + x-default: '1' clear_scroll::path.scroll_id: in: path name: scroll_id @@ -3346,6 +3348,7 @@ components: This parameter can only be used when the `q` query string parameter is specified. schema: type: boolean + default: false style: form count::query.analyzer: in: query @@ -3420,6 +3423,7 @@ components: Random by default. schema: type: string + default: random style: form count::query.q: in: query @@ -3522,6 +3526,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' style: form + x-default: '1' create_pit::path.index: name: index in: path @@ -3648,6 +3653,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' style: form + x-default: '1' delete_by_query::path.index: in: path name: index @@ -3708,6 +3714,7 @@ components: description: If `true`, wildcard and prefix queries are analyzed. schema: type: boolean + default: false style: form delete_by_query::query.analyzer: in: query @@ -3753,6 +3760,7 @@ components: description: 'Starting offset (default: 0)' schema: type: number + default: 0 style: form delete_by_query::query.ignore_unavailable: in: query @@ -3785,6 +3793,7 @@ components: Random by default. schema: type: string + default: random style: form delete_by_query::query.q: in: query @@ -3815,6 +3824,7 @@ components: description: The throttle for this request in sub-requests per second. schema: type: number + default: 0 style: form delete_by_query::query.routing: in: query @@ -3836,6 +3846,7 @@ components: description: Size of the scroll request that powers the operation. schema: type: number + default: 100 style: form delete_by_query::query.search_timeout: in: query @@ -3870,6 +3881,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Slices' style: form + x-default: '1' delete_by_query::query.sort: in: query name: sort @@ -3909,6 +3921,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form + x-default: 1m delete_by_query::query.version: in: query name: version @@ -3925,12 +3938,14 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' style: form + x-default: '1' delete_by_query::query.wait_for_completion: in: query name: wait_for_completion description: If `true`, the request blocks until the operation is complete. schema: type: boolean + default: true style: form delete_by_query_rethrottle::path.task_id: in: path @@ -4030,6 +4045,7 @@ components: Random by default. schema: type: string + default: random style: form exists::query.realtime: in: query @@ -4125,6 +4141,7 @@ components: Random by default. schema: type: string + default: random style: form exists_source::query.realtime: in: query @@ -4208,6 +4225,7 @@ components: description: If `true`, wildcard and prefix queries are analyzed. schema: type: boolean + default: false style: form explain::query.analyzer: in: query @@ -4231,6 +4249,7 @@ components: description: Field to use as default where no field prefix is given in the query string. schema: type: string + default: _all style: form explain::query.lenient: in: query @@ -4247,6 +4266,7 @@ components: Random by default. schema: type: string + default: random style: form explain::query.q: in: query @@ -4314,6 +4334,7 @@ components: description: If true, unmapped fields are included in the response. schema: type: boolean + default: false style: form get::path.id: in: path @@ -4358,6 +4379,7 @@ components: description: Specifies the node or shard the operation should be performed on. Random by default. schema: type: string + default: random style: form get::query.realtime: in: query @@ -4472,6 +4494,7 @@ components: description: Specifies the node or shard the operation should be performed on. Random by default. schema: type: string + default: random style: form get_source::query.realtime: in: query @@ -4576,6 +4599,7 @@ components: description: If `true`, the destination must be an index alias. schema: type: boolean + default: false style: form index::query.routing: in: query @@ -4616,6 +4640,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' style: form + x-default: '1' mget::path.index: in: path name: index @@ -4656,6 +4681,7 @@ components: description: Specifies the node or shard the operation should be performed on. Random by default. schema: type: string + default: random style: form mget::query.realtime: in: query @@ -4699,6 +4725,7 @@ components: description: If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. schema: type: boolean + default: true style: form msearch::query.max_concurrent_searches: in: query @@ -4713,6 +4740,7 @@ components: description: Maximum number of concurrent shard requests that each sub-search request executes per node. schema: type: number + default: 5 style: form msearch::query.pre_filter_shard_size: in: query @@ -4727,6 +4755,7 @@ components: 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 style: form msearch::query.search_type: in: query @@ -4759,6 +4788,7 @@ components: description: If `true`, network round-trips are minimized for cross-cluster search requests. schema: type: boolean + default: true style: form msearch_template::query.max_concurrent_searches: in: query @@ -4775,6 +4805,7 @@ components: If `false`, it returns `hits.total` as an object. schema: type: boolean + default: false style: form msearch_template::query.search_type: in: query @@ -4806,6 +4837,7 @@ components: description: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. schema: type: boolean + default: true style: form mtermvectors::query.fields: in: query @@ -4831,6 +4863,7 @@ components: description: If `true`, the response includes term offsets. schema: type: boolean + default: true style: form mtermvectors::query.payloads: in: query @@ -4838,6 +4871,7 @@ components: description: If `true`, the response includes term payloads. schema: type: boolean + default: true style: form mtermvectors::query.positions: in: query @@ -4845,6 +4879,7 @@ components: description: If `true`, the response includes term positions. schema: type: boolean + default: true style: form mtermvectors::query.preference: in: query @@ -4854,6 +4889,7 @@ components: Random by default. schema: type: string + default: random style: form mtermvectors::query.realtime: in: query @@ -4861,6 +4897,7 @@ components: description: If true, the request is real-time as opposed to near-real-time. schema: type: boolean + default: true style: form mtermvectors::query.routing: in: query @@ -4875,6 +4912,7 @@ components: description: If true, the response includes term frequency and document frequency. schema: type: boolean + default: false style: form mtermvectors::query.version: in: query @@ -4999,6 +5037,7 @@ components: Defaults to no throttle. schema: type: number + default: 0 style: form reindex::query.scroll: in: query @@ -5016,6 +5055,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Slices' style: form + x-default: '1' reindex::query.timeout: in: query name: timeout @@ -5023,6 +5063,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form + x-default: 1m reindex::query.wait_for_active_shards: in: query name: wait_for_active_shards @@ -5032,12 +5073,14 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' style: form + x-default: '1' reindex::query.wait_for_completion: in: query name: wait_for_completion description: If `true`, the request blocks until the operation is complete. schema: type: boolean + default: true style: form reindex_rethrottle::path.task_id: in: path @@ -5079,6 +5122,7 @@ components: description: If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. schema: type: boolean + default: false style: form scroll::query.scroll: in: query @@ -5156,6 +5200,7 @@ components: description: If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. schema: type: boolean + default: true style: form search::query.analyze_wildcard: in: query @@ -5165,6 +5210,7 @@ components: This parameter can only be used when the q query string parameter is specified. schema: type: boolean + default: false style: form search::query.analyzer: in: query @@ -5183,6 +5229,7 @@ components: This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. schema: type: number + default: 512 style: form search::query.ccs_minimize_roundtrips: in: query @@ -5190,6 +5237,7 @@ components: description: If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. schema: type: boolean + default: true style: form search::query.default_operator: in: query @@ -5243,6 +5291,7 @@ components: To page through more hits, use the `search_after` parameter. schema: type: number + default: 0 style: form search::query.ignore_throttled: in: query @@ -5283,6 +5332,7 @@ components: This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. schema: type: number + default: 5 style: form search::query.pre_filter_shard_size: in: query @@ -5311,6 +5361,7 @@ components: `` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. schema: type: string + default: random style: form search::query.q: in: query @@ -5336,6 +5387,7 @@ components: description: Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. schema: type: boolean + default: false style: form search::query.routing: in: query @@ -5384,6 +5436,7 @@ components: To page through more hits, use the `search_after` parameter. schema: type: number + default: 10 style: form search::query.sort: in: query @@ -5547,6 +5600,7 @@ components: description: If `true`, the request retrieves information from the local node only. schema: type: boolean + default: false style: form search_shards::query.preference: in: query @@ -5556,6 +5610,7 @@ components: Random by default. schema: type: string + default: random style: form search_shards::query.routing: in: query @@ -5590,6 +5645,7 @@ components: description: If `true`, network round-trips are minimized for cross-cluster search requests. schema: type: boolean + default: true style: form search_template::query.expand_wildcards: in: query @@ -5631,6 +5687,7 @@ components: Random by default. schema: type: string + default: random style: form search_template::query.profile: in: query @@ -5645,6 +5702,7 @@ components: description: If true, hits.total are rendered as an integer in the response. schema: type: boolean + default: false style: form search_template::query.routing: in: query @@ -5698,6 +5756,7 @@ components: description: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. schema: type: boolean + default: true style: form termvectors::query.fields: in: query @@ -5714,6 +5773,7 @@ components: description: If `true`, the response includes term offsets. schema: type: boolean + default: true style: form termvectors::query.payloads: in: query @@ -5721,6 +5781,7 @@ components: description: If `true`, the response includes term payloads. schema: type: boolean + default: true style: form termvectors::query.positions: in: query @@ -5728,6 +5789,7 @@ components: description: If `true`, the response includes term positions. schema: type: boolean + default: true style: form termvectors::query.preference: in: query @@ -5737,6 +5799,7 @@ components: Random by default. schema: type: string + default: random style: form termvectors::query.realtime: in: query @@ -5744,6 +5807,7 @@ components: description: If true, the request is real-time as opposed to near-real-time. schema: type: boolean + default: true style: form termvectors::query.routing: in: query @@ -5758,6 +5822,7 @@ components: description: If `true`, the response includes term frequency and document frequency. schema: type: boolean + default: false style: form termvectors::query.version: in: query @@ -5832,6 +5897,7 @@ components: description: The script language. schema: type: string + default: painless style: form update::query.refresh: in: query @@ -5849,6 +5915,7 @@ components: description: If true, the destination must be an index alias. schema: type: boolean + default: false style: form update::query.retry_on_conflict: in: query @@ -5856,6 +5923,7 @@ components: description: Specify how many times should the operation be retried when a conflict occurs. schema: type: number + default: 0 style: form update::query.routing: in: query @@ -5884,6 +5952,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' style: form + x-default: '1' update_by_query::path.index: in: path name: index @@ -5944,6 +6013,7 @@ components: description: If `true`, wildcard and prefix queries are analyzed. schema: type: boolean + default: false style: form update_by_query::query.analyzer: in: query @@ -5990,6 +6060,7 @@ components: description: 'Starting offset (default: 0)' schema: type: number + default: 0 style: form update_by_query::query.ignore_unavailable: in: query @@ -6032,6 +6103,7 @@ components: Random by default. schema: type: string + default: random style: form update_by_query::query.q: name: q @@ -6060,6 +6132,7 @@ components: description: The throttle for this request in sub-requests per second. schema: type: number + default: 0 style: form update_by_query::query.routing: in: query @@ -6081,6 +6154,7 @@ components: description: Size of the scroll request that powers the operation. schema: type: number + default: 100 style: form update_by_query::query.search_timeout: in: query @@ -6111,6 +6185,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Slices' style: form + x-default: '1' update_by_query::query.sort: in: query name: sort @@ -6150,6 +6225,7 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/Duration' style: form + x-default: 1m update_by_query::query.version: in: query name: version @@ -6166,12 +6242,14 @@ components: schema: $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' style: form + x-default: '1' update_by_query::query.wait_for_completion: in: query name: wait_for_completion description: If `true`, the request blocks until the operation is complete. schema: type: boolean + default: true style: form update_by_query_rethrottle::path.task_id: in: path diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml index 552b32cbc..8c808e543 100644 --- a/spec/namespaces/cat.yaml +++ b/spec/namespaces/cat.yaml @@ -1422,6 +1422,7 @@ components: description: If true, returns `HH:MM:SS` and Unix epoch timestamps. schema: type: boolean + default: true style: form cat.health::query.v: name: v @@ -1520,6 +1521,7 @@ components: description: If true, the response includes information from segments that are not loaded into memory. schema: type: boolean + default: false style: form cat.indices::query.local: name: local @@ -1544,6 +1546,7 @@ components: description: If true, the response only includes information from primary shards. schema: type: boolean + default: false style: form cat.indices::query.s: name: s @@ -1738,6 +1741,7 @@ components: oneOf: - type: boolean - type: string + default: false style: form cat.nodes::query.h: name: h @@ -2014,6 +2018,7 @@ components: description: If `true`, the response only includes ongoing shard recoveries. schema: type: boolean + default: false style: form cat.recovery::query.bytes: in: query @@ -2028,6 +2033,7 @@ components: description: If `true`, the response includes detailed information about shard recoveries. schema: type: boolean + default: false style: form cat.recovery::query.format: name: format @@ -2529,6 +2535,7 @@ components: description: If `true`, the response does not include information from unavailable snapshots. schema: type: boolean + default: false style: form cat.snapshots::query.master_timeout: name: master_timeout @@ -2579,6 +2586,7 @@ components: description: If `true`, the response includes detailed information about shard recoveries. schema: type: boolean + default: false style: form cat.tasks::query.format: name: format diff --git a/spec/namespaces/cluster.yaml b/spec/namespaces/cluster.yaml index eb6d673f6..7019da98e 100644 --- a/spec/namespaces/cluster.yaml +++ b/spec/namespaces/cluster.yaml @@ -762,6 +762,7 @@ components: description: If true, returns information about disk usage and shard sizes. schema: type: boolean + default: false style: form cluster.allocation_explain::query.include_yes_decisions: in: query @@ -769,6 +770,7 @@ components: description: If true, returns YES decisions in explanation. schema: type: boolean + default: false style: form cluster.delete_component_template::path.name: in: path @@ -820,6 +822,7 @@ components: nodes are still in the cluster. schema: type: boolean + default: true style: form cluster.exists_component_template::path.name: in: path @@ -846,6 +849,7 @@ components: Defaults to false, which means information is retrieved from the master node. schema: type: boolean + default: false style: form cluster.exists_component_template::query.master_timeout: in: query @@ -885,6 +889,7 @@ components: If `false`, information is retrieved from the master node. schema: type: boolean + default: false style: form cluster.get_component_template::query.master_timeout: in: query @@ -920,6 +925,7 @@ components: description: If `true`, returns settings in flat format. schema: type: boolean + default: false style: form cluster.get_settings::query.include_defaults: in: query @@ -927,6 +933,7 @@ components: description: If `true`, returns default cluster settings from the local node. schema: type: boolean + default: false style: form cluster.get_settings::query.master_timeout: in: query @@ -1000,6 +1007,7 @@ components: 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 + default: false style: form cluster.health::query.master_timeout: in: query @@ -1077,6 +1085,7 @@ components: If `false`, information is retrieved from the master node. schema: type: boolean + default: false style: form cluster.pending_tasks::query.master_timeout: in: query @@ -1145,6 +1154,7 @@ components: description: If `true`, this request cannot replace or update existing component templates. schema: type: boolean + default: false style: form cluster.put_component_template::query.master_timeout: in: query @@ -1195,6 +1205,7 @@ components: description: 'Return settings in flat format (default: false)' schema: type: boolean + default: false style: form cluster.put_settings::query.master_timeout: in: query @@ -1319,6 +1330,7 @@ components: description: 'Return settings in flat format (default: false)' schema: type: boolean + default: false style: form cluster.state::query.ignore_unavailable: in: query @@ -1333,6 +1345,7 @@ components: description: 'Return local information, do not retrieve the state from cluster-manager node (default: false)' schema: type: boolean + default: false style: form cluster.state::query.master_timeout: in: query @@ -1372,6 +1385,7 @@ components: description: If `true`, returns settings in flat format. schema: type: boolean + default: false style: form cluster.stats::query.timeout: in: query diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml index 569fabd16..e8ee03597 100644 --- a/spec/namespaces/indices.yaml +++ b/spec/namespaces/indices.yaml @@ -3011,6 +3011,7 @@ components: This behavior applies even if the request targets other open indices. schema: type: boolean + default: false style: form indices.delete::query.cluster_manager_timeout: name: cluster_manager_timeout @@ -3036,6 +3037,7 @@ components: description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean + default: false style: form indices.delete::query.master_timeout: in: query @@ -3200,6 +3202,7 @@ components: This behavior applies even if the request targets other open indices. schema: type: boolean + default: false style: form indices.exists::query.expand_wildcards: in: query @@ -3218,6 +3221,7 @@ components: description: If `true`, returns settings in flat format. schema: type: boolean + default: false style: form indices.exists::query.ignore_unavailable: in: query @@ -3225,6 +3229,7 @@ components: description: If `false`, the request returns an error if it targets a missing or closed index. schema: type: boolean + default: false style: form indices.exists::query.include_defaults: in: query @@ -3232,6 +3237,7 @@ components: description: If `true`, return all default settings in the response. schema: type: boolean + default: false style: form indices.exists::query.local: in: query @@ -3239,6 +3245,7 @@ components: description: If `true`, the request retrieves information from the local node only. schema: type: boolean + default: false style: form indices.exists_alias::path.index: in: path @@ -3291,6 +3298,7 @@ components: description: If `true`, the request retrieves information from the local node only. schema: type: boolean + default: false style: form indices.exists_index_template::path.name: in: path @@ -3354,6 +3362,7 @@ components: description: 'Return settings in flat format (default: false)' schema: type: boolean + default: false style: form indices.exists_template::query.local: in: query @@ -3361,6 +3370,7 @@ components: description: 'Return local information, do not retrieve the state from cluster-manager node (default: false)' schema: type: boolean + default: false style: form indices.exists_template::query.master_timeout: in: query @@ -3425,6 +3435,7 @@ components: If `false`, Opensearch returns an error if you request a flush when another flush operation is running. schema: type: boolean + default: true style: form indices.forcemerge::path.index: in: path @@ -3454,6 +3465,7 @@ components: description: 'Specify whether the index should be flushed after performing the operation (default: true)' schema: type: boolean + default: true style: form indices.forcemerge::query.ignore_unavailable: in: query @@ -3490,6 +3502,7 @@ components: description: Should the request wait until the force merge is completed. schema: type: boolean + default: true style: form indices.get::path.index: in: path @@ -3510,6 +3523,7 @@ components: a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. schema: type: boolean + default: false style: form indices.get::query.cluster_manager_timeout: name: cluster_manager_timeout @@ -3534,6 +3548,7 @@ components: description: If true, returns settings in flat format. schema: type: boolean + default: false style: form indices.get::query.ignore_unavailable: in: query @@ -3541,6 +3556,7 @@ components: description: If false, requests that target a missing index return an error. schema: type: boolean + default: false style: form indices.get::query.include_defaults: in: query @@ -3548,6 +3564,7 @@ components: description: If true, return all default settings in the response. schema: type: boolean + default: false style: form indices.get::query.local: in: query @@ -3555,6 +3572,7 @@ components: 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 + default: false style: form indices.get::query.master_timeout: in: query @@ -3621,6 +3639,7 @@ components: description: If `true`, the request retrieves information from the local node only. schema: type: boolean + default: false style: form indices.get_data_stream::path.name: in: path @@ -3691,6 +3710,7 @@ components: description: If `true`, the request retrieves information from the local node only. schema: type: boolean + default: false style: form indices.get_index_template::path.name: in: path @@ -3713,6 +3733,7 @@ components: description: If true, returns settings in flat format. schema: type: boolean + default: false style: form indices.get_index_template::query.local: in: query @@ -3720,6 +3741,7 @@ components: 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 + default: false style: form indices.get_index_template::query.master_timeout: in: query @@ -3782,6 +3804,7 @@ components: description: If `true`, the request retrieves information from the local node only. schema: type: boolean + default: false style: form indices.get_mapping::query.master_timeout: in: query @@ -3849,6 +3872,7 @@ components: description: If `true`, returns settings in flat format. schema: type: boolean + default: false style: form indices.get_settings::query.ignore_unavailable: in: query @@ -3863,6 +3887,7 @@ components: description: If `true`, return all default settings in the response. schema: type: boolean + default: false style: form indices.get_settings::query.local: in: query @@ -3872,6 +3897,7 @@ components: `false`, information is retrieved from the master node. schema: type: boolean + default: false style: form indices.get_settings::query.master_timeout: in: query @@ -3910,6 +3936,7 @@ components: description: If `true`, returns settings in flat format. schema: type: boolean + default: false style: form indices.get_template::query.local: in: query @@ -3917,6 +3944,7 @@ components: description: If `true`, the request retrieves information from the local node only. schema: type: boolean + default: false style: form indices.get_template::query.master_timeout: in: query @@ -4130,6 +4158,7 @@ components: description: If `true`, this request cannot replace or update existing index templates. schema: type: boolean + default: false style: form indices.put_index_template::query.master_timeout: name: master_timeout @@ -4209,6 +4238,7 @@ components: description: If `true`, the mappings are applied only to the current write index for the target. schema: type: boolean + default: false style: form indices.put_settings::path.index: in: path @@ -4257,6 +4287,7 @@ components: description: If `true`, returns settings in flat format. schema: type: boolean + default: false style: form indices.put_settings::query.ignore_unavailable: in: query @@ -4284,6 +4315,7 @@ components: description: If `true`, existing index settings remain unchanged. schema: type: boolean + default: false style: form indices.put_settings::query.timeout: in: query @@ -4315,6 +4347,7 @@ components: description: If true, this request cannot replace or update existing index templates. schema: type: boolean + default: false style: form indices.put_template::query.master_timeout: in: query @@ -4357,6 +4390,7 @@ components: description: If `true`, the response only includes ongoing shard recoveries. schema: type: boolean + default: false style: form indices.recovery::query.detailed: in: query @@ -4364,6 +4398,7 @@ components: description: If `true`, the response includes detailed information about shard recoveries. schema: type: boolean + default: false style: form indices.refresh::path.index: in: path @@ -4456,6 +4491,7 @@ components: description: If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. schema: type: boolean + default: false style: form indices.rollover::query.master_timeout: in: query @@ -4531,6 +4567,7 @@ components: description: If `true`, the request returns a verbose response. schema: type: boolean + default: false style: form indices.shard_stores::path.index: in: path @@ -4686,6 +4723,7 @@ components: simulation. schema: type: boolean + default: false style: form indices.simulate_index_template::query.master_timeout: in: query @@ -4730,6 +4768,7 @@ components: description: If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. schema: type: boolean + default: false style: form indices.simulate_template::query.master_timeout: in: query @@ -4869,6 +4908,7 @@ components: description: If true, statistics are not collected from closed indices. schema: type: boolean + default: true style: form indices.stats::query.groups: in: query @@ -4887,6 +4927,7 @@ components: description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). schema: type: boolean + default: false style: form indices.stats::query.include_unloaded_segments: in: query @@ -4894,6 +4935,7 @@ components: description: If true, the response includes information from segments that are not loaded into memory. schema: type: boolean + default: false style: form indices.stats::query.level: in: query @@ -5008,6 +5050,7 @@ components: description: If `true`, wildcard and prefix queries are analyzed. schema: type: boolean + default: false style: form indices.validate_query::query.analyzer: in: query diff --git a/spec/namespaces/ingest.yaml b/spec/namespaces/ingest.yaml index ebd6e94b0..0eca86715 100644 --- a/spec/namespaces/ingest.yaml +++ b/spec/namespaces/ingest.yaml @@ -343,4 +343,5 @@ components: description: If `true`, the response includes output data for each processor in the executed pipeline. schema: type: boolean + default: false style: form diff --git a/spec/namespaces/nodes.yaml b/spec/namespaces/nodes.yaml index e0ed1f03e..f9e2c21ba 100644 --- a/spec/namespaces/nodes.yaml +++ b/spec/namespaces/nodes.yaml @@ -569,6 +569,7 @@ components: description: If true, returns settings in flat format. schema: type: boolean + default: false style: form nodes.info::query.timeout: in: query @@ -658,6 +659,7 @@ components: description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). schema: type: boolean + default: false style: form nodes.stats::query.level: in: query diff --git a/spec/namespaces/snapshot.yaml b/spec/namespaces/snapshot.yaml index 26cfe0796..dfa440753 100644 --- a/spec/namespaces/snapshot.yaml +++ b/spec/namespaces/snapshot.yaml @@ -590,6 +590,7 @@ components: description: If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. schema: type: boolean + default: false style: form snapshot.create_repository::path.repository: in: path @@ -727,6 +728,7 @@ components: description: If false, the request returns an error for any snapshots that are unavailable. schema: type: boolean + default: false style: form snapshot.get::query.master_timeout: in: query @@ -766,6 +768,7 @@ components: description: 'Return local information, do not retrieve the state from cluster-manager node (default: false)' schema: type: boolean + default: false style: form snapshot.get_repository::query.master_timeout: in: query @@ -816,6 +819,7 @@ components: description: Should this request wait until the operation has completed before returning schema: type: boolean + default: false style: form snapshot.status::path.repository: in: path @@ -846,6 +850,7 @@ components: description: Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown schema: type: boolean + default: false style: form snapshot.status::query.master_timeout: in: query diff --git a/spec/namespaces/tasks.yaml b/spec/namespaces/tasks.yaml index d3c542df4..b67eed193 100644 --- a/spec/namespaces/tasks.yaml +++ b/spec/namespaces/tasks.yaml @@ -146,6 +146,7 @@ components: description: Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false schema: type: boolean + default: false style: form tasks.get::path.task_id: in: path @@ -170,6 +171,7 @@ components: description: If `true`, the request blocks until the task has completed. schema: type: boolean + default: false style: form tasks.list::query.actions: in: query @@ -188,6 +190,7 @@ components: description: If `true`, the response includes detailed information about shard recoveries. schema: type: boolean + default: false style: form tasks.list::query.group_by: in: query @@ -227,4 +230,5 @@ components: description: If `true`, the request blocks until the operation is complete. schema: type: boolean + default: false style: form