@elastic/schemas 0.4.3 → 0.4.5

package/lib/es/json/security.put_role_mapping.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.put_role_mapping", "type": "object", "properties": { "name": { "type": "string", "description": "The distinct name that identifies the role mapping.\nThe name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.", "x-found-in": "path" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "enabled": { "type": "boolean", "description": "Mappings that have `enabled` set to `false` are ignored when role mapping is performed.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Additional metadata that helps define which roles are assigned to each user.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.", "x-found-in": "body" }, "roles": { "type": "array", "items": { "type": "string" }, "description": "A list of role names that are granted to the users that match the role mapping rules.\nExactly one of `roles` or `role_templates` must be specified.", "x-found-in": "body" }, "role_templates": { "type": "array", "items": { "$ref": "./security._types.json#/$defs/security._types__RoleTemplate" }, "description": "A list of Mustache templates that will be evaluated to determine the roles names that should granted to the users that match the role mapping rules.\nExactly one of `roles` or `role_templates` must be specified.", "x-found-in": "body" }, "rules": { "$ref": "./security._types.json#/$defs/security._types__RoleMappingRule", "description": "The rules that determine which users should be matched by the mapping.\nA rule is a logical condition that is expressed by using a JSON DSL.", "x-found-in": "body" }, "run_as": { "type": "array", "items": { "type": "string" }, "x-found-in": "body" } }, "required": ["name"], "description": "Create or update role mappings.\n\nRole mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.\n\nNOTE: This API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.\n\n**Role templates**\n\nThe most common use for role mappings is to create a mapping from a known value on the user to a fixed role name.\nFor example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch.\nThe `roles` field is used for this purpose.\n\nFor more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user.\nThe `role_templates` field is used for this purpose.\n\nNOTE: To use role templates successfully, the relevant scripting feature must be enabled.\nOtherwise, all attempts to create a role mapping with role templates fail.\n\nAll of the user fields that are available in the role mapping rules are also available in the role templates.\nThus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated.\n\nBy default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user.\nIf the format of the template is set to \"json\" then the template is expected to produce a JSON string or an array of JSON strings for the role names." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.put_role_mapping", "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "enabled": { "type": "boolean", "description": "Mappings that have `enabled` set to `false` are ignored when role mapping is performed.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Additional metadata that helps define which roles are assigned to each user.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.", "x-found-in": "body" }, "roles": { "type": "array", "items": { "type": "string" }, "description": "A list of role names that are granted to the users that match the role mapping rules.\nExactly one of `roles` or `role_templates` must be specified.", "x-found-in": "body" }, "role_templates": { "type": "array", "items": { "$ref": "./security._types.json#/$defs/security._types__RoleTemplate" }, "description": "A list of Mustache templates that will be evaluated to determine the roles names that should granted to the users that match the role mapping rules.\nExactly one of `roles` or `role_templates` must be specified.", "x-found-in": "body" }, "rules": { "$ref": "./security._types.json#/$defs/security._types__RoleMappingRule", "description": "The rules that determine which users should be matched by the mapping.\nA rule is a logical condition that is expressed by using a JSON DSL.", "x-found-in": "body" }, "run_as": { "type": "array", "items": { "type": "string" }, "x-found-in": "body" }, "name": { "type": "string", "description": "The distinct name that identifies the role mapping.\nThe name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.", "x-found-in": "path" } }, "required": ["name"], "description": "Create or update role mappings.\n\nRole mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.\n\nNOTE: This API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.\n\n**Role templates**\n\nThe most common use for role mappings is to create a mapping from a known value on the user to a fixed role name.\nFor example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch.\nThe `roles` field is used for this purpose.\n\nFor more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user.\nThe `role_templates` field is used for this purpose.\n\nNOTE: To use role templates successfully, the relevant scripting feature must be enabled.\nOtherwise, all attempts to create a role mapping with role templates fail.\n\nAll of the user fields that are available in the role mapping rules are also available in the role templates.\nThus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated.\n\nBy default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user.\nIf the format of the template is set to \"json\" then the template is expected to produce a JSON string or an array of JSON strings for the role names." }

package/lib/es/json/security.put_user.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.put_user", "type": "object", "properties": { "username": { "type": "string", "x-found-in": "body" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "Valid values are `true`, `false`, and `wait_for`.\nThese values have the same meaning as in the index API, but the default value for this API is true.", "x-found-in": "query" }, "email": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "The email of the user.", "x-found-in": "body" }, "full_name": { "oneOf": [{ "type": "string" }, { "type": "null" }], "description": "The full name of the user.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata that you want to associate with the user.", "x-found-in": "body" }, "password": { "type": "string", "description": "The user's password.\nPasswords must be at least 6 characters long.\nWhen adding a user, one of `password` or `password_hash` is required.\nWhen updating an existing user, the password is optional, so that other fields on the user (such as their roles) may be updated without modifying the user's password", "x-found-in": "body" }, "password_hash": { "type": "string", "description": "A hash of the user's password.\nThis must be produced using the same hashing algorithm as has been configured for password storage.\nFor more details, see the explanation of the `xpack.security.authc.password_hashing.algorithm` setting in the user cache and password hash algorithm documentation.\nUsing this parameter allows the client to pre-hash the password for performance and/or confidentiality reasons.\nThe `password` parameter and the `password_hash` parameter cannot be used in the same request.", "x-found-in": "body" }, "roles": { "type": "array", "items": { "type": "string" }, "description": "A set of roles the user has.\nThe roles determine the user's access permissions.\nTo create a user without any roles, specify an empty list (`[]`).", "x-found-in": "body" }, "enabled": { "type": "boolean", "description": "Specifies whether the user is enabled.", "x-found-in": "body" } }, "required": ["username"], "description": "Create or update users.\n\nAdd and update users in the native realm.\nA password is required for adding a new user but is optional when updating an existing user.\nTo change a user's password without updating any other fields, use the change password API." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.put_user", "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "Valid values are `true`, `false`, and `wait_for`.\nThese values have the same meaning as in the index API, but the default value for this API is true.", "x-found-in": "query" }, "username": { "type": "string", "description": "An identifier for the user.\n\nNOTE: Usernames must be at least 1 and no more than 507 characters.\nThey can contain alphanumeric characters (a-z, A-Z, 0-9), spaces, punctuation, and printable symbols in the Basic Latin (ASCII) block.\nLeading or trailing whitespace is not allowed.", "x-found-in": "path" }, "email": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The email of the user.", "x-found-in": "body" }, "full_name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "The full name of the user.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata that you want to associate with the user.", "x-found-in": "body" }, "password": { "type": "string", "description": "The user's password.\nPasswords must be at least 6 characters long.\nWhen adding a user, one of `password` or `password_hash` is required.\nWhen updating an existing user, the password is optional, so that other fields on the user (such as their roles) may be updated without modifying the user's password", "x-found-in": "body" }, "password_hash": { "type": "string", "description": "A hash of the user's password.\nThis must be produced using the same hashing algorithm as has been configured for password storage.\nFor more details, see the explanation of the `xpack.security.authc.password_hashing.algorithm` setting in the user cache and password hash algorithm documentation.\nUsing this parameter allows the client to pre-hash the password for performance and/or confidentiality reasons.\nThe `password` parameter and the `password_hash` parameter cannot be used in the same request.", "x-found-in": "body" }, "roles": { "type": "array", "items": { "type": "string" }, "description": "A set of roles the user has.\nThe roles determine the user's access permissions.\nTo create a user without any roles, specify an empty list (`[]`).", "x-found-in": "body" }, "enabled": { "type": "boolean", "description": "Specifies whether the user is enabled.", "x-found-in": "body" } }, "required": ["username"], "description": "Create or update users.\n\nAdd and update users in the native realm.\nA password is required for adding a new user but is optional when updating an existing user.\nTo change a user's password without updating any other fields, use the change password API." }

package/lib/es/json/security.suggest_user_profiles.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.suggest_user_profiles", "type": "object", "properties": { "data": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A comma-separated list of filters for the `data` field of the profile document.\nTo return all content use `data=*`.\nTo return a subset of content, use `data=<key>` to retrieve content nested under the specified `<key>`.\nBy default, the API returns no `data` content.\nIt is an error to specify `data` as both the query parameter and the request body field.", "x-found-in": "body" }, "name": { "type": "string", "description": "A query string used to match name-related fields in user profile documents.\nName-related fields are the user's `username`, `full_name`, and `email`.", "x-found-in": "body" }, "size": { "type": "number", "description": "The number of profiles to return.", "x-found-in": "body" }, "hint": { "$ref": "./security.suggest_user_profiles.json#/$defs/security.suggest_user_profiles__Hint", "description": "Extra search criteria to improve relevance of the suggestion result.\nProfiles matching the spcified hint are ranked higher in the response.\nProfiles not matching the hint aren't excluded from the response as long as the profile matches the `name` field query.", "x-found-in": "body" } }, "description": "Suggest a user profile.\n\nGet suggestions for user profiles that match specified search criteria.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.suggest_user_profiles", "type": "object", "properties": { "data": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A comma-separated list of filters for the `data` field of the profile document.\nTo return all content use `data=*`.\nTo return a subset of content, use `data=<key>` to retrieve content nested under the specified `<key>`.\nBy default, the API returns no `data` content.\nIt is an error to specify `data` as both the query parameter and the request body field.", "x-found-in": "body" }, "name": { "type": "string", "description": "A query string used to match name-related fields in user profile documents.\nName-related fields are the user's `username`, `full_name`, and `email`.", "x-found-in": "body" }, "size": { "type": "number", "description": "The number of profiles to return.", "x-found-in": "body" }, "hint": { "$ref": "./security.suggest_user_profiles.json#/$defs/security.suggest_user_profiles__Hint", "description": "Extra search criteria to improve relevance of the suggestion result.\nProfiles matching the spcified hint are ranked higher in the response.\nProfiles not matching the hint aren't excluded from the response as long as the profile matches the `name` field query.", "x-found-in": "body" } }, "description": "Suggest a user profile.\n\nGet suggestions for user profiles that match specified search criteria.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice." }

package/lib/es/json/security.update_api_key.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.update_api_key", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the API key to update.", "x-found-in": "path" }, "role_descriptors": { "type": "object", "additionalProperties": { "$ref": "./security._types.json#/$defs/security._types__RoleDescriptor" }, "description": "The role descriptors to assign to this API key.\nThe API key's effective permissions are an intersection of its assigned privileges and the point in time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, you can supply an empty `role_descriptors` parameter, that is to say, an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter or not.\nThe structure of a role descriptor is the same as the request for the create API keys API.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata that you want to associate with the API key.\nIt supports a nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this value fully replaces the metadata previously associated with the API key.", "x-found-in": "body" }, "expiration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The expiration time for the API key.\nBy default, API keys never expire.\nThis property can be omitted to leave the expiration unchanged.", "x-found-in": "body" } }, "required": ["id"], "description": "Update an API key.\n\nUpdate attributes of an existing API key.\nThis API supports updates to an API key's access scope, expiration, and metadata.\n\nTo use this API, you must have at least the `manage_own_api_key` cluster privilege.\nUsers can only update API keys that they created or that were granted to them.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.\n\nUse this API to update API keys created by the create API key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.\nIt's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.\n\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope.\nThis change can occur if the owner user's permissions have changed since the API key was created or last modified." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.update_api_key", "type": "object", "properties": { "role_descriptors": { "type": "object", "additionalProperties": { "$ref": "./security._types.json#/$defs/security._types__RoleDescriptor" }, "description": "The role descriptors to assign to this API key.\nThe API key's effective permissions are an intersection of its assigned privileges and the point in time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, you can supply an empty `role_descriptors` parameter, that is to say, an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter or not.\nThe structure of a role descriptor is the same as the request for the create API keys API.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata that you want to associate with the API key.\nIt supports a nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this value fully replaces the metadata previously associated with the API key.", "x-found-in": "body" }, "expiration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The expiration time for the API key.\nBy default, API keys never expire.\nThis property can be omitted to leave the expiration unchanged.", "x-found-in": "body" }, "id": { "type": "string", "description": "The ID of the API key to update.", "x-found-in": "path" } }, "required": ["id"], "description": "Update an API key.\n\nUpdate attributes of an existing API key.\nThis API supports updates to an API key's access scope, expiration, and metadata.\n\nTo use this API, you must have at least the `manage_own_api_key` cluster privilege.\nUsers can only update API keys that they created or that were granted to them.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.\n\nUse this API to update API keys created by the create API key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.\nIt's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.\n\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope.\nThis change can occur if the owner user's permissions have changed since the API key was created or last modified." }

package/lib/es/json/security.update_cross_cluster_api_key.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.update_cross_cluster_api_key", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the cross-cluster API key to update.", "x-found-in": "path" }, "access": { "$ref": "./security._types.json#/$defs/security._types__Access", "description": "The access to be granted to this API key.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.", "x-found-in": "body" }, "expiration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The expiration time for the API key.\nBy default, API keys never expire. This property can be omitted to leave the value unchanged.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata that you want to associate with the API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this information fully replaces metadata previously associated with the API key.", "x-found-in": "body" }, "certificate_identity": { "type": "string", "description": "The certificate identity to associate with this API key.\nThis field is used to restrict the API key to connections authenticated by a specific TLS certificate.\nThe value should match the certificate's distinguished name (DN) pattern.\nWhen specified, this fully replaces any previously assigned certificate identity.\nTo clear an existing certificate identity, explicitly set this field to `null`.\nWhen omitted, the existing certificate identity remains unchanged.", "x-found-in": "body" } }, "required": ["id", "access"], "description": "Update a cross-cluster API key.\n\nUpdate the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.\n\nTo use this API, you must have at least the `manage_security` cluster privilege.\nUsers can only update API keys that they created.\nTo update another user's API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user's credentials are required.\n\nIt's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.\n\nThis API supports updates to an API key's access scope, metadata, and expiration.\nThe owner user's information, such as the `username` and `realm`, is also updated automatically on every call.\n\nNOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.\n\nTo learn more about how to use this API, refer to the [Update cross cluter API key API examples page](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/update-cc-api-key-examples)." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.update_cross_cluster_api_key", "type": "object", "properties": { "access": { "$ref": "./security._types.json#/$defs/security._types__Access", "description": "The access to be granted to this API key.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.", "x-found-in": "body" }, "expiration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The expiration time for the API key.\nBy default, API keys never expire. This property can be omitted to leave the value unchanged.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata that you want to associate with the API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this information fully replaces metadata previously associated with the API key.", "x-found-in": "body" }, "certificate_identity": { "type": "string", "description": "The certificate identity to associate with this API key.\nThis field is used to restrict the API key to connections authenticated by a specific TLS certificate.\nThe value should match the certificate's distinguished name (DN) pattern.\nWhen specified, this fully replaces any previously assigned certificate identity.\nTo clear an existing certificate identity, explicitly set this field to `null`.\nWhen omitted, the existing certificate identity remains unchanged.", "x-found-in": "body" }, "id": { "type": "string", "description": "The ID of the cross-cluster API key to update.", "x-found-in": "path" } }, "required": ["id", "access"], "description": "Update a cross-cluster API key.\n\nUpdate the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.\n\nTo use this API, you must have at least the `manage_security` cluster privilege.\nUsers can only update API keys that they created.\nTo update another user's API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user's credentials are required.\n\nIt's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.\n\nThis API supports updates to an API key's access scope, metadata, and expiration.\nThe owner user's information, such as the `username` and `realm`, is also updated automatically on every call.\n\nNOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.\n\nTo learn more about how to use this API, refer to the [Update cross cluter API key API examples page](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/update-cc-api-key-examples)." }

package/lib/es/json/security.update_user_profile_data.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.update_user_profile_data", "type": "object", "properties": { "uid": { "type": "string", "description": "A unique identifier for the user profile.", "x-found-in": "path" }, "if_seq_no": { "type": "number", "description": "Only perform the operation if the document has this sequence number.", "x-found-in": "query" }, "if_primary_term": { "type": "number", "description": "Only perform the operation if the document has this primary term.", "x-found-in": "query" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', nothing is done with refreshes.", "x-found-in": "query" }, "labels": { "type": "object", "additionalProperties": {}, "description": "Searchable data that you want to associate with the user profile.\nThis field supports a nested data structure.\nWithin the labels object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`).", "x-found-in": "body" }, "data": { "type": "object", "additionalProperties": {}, "description": "Non-searchable data that you want to associate with the user profile.\nThis field supports a nested data structure.\nWithin the `data` object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`).\nThe data object is not searchable, but can be retrieved with the get user profile API.", "x-found-in": "body" } }, "required": ["uid"], "description": "Update user profile data.\n\nUpdate specific data for the user profile that is associated with a unique ID.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_user_profile` cluster privilege.\n* The `update_profile_data` global privilege for the namespaces that are referenced in the request.\n\nThis API updates the `labels` and `data` fields of an existing user profile document with JSON objects.\nNew keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.\n\nFor both labels and data, content is namespaced by the top-level fields.\nThe `update_profile_data` global privilege grants privileges for updating only the allowed namespaces." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.update_user_profile_data", "type": "object", "properties": { "if_seq_no": { "type": "number", "description": "Only perform the operation if the document has this sequence number.", "x-found-in": "query" }, "if_primary_term": { "type": "number", "description": "Only perform the operation if the document has this primary term.", "x-found-in": "query" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', nothing is done with refreshes.", "x-found-in": "query" }, "labels": { "type": "object", "additionalProperties": {}, "description": "Searchable data that you want to associate with the user profile.\nThis field supports a nested data structure.\nWithin the labels object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`).", "x-found-in": "body" }, "data": { "type": "object", "additionalProperties": {}, "description": "Non-searchable data that you want to associate with the user profile.\nThis field supports a nested data structure.\nWithin the `data` object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`).\nThe data object is not searchable, but can be retrieved with the get user profile API.", "x-found-in": "body" }, "uid": { "type": "string", "description": "A unique identifier for the user profile.", "x-found-in": "path" } }, "required": ["uid"], "description": "Update user profile data.\n\nUpdate specific data for the user profile that is associated with a unique ID.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_user_profile` cluster privilege.\n* The `update_profile_data` global privilege for the namespaces that are referenced in the request.\n\nThis API updates the `labels` and `data` fields of an existing user profile document with JSON objects.\nNew keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.\n\nFor both labels and data, content is namespaced by the top-level fields.\nThe `update_profile_data` global privilege grants privileges for updating only the allowed namespaces." }

package/lib/es/json/simulate.ingest.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "simulate.ingest", "type": "object", "properties": { "index": { "type": "string", "description": "The index to simulate ingesting into.\nThis value can be overridden by specifying an index on each document.\nIf you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument.", "x-found-in": "path" }, "pipeline": { "type": "string", "description": "The pipeline to use as the default pipeline.\nThis value can be used to override the default pipeline of the index.", "x-found-in": "query" }, "merge_type": { "$ref": "./simulate.ingest.json#/$defs/simulate.ingest__MergeType", "description": "The mapping merge type if mapping overrides are being provided in mapping_addition.\nThe allowed values are one of index or template.\nThe index option merges mappings the way they would be merged into an existing index.\nThe template option merges mappings the way they would be merged into a template.", "x-found-in": "query" }, "docs": { "type": "array", "items": { "$ref": "./ingest._types.json#/$defs/ingest._types__Document" }, "description": "Sample documents to test in the pipeline.", "x-found-in": "body" }, "component_template_substitutions": { "type": "object", "additionalProperties": { "$ref": "./cluster._types.json#/$defs/cluster._types__ComponentTemplateNode" }, "description": "A map of component template names to substitute component template definition objects.", "x-found-in": "body" }, "index_template_substitutions": { "type": "object", "additionalProperties": { "$ref": "./indices._types.json#/$defs/indices._types__IndexTemplate" }, "description": "A map of index template names to substitute index template definition objects.", "x-found-in": "body" }, "mapping_addition": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__TypeMapping", "x-found-in": "body" }, "pipeline_substitutions": { "type": "object", "additionalProperties": { "$ref": "./ingest._types.json#/$defs/ingest._types__Pipeline" }, "description": "Pipelines to test.\nIf you don’t specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", "x-found-in": "body" } }, "required": ["docs"], "description": "Simulate data ingestion.\n\nRun ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.\n\nThis API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch.\n\nThe API runs the default and final pipeline for that index against a set of documents provided in the body of the request.\nIf a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would.\nNo data is indexed into Elasticsearch.\nInstead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation.\nThe transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result.\n\nThis API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline.\nThe simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index.\n\nBy default, the pipeline definitions that are currently in the system are used.\nHowever, you can supply substitute pipeline definitions in the body of the request.\nThese will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "simulate.ingest", "type": "object", "properties": { "pipeline": { "type": "string", "description": "The pipeline to use as the default pipeline.\nThis value can be used to override the default pipeline of the index.", "x-found-in": "query" }, "merge_type": { "$ref": "./simulate.ingest.json#/$defs/simulate.ingest__MergeType", "description": "The mapping merge type if mapping overrides are being provided in mapping_addition.\nThe allowed values are one of index or template.\nThe index option merges mappings the way they would be merged into an existing index.\nThe template option merges mappings the way they would be merged into a template.", "x-found-in": "query" }, "docs": { "type": "array", "items": { "$ref": "./ingest._types.json#/$defs/ingest._types__Document" }, "description": "Sample documents to test in the pipeline.", "x-found-in": "body" }, "component_template_substitutions": { "type": "object", "additionalProperties": { "$ref": "./cluster._types.json#/$defs/cluster._types__ComponentTemplateNode" }, "description": "A map of component template names to substitute component template definition objects.", "x-found-in": "body" }, "index_template_substitutions": { "type": "object", "additionalProperties": { "$ref": "./indices._types.json#/$defs/indices._types__IndexTemplate" }, "description": "A map of index template names to substitute index template definition objects.", "x-found-in": "body" }, "mapping_addition": { "$ref": "./_types.mapping.json#/$defs/_types.mapping__TypeMapping", "x-found-in": "body" }, "pipeline_substitutions": { "type": "object", "additionalProperties": { "$ref": "./ingest._types.json#/$defs/ingest._types__Pipeline" }, "description": "Pipelines to test.\nIf you don’t specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.", "x-found-in": "body" }, "index": { "type": "string", "description": "The index to simulate ingesting into.\nThis value can be overridden by specifying an index on each document.\nIf you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument.", "x-found-in": "path" } }, "required": ["docs"], "description": "Simulate data ingestion.\n\nRun ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.\n\nThis API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch.\n\nThe API runs the default and final pipeline for that index against a set of documents provided in the body of the request.\nIf a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would.\nNo data is indexed into Elasticsearch.\nInstead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation.\nThe transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result.\n\nThis API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline.\nThe simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index.\n\nBy default, the pipeline definitions that are currently in the system are used.\nHowever, you can supply substitute pipeline definitions in the body of the request.\nThese will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request." }

package/lib/es/json/slm.delete_lifecycle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "slm.delete_lifecycle", "type": "object", "properties": { "policy_id": { "type": "string", "description": "The id of the snapshot lifecycle policy to remove", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "required": ["policy_id"], "description": "Delete a policy.\n\nDelete a snapshot lifecycle policy definition.\nThis operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "slm.delete_lifecycle", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "policy_id": { "type": "string", "description": "The id of the snapshot lifecycle policy to remove", "x-found-in": "path" } }, "required": ["policy_id"], "description": "Delete a policy.\n\nDelete a snapshot lifecycle policy definition.\nThis operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots." }

package/lib/es/json/slm.execute_lifecycle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "slm.execute_lifecycle", "type": "object", "properties": { "policy_id": { "type": "string", "description": "The id of the snapshot lifecycle policy to be executed", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "required": ["policy_id"], "description": "Run a policy.\n\nImmediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.\nThe snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "slm.execute_lifecycle", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "policy_id": { "type": "string", "description": "The id of the snapshot lifecycle policy to be executed", "x-found-in": "path" } }, "required": ["policy_id"], "description": "Run a policy.\n\nImmediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.\nThe snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance." }

package/lib/es/json/slm.get_lifecycle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "slm.get_lifecycle", "type": "object", "properties": { "policy_id": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of snapshot lifecycle policy identifiers.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "description": "Get policy information.\n\nGet snapshot lifecycle policy definitions and information about the latest snapshot attempts." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "slm.get_lifecycle", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "policy_id": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of snapshot lifecycle policy identifiers.", "x-found-in": "path" } }, "description": "Get policy information.\n\nGet snapshot lifecycle policy definitions and information about the latest snapshot attempts." }

package/lib/es/json/slm.put_lifecycle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "slm.put_lifecycle", "type": "object", "properties": { "policy_id": { "type": "string", "description": "The identifier for the snapshot lifecycle policy you want to create or update.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "config": { "$ref": "./slm._types.json#/$defs/slm._types__Configuration", "description": "Configuration for each snapshot created by the policy.", "x-found-in": "body" }, "name": { "type": "string", "description": "Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name.", "x-found-in": "body" }, "repository": { "type": "string", "description": "Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API.", "x-found-in": "body" }, "retention": { "$ref": "./slm._types.json#/$defs/slm._types__Retention", "description": "Retention rules used to retain and delete snapshots created by the policy.", "x-found-in": "body" }, "schedule": { "type": "string", "description": "Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately.", "x-found-in": "body" } }, "required": ["policy_id"], "description": "Create or update a policy.\n\nCreate or update a snapshot lifecycle policy.\nIf the policy already exists, this request increments the policy version.\nOnly the latest version of a policy is stored." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "slm.put_lifecycle", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "config": { "$ref": "./slm._types.json#/$defs/slm._types__Configuration", "description": "Configuration for each snapshot created by the policy.", "x-found-in": "body" }, "name": { "type": "string", "description": "Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name.", "x-found-in": "body" }, "repository": { "type": "string", "description": "Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API.", "x-found-in": "body" }, "retention": { "$ref": "./slm._types.json#/$defs/slm._types__Retention", "description": "Retention rules used to retain and delete snapshots created by the policy.", "x-found-in": "body" }, "schedule": { "type": "string", "description": "Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately.", "x-found-in": "body" }, "policy_id": { "type": "string", "description": "The identifier for the snapshot lifecycle policy you want to create or update.", "x-found-in": "path" } }, "required": ["policy_id"], "description": "Create or update a policy.\n\nCreate or update a snapshot lifecycle policy.\nIf the policy already exists, this request increments the policy version.\nOnly the latest version of a policy is stored." }

package/lib/es/json/snapshot.cleanup_repository.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.cleanup_repository", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "repository": { "type": "string", "description": "The name of the snapshot repository to clean up.", "x-found-in": "path" } }, "required": ["repository"], "description": "Clean up the snapshot repository.\n\nTrigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots." }

package/lib/es/json/snapshot.clone.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.clone", "type": "object", "properties": { "repository": { "type": "string", "description": "The name of the snapshot repository that both source and target snapshot belong to.", "x-found-in": "path" }, "snapshot": { "type": "string", "description": "The source snapshot name.", "x-found-in": "path" }, "target_snapshot": { "type": "string", "description": "The target snapshot name.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "indices": { "type": "string", "description": "A comma-separated list of indices to include in the snapshot.\nMulti-target syntax is supported.", "x-found-in": "body" } }, "required": ["repository", "snapshot", "target_snapshot", "indices"], "description": "Clone a snapshot.\n\nClone part of all of a snapshot into another snapshot in the same repository." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.clone", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "indices": { "type": "string", "description": "A comma-separated list of indices to include in the snapshot.\nMulti-target syntax is supported.", "x-found-in": "body" }, "repository": { "type": "string", "description": "The name of the snapshot repository that both source and target snapshot belong to.", "x-found-in": "path" }, "snapshot": { "type": "string", "description": "The source snapshot name.", "x-found-in": "path" }, "target_snapshot": { "type": "string", "description": "The target snapshot name.", "x-found-in": "path" } }, "required": ["repository", "snapshot", "target_snapshot", "indices"], "description": "Clone a snapshot.\n\nClone part of all of a snapshot into another snapshot in the same repository." }

package/lib/es/json/snapshot.create.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.create", "type": "object", "properties": { "repository": { "type": "string", "description": "The name of the repository for the snapshot.", "x-found-in": "path" }, "snapshot": { "type": "string", "description": "The name of the snapshot.\nIt supportes date math.\nIt must be unique in the repository.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request returns a response when the snapshot is complete.\nIf `false`, the request returns a response when the snapshot initializes.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Determines how wildcard patterns in the `indices` parameter match data streams and indices.\nIt supports comma-separated values such as `open,hidden`.", "x-found-in": "body" }, "feature_states": { "type": "array", "items": { "type": "string" }, "description": "The feature states to include in the snapshot.\nEach feature state includes one or more system indices containing related data.\nYou can view a list of eligible features using the get features API.\n\nIf `include_global_state` is `true`, all current feature states are included by default.\nIf `include_global_state` is `false`, no feature states are included by default.\n\nNote that specifying an empty array will result in the default behavior.\nTo exclude all feature states, regardless of the `include_global_state` value, specify an array with only the value `none` (`[\"none\"]`).", "x-found-in": "body" }, "ignore_unavailable": { "type": "boolean", "description": "If `true`, the request ignores data streams and indices in `indices` that are missing or closed.\nIf `false`, the request returns an error for any data stream or index that is missing or closed.", "x-found-in": "body" }, "include_global_state": { "type": "boolean", "description": "If `true`, the current cluster state is included in the snapshot.\nThe cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies.\nIt also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`).", "x-found-in": "body" }, "indices": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams and indices to include in the snapshot.\nIt supports a multi-target syntax.\nThe default is an empty array (`[]`), which includes all regular data streams and regular indices.\nTo exclude all data streams and indices, use `-*`.\n\nYou can't use this parameter to include or exclude system indices or system data streams from a snapshot.\nUse `feature_states` instead.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data.\nIt can have any contents but it must be less than 1024 bytes.\nThis information is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "partial": { "type": "boolean", "description": "If `true`, allows the snapshot to proceed even if some of the target shards are unavailable.\nIn this case, the resulting snapshot will not contain snapshots of the unavailable target shards, and will report its state as `PARTIAL`.\nAdditionally, if `true`, allows index metadata operations such as deletions while the snapshot is in progress.\nThis is almost always preferable to failing the snapshot completely when a single shard is unavailable, and blocking index metadata operations.\n\nIf `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available, and index metadata operations such as deletions will be forbidden until the snapshot completes.", "x-found-in": "body" } }, "required": ["repository", "snapshot"], "description": "Create a snapshot.\n\nTake a snapshot of a cluster or of data streams and indices." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.create", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request returns a response when the snapshot is complete.\nIf `false`, the request returns a response when the snapshot initializes.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Determines how wildcard patterns in the `indices` parameter match data streams and indices.\nIt supports comma-separated values such as `open,hidden`.", "x-found-in": "body" }, "feature_states": { "type": "array", "items": { "type": "string" }, "description": "The feature states to include in the snapshot.\nEach feature state includes one or more system indices containing related data.\nYou can view a list of eligible features using the get features API.\n\nIf `include_global_state` is `true`, all current feature states are included by default.\nIf `include_global_state` is `false`, no feature states are included by default.\n\nNote that specifying an empty array will result in the default behavior.\nTo exclude all feature states, regardless of the `include_global_state` value, specify an array with only the value `none` (`[\"none\"]`).", "x-found-in": "body" }, "ignore_unavailable": { "type": "boolean", "description": "If `true`, the request ignores data streams and indices in `indices` that are missing or closed.\nIf `false`, the request returns an error for any data stream or index that is missing or closed.", "x-found-in": "body" }, "include_global_state": { "type": "boolean", "description": "If `true`, the current cluster state is included in the snapshot.\nThe cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies.\nIt also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`).", "x-found-in": "body" }, "indices": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams and indices to include in the snapshot.\nIt supports a multi-target syntax.\nThe default is an empty array (`[]`), which includes all regular data streams and regular indices.\nTo exclude all data streams and indices, use `-*`.\n\nYou can't use this parameter to include or exclude system indices or system data streams from a snapshot.\nUse `feature_states` instead.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data.\nIt can have any contents but it must be less than 1024 bytes.\nThis information is not automatically generated by Elasticsearch.", "x-found-in": "body" }, "partial": { "type": "boolean", "description": "If `true`, allows the snapshot to proceed even if some of the target shards are unavailable.\nIn this case, the resulting snapshot will not contain snapshots of the unavailable target shards, and will report its state as `PARTIAL`.\nAdditionally, if `true`, allows index metadata operations such as deletions while the snapshot is in progress.\nThis is almost always preferable to failing the snapshot completely when a single shard is unavailable, and blocking index metadata operations.\n\nIf `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available, and index metadata operations such as deletions will be forbidden until the snapshot completes.", "x-found-in": "body" }, "repository": { "type": "string", "description": "The name of the repository for the snapshot.", "x-found-in": "path" }, "snapshot": { "type": "string", "description": "The name of the snapshot.\nIt supportes date math.\nIt must be unique in the repository.", "x-found-in": "path" } }, "required": ["repository", "snapshot"], "description": "Create a snapshot.\n\nTake a snapshot of a cluster or of data streams and indices." }

package/lib/es/json/snapshot.create_repository.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.create_repository", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "verify": { "type": "boolean", "description": "If `true`, the request verifies the repository is functional on all master and data nodes in the cluster.\nIf `false`, this verification is skipped.\nYou can also perform this verification with the verify snapshot repository API.", "x-found-in": "query" }, "repository": { "type": "string", "description": "The name of the snapshot repository to register or update.", "x-found-in": "path" } }, "required": ["repository"], "description": "Create or update a snapshot repository.\n\nIMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.\nTo register a snapshot repository, the cluster's global metadata must be writeable.\nEnsure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.\n\nSeveral options for this API can be specified using a query parameter or a request body parameter.\nIf both parameters are specified, only the query parameter is used." }

package/lib/es/json/snapshot.delete.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.delete", "type": "object", "properties": { "repository": { "type": "string", "description": "The name of the repository to delete a snapshot from.", "x-found-in": "path" }, "snapshot": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of snapshot names to delete.\nIt also accepts wildcards (`*`).", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request returns a response when the matching snapshots are all deleted.\nIf `false`, the request returns a response as soon as the deletes are scheduled.", "x-found-in": "query" } }, "required": ["repository", "snapshot"], "description": "Delete snapshots." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.delete", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request returns a response when the matching snapshots are all deleted.\nIf `false`, the request returns a response as soon as the deletes are scheduled.", "x-found-in": "query" }, "repository": { "type": "string", "description": "The name of the repository to delete a snapshot from.", "x-found-in": "path" }, "snapshot": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of snapshot names to delete.\nIt also accepts wildcards (`*`).", "x-found-in": "path" } }, "required": ["repository", "snapshot"], "description": "Delete snapshots." }

package/lib/es/json/snapshot.delete_repository.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.delete_repository", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "repository": { "$ref": "./_types.json#/$defs/_types__Names", "description": "The ame of the snapshot repositories to unregister.\nWildcard (`*`) patterns are supported.", "x-found-in": "path" } }, "required": ["repository"], "description": "Delete snapshot repositories.\n\nWhen a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots.\nThe snapshots themselves are left untouched and in place." }

package/lib/es/json/snapshot.get.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.get", "type": "object", "properties": { "repository": { "type": "string", "description": "A comma-separated list of snapshot repository names used to limit the request.\nWildcard (`*`) expressions are supported.", "x-found-in": "path" }, "snapshot": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of snapshot names to retrieve\nWildcards (`*`) are supported.\n\n* To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`.\n* To get information about any snapshots that are currently running, use `_current`.", "x-found-in": "path" }, "after": { "type": "string", "description": "An offset identifier to start pagination from as returned by the next field in the response body.", "x-found-in": "query" }, "from_sort_value": { "type": "string", "description": "The value of the current sort column at which to start retrieval.\nIt can be a string `snapshot-` or a repository name when sorting by snapshot or repository name.\nIt can be a millisecond time value or a number when sorting by `index-` or shard count.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error for any snapshots that are unavailable.", "x-found-in": "query" }, "index_details": { "type": "boolean", "description": "If `true`, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index.\nThe default is `false`, meaning that this information is omitted.", "x-found-in": "query" }, "index_names": { "type": "boolean", "description": "If `true`, the response includes the name of each index in each snapshot.", "x-found-in": "query" }, "include_repository": { "type": "boolean", "description": "If `true`, the response includes the repository name in each snapshot.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "order": { "$ref": "./_types.json#/$defs/_types__SortOrder", "description": "The sort order.\nValid values are `asc` for ascending and `desc` for descending order.\nThe default behavior is ascending order.", "x-found-in": "query" }, "offset": { "type": "number", "description": "Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0.", "x-found-in": "query" }, "size": { "type": "number", "description": "The maximum number of snapshots to return.\nThe default is -1, which means to return all that match the request without limit.", "x-found-in": "query" }, "slm_policy_filter": { "type": "string", "description": "Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.\n\nYou can use wildcards (`*`) and combinations of wildcards followed by exclude patterns starting with `-`.\nFor example, the pattern `*,-policy-a-\\*` will return all snapshots except for those that were created by an SLM policy with a name starting with `policy-a-`.\nNote that the wildcard pattern `*` matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy.\nTo include snapshots that were not created by an SLM policy, you can use the special pattern `_none` that will match all snapshots without an SLM policy.", "x-found-in": "query" }, "sort": { "$ref": "./snapshot._types.json#/$defs/snapshot._types__SnapshotSort", "description": "The sort order for the result.\nThe default behavior is sorting by snapshot start time stamp.", "x-found-in": "query" }, "state": { "oneOf": [{ "$ref": "./snapshot._types.json#/$defs/snapshot._types__SnapshotState" }, { "type": "array", "items": { "$ref": "./snapshot._types.json#/$defs/snapshot._types__SnapshotState" } }], "description": "Only return snapshots with a state found in the given comma-separated list of snapshot states.\nThe default is all snapshot states.", "x-found-in": "query" }, "verbose": { "type": "boolean", "description": "If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.\n\nNOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined.", "x-found-in": "query" } }, "required": ["repository", "snapshot"], "description": "Get snapshot information.\n\nNOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.\nIt is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration.\nSnapshots concurrently created may be seen during an iteration." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.get", "type": "object", "properties": { "after": { "type": "string", "description": "An offset identifier to start pagination from as returned by the next field in the response body.", "x-found-in": "query" }, "from_sort_value": { "type": "string", "description": "The value of the current sort column at which to start retrieval.\nIt can be a string `snapshot-` or a repository name when sorting by snapshot or repository name.\nIt can be a millisecond time value or a number when sorting by `index-` or shard count.", "x-found-in": "query" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error for any snapshots that are unavailable.", "x-found-in": "query" }, "index_details": { "type": "boolean", "description": "If `true`, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index.\nThe default is `false`, meaning that this information is omitted.", "x-found-in": "query" }, "index_names": { "type": "boolean", "description": "If `true`, the response includes the name of each index in each snapshot.", "x-found-in": "query" }, "include_repository": { "type": "boolean", "description": "If `true`, the response includes the repository name in each snapshot.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "order": { "$ref": "./_types.json#/$defs/_types__SortOrder", "description": "The sort order.\nValid values are `asc` for ascending and `desc` for descending order.\nThe default behavior is ascending order.", "x-found-in": "query" }, "offset": { "type": "number", "description": "Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0.", "x-found-in": "query" }, "size": { "type": "number", "description": "The maximum number of snapshots to return.\nThe default is -1, which means to return all that match the request without limit.", "x-found-in": "query" }, "slm_policy_filter": { "type": "string", "description": "Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.\n\nYou can use wildcards (`*`) and combinations of wildcards followed by exclude patterns starting with `-`.\nFor example, the pattern `*,-policy-a-\\*` will return all snapshots except for those that were created by an SLM policy with a name starting with `policy-a-`.\nNote that the wildcard pattern `*` matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy.\nTo include snapshots that were not created by an SLM policy, you can use the special pattern `_none` that will match all snapshots without an SLM policy.", "x-found-in": "query" }, "sort": { "$ref": "./snapshot._types.json#/$defs/snapshot._types__SnapshotSort", "description": "The sort order for the result.\nThe default behavior is sorting by snapshot start time stamp.", "x-found-in": "query" }, "state": { "anyOf": [{ "$ref": "./snapshot._types.json#/$defs/snapshot._types__SnapshotState" }, { "type": "array", "items": { "$ref": "./snapshot._types.json#/$defs/snapshot._types__SnapshotState" } }], "description": "Only return snapshots with a state found in the given comma-separated list of snapshot states.\nThe default is all snapshot states.", "x-found-in": "query" }, "verbose": { "type": "boolean", "description": "If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.\n\nNOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined.", "x-found-in": "query" }, "repository": { "type": "string", "description": "A comma-separated list of snapshot repository names used to limit the request.\nWildcard (`*`) expressions are supported.", "x-found-in": "path" }, "snapshot": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of snapshot names to retrieve\nWildcards (`*`) are supported.\n\n* To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`.\n* To get information about any snapshots that are currently running, use `_current`.", "x-found-in": "path" } }, "required": ["repository", "snapshot"], "description": "Get snapshot information.\n\nNOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.\nIt is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration.\nSnapshots concurrently created may be seen during an iteration." }

package/lib/es/json/snapshot.get_repository.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.get_repository", "type": "object", "properties": { "local": { "type": "boolean", "description": "If `true`, the request gets information from the local node only.\nIf `false`, the request gets information from the master node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "repository": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of snapshot repository names used to limit the request.\nWildcard (`*`) expressions are supported including combining wildcards with exclude patterns starting with `-`.\n\nTo get information about all snapshot repositories registered in the cluster, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "description": "Get snapshot repository information." }

package/lib/es/json/snapshot.repository_analyze.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.repository_analyze", "type": "object", "properties": { "blob_count": { "type": "number", "description": "The total number of blobs to write to the repository during the test.\nFor realistic experiments, set this parameter to at least `2000`.", "x-found-in": "query" }, "check_overwrite_protection": { "type": "boolean", "description": "Whether to run the overwrite protection check.\nFor realistic experiments, leave this parameter unset.", "x-found-in": "query" }, "concurrency": { "type": "number", "description": "The number of operations to run concurrently during the test.\nFor realistic experiments, leave this parameter unset.", "x-found-in": "query" }, "detailed": { "type": "boolean", "description": "Indicates whether to return detailed results, including timing information for every operation performed during the analysis.\nIf false, it returns only a summary of the analysis.", "x-found-in": "query" }, "early_read_node_count": { "type": "number", "description": "The number of nodes on which to perform an early read operation while writing each blob.\nEarly read operations are only rarely performed.\nFor realistic experiments, leave this parameter unset.", "x-found-in": "query" }, "max_blob_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum size of a blob to be written during the test.\nFor realistic experiments, set this parameter to at least `2gb`.", "x-found-in": "query" }, "max_total_data_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "An upper limit on the total size of all the blobs written during the test.\nFor realistic experiments, set this parameter to at least `1tb`.", "x-found-in": "query" }, "rare_action_probability": { "type": "number", "description": "The probability of performing a rare action such as an early read, an overwrite, or an aborted write on each blob.\nFor realistic experiments, leave this parameter unset.", "x-found-in": "query" }, "rarely_abort_writes": { "type": "boolean", "description": "Indicates whether to rarely cancel writes before they complete.\nFor realistic experiments, leave this parameter unset.", "x-found-in": "query" }, "read_node_count": { "type": "number", "description": "The number of nodes on which to read a blob after writing.\nFor realistic experiments, leave this parameter unset.", "x-found-in": "query" }, "register_operation_count": { "type": "number", "description": "The minimum number of linearizable register operations to perform in total.\nFor realistic experiments, set this parameter to at least `100`.", "x-found-in": "query" }, "seed": { "type": "number", "description": "The seed for the pseudo-random number generator used to generate the list of operations performed during the test.\nTo repeat the same set of operations in multiple experiments, use the same seed in each experiment.\nNote that the operations are performed concurrently so might not always happen in the same order on each run.\nFor realistic experiments, leave this parameter unset.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period of time to wait for the test to complete.\nIf no response is received before the timeout expires, the test is cancelled and returns an error.\nFor realistic experiments, set this parameter sufficiently long to allow the test to complete.", "x-found-in": "query" }, "repository": { "type": "string", "description": "The name of the repository.", "x-found-in": "path" } }, "required": ["repository"], "description": "Analyze a snapshot repository.\n\nPerforms operations on a snapshot repository in order to check for incorrect behaviour.\n\nThere are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch.\nSome storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do.\nThis API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system.\n\nThe default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations.\nRun your first analysis with the default parameter values to check for simple problems.\nSome repositories may behave correctly when lightly loaded but incorrectly under production-like workloads.\nIf the first analysis is successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at least `100`.\nAlways specify a generous timeout, possibly `1h` or longer, to allow time for each analysis to run to completion.\nSome repositories may behave correctly when accessed by a small number of Elasticsearch nodes but incorrectly when accessed concurrently by a production-scale cluster.\nPerform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once.\n\nIf the analysis fails, Elasticsearch detected that your repository behaved unexpectedly.\nThis usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support.\nIf so, this storage system is not suitable for use as a snapshot repository.\nRepository analysis triggers conditions that occur only rarely when taking snapshots in a production system.\nSnapshotting to unsuitable storage may appear to work correctly most of the time despite repository analysis failures.\nHowever your snapshot data is at risk if you store it in a snapshot repository that does not reliably pass repository analysis.\nYou can demonstrate that the analysis failure is due to an incompatible storage implementation by verifying that Elasticsearch does not detect the same problem when analysing the reference implementation of the storage protocol you are using.\nFor instance, if you are using storage that offers an API which the supplier claims to be compatible with AWS S3, verify that repositories in AWS S3 do not fail repository analysis.\nThis allows you to demonstrate to your storage supplier that a repository analysis failure must only be caused by an incompatibility with AWS S3 and cannot be attributed to a problem in Elasticsearch.\nPlease do not report Elasticsearch issues involving third-party storage systems unless you can demonstrate that the same issue exists when analysing a repository that uses the reference implementation of the same storage protocol.\nYou will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects.\n\nThe analysis may also report a failure if your repository experienced a service disruption while the analysis was running.\nIn practice, occasional service disruptions are inevitable, but the analysis cannot itself distinguish such disruptions from incorrect behavior so must report all deviations from the expected behavior as failures.\nIf you are certain that you can ascribe an analysis failure to such a service disruption, wait for your service provider to resolve the disruption and then re-run the analysis.\nElasticsearch will be unable to create or restore snapshots during repository service disruptions, so you must ensure that these events occur only very rarely.\n\nIf the analysis is successful, the API returns details of the testing process, optionally including how long each operation took.\nYou can use this information to determine the performance of your storage system.\nIf any operation fails or returns an incorrect result, the API returns an error.\nIf the API returns an error, it may not have removed all the data it wrote to the repository.\nThe error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled.\nSome clients are configured to close their connection if no response is received within a certain timeout.\nAn analysis takes a long time to complete so you might need to relax any such client-side timeouts.\nOn cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all.\nThe path to the leftover data is recorded in the Elasticsearch logs.\nYou should verify that this location has been cleaned up correctly.\nIf there is still leftover data at the specified location, you should manually remove it.\n\nIf the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed.\nThe analysis attempts to detect common bugs but it does not offer 100% coverage.\nAdditionally, it does not test the following:\n\n* Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster.\n* Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted.\n* Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results.\n\nIMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again.\nThis consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself.\nYou must ensure this load does not affect other users of these systems.\nAnalyses respect the repository settings `max_snapshot_bytes_per_sec` and `max_restore_bytes_per_sec` if available and the cluster setting `indices.recovery.max_bytes_per_sec` which you can use to limit the bandwidth they consume.\n\nNOTE: This API is intended for exploratory use by humans.\nYou should expect the request parameters and the response format to vary in future versions.\nThe response exposes immplementation details of the analysis which may change from version to version.\n\nNOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones.\nA storage system that passes repository analysis with one version of Elasticsearch may fail with a different version.\nThis indicates it behaves incorrectly in ways that the former version did not detect.\nYou must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\n*Implementation details*\n\nNOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions.\nThe request parameters and response format depend on details of the implementation so may also be different in newer versions.\n\nThe analysis comprises a number of blob-level tasks, as set by the `blob_count` parameter and a number of compare-and-exchange operations on linearizable registers, as set by the `register_operation_count` parameter.\nThese tasks are distributed over the data and master-eligible nodes in the cluster for execution.\n\nFor most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote.\nThe size of the blob is chosen randomly, according to the `max_blob_size` and `max_total_data_size` parameters.\nIf any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes.\nThese reads are permitted to fail, but must not return partial data.\nIf any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires.\n\nFor some blob-level tasks, the executing node will overwrite the blob while its peers are reading it.\nIn this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs.\nIf any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites.\n\nThe executing node will use a variety of different methods to write the blob.\nFor instance, where applicable, it will use both single-part and multi-part uploads.\nSimilarly, the reading nodes will use a variety of different methods to read the data back again.\nFor instance they may read the entire blob from start to end or may read only a subset of the data.\n\nFor some blob-level tasks, the executing node will cancel the write before it is complete.\nIn this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob.\n\nLinearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation.\nThis operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time.\nThe detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type.\nRepository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed.\nRepository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results.\nIf an operation fails due to contention, Elasticsearch retries the operation until it succeeds.\nMost of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob.\nSome operations also verify the behavior on small blobs with sizes other than 8 bytes." }

package/lib/es/json/snapshot.repository_verify_integrity.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.repository_verify_integrity", "type": "object", "properties": { "blob_thread_pool_concurrency": { "type": "number", "description": "If `verify_blob_contents` is `true`, this parameter specifies how many blobs to verify at once.", "x-found-in": "query" }, "index_snapshot_verification_concurrency": { "type": "number", "description": "The maximum number of index snapshots to verify concurrently within each index verification.", "x-found-in": "query" }, "index_verification_concurrency": { "type": "number", "description": "The number of indices to verify concurrently.\nThe default behavior is to use the entire `snapshot_meta` thread pool.", "x-found-in": "query" }, "max_bytes_per_sec": { "type": "string", "description": "If `verify_blob_contents` is `true`, this parameter specifies the maximum amount of data that Elasticsearch will read from the repository every second.", "x-found-in": "query" }, "max_failed_shard_snapshots": { "type": "number", "description": "The number of shard snapshot failures to track during integrity verification, in order to avoid excessive resource usage.\nIf your repository contains more than this number of shard snapshot failures, the verification will fail.", "x-found-in": "query" }, "meta_thread_pool_concurrency": { "type": "number", "description": "The maximum number of snapshot metadata operations to run concurrently.\nThe default behavior is to use at most half of the `snapshot_meta` thread pool at once.", "x-found-in": "query" }, "snapshot_verification_concurrency": { "type": "number", "description": "The number of snapshots to verify concurrently.\nThe default behavior is to use at most half of the `snapshot_meta` thread pool at once.", "x-found-in": "query" }, "verify_blob_contents": { "type": "boolean", "description": "Indicates whether to verify the checksum of every data blob in the repository.\nIf this feature is enabled, Elasticsearch will read the entire repository contents, which may be extremely slow and expensive.", "x-found-in": "query" }, "repository": { "$ref": "./_types.json#/$defs/_types__Names", "description": "The name of the snapshot repository.", "x-found-in": "path" } }, "required": ["repository"], "description": "Verify the repository integrity.\n\nVerify the integrity of the contents of a snapshot repository.\n\nThis API enables you to perform a comprehensive check of the contents of a repository, looking for any anomalies in its data or metadata which might prevent you from restoring snapshots from the repository or which might cause future snapshot create or delete operations to fail.\n\nIf you suspect the integrity of the contents of one of your snapshot repositories, cease all write activity to this repository immediately, set its `read_only` option to `true`, and use this API to verify its integrity.\nUntil you do so:\n\n* It may not be possible to restore some snapshots from this repository.\n* Searchable snapshots may report errors when searched or may have unassigned shards.\n* Taking snapshots into this repository may fail or may appear to succeed but have created a snapshot which cannot be restored.\n* Deleting snapshots from this repository may fail or may appear to succeed but leave the underlying data on disk.\n* Continuing to write to the repository while it is in an invalid state may causing additional damage to its contents.\n\nIf the API finds any problems with the integrity of the contents of your repository, Elasticsearch will not be able to repair the damage.\nThe only way to bring the repository back into a fully working state after its contents have been damaged is by restoring its contents from a repository backup which was taken before the damage occurred.\nYou must also identify what caused the damage and take action to prevent it from happening again.\n\nIf you cannot restore a repository backup, register a new repository and use this for all future snapshot operations.\nIn some cases it may be possible to recover some of the contents of a damaged repository, either by restoring as many of its snapshots as needed and taking new snapshots of the restored data, or by using the reindex API to copy data from any searchable snapshots mounted from the damaged repository.\n\nAvoid all operations which write to the repository while the verify repository integrity API is running.\nIf something changes the repository contents while an integrity verification is running then Elasticsearch may incorrectly report having detected some anomalies in its contents due to the concurrent writes.\nIt may also incorrectly fail to report some anomalies that the concurrent writes prevented it from detecting.\n\nNOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions.\n\nNOTE: This API may not work correctly in a mixed-version cluster.\n\nThe default values for the parameters of this API are designed to limit the impact of the integrity verification on other activities in your cluster.\nFor instance, by default it will only use at most half of the `snapshot_meta` threads to verify the integrity of each snapshot, allowing other snapshot operations to use the other half of this thread pool.\nIf you modify these parameters to speed up the verification process, you risk disrupting other snapshot-related operations in your cluster.\nFor large repositories, consider setting up a separate single-node Elasticsearch cluster just for running the integrity verification API.\n\nThe response exposes implementation details of the analysis which may change from version to version.\nThe response body format is therefore not considered stable and may be different in newer versions." }

package/lib/es/json/snapshot.restore.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.restore", "type": "object", "properties": { "repository": { "type": "string", "description": "The name of the repository to restore a snapshot from.", "x-found-in": "path" }, "snapshot": { "type": "string", "description": "The name of the snapshot to restore.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request returns a response when the restore operation completes.\nThe operation is complete when it finishes all attempts to recover primary shards for restored indices.\nThis applies even if one or more of the recovery attempts fail.\n\nIf `false`, the request returns a response when the restore operation initializes.", "x-found-in": "query" }, "feature_states": { "type": "array", "items": { "type": "string" }, "description": "The feature states to restore.\nIf `include_global_state` is `true`, the request restores all feature states in the snapshot by default.\nIf `include_global_state` is `false`, the request restores no feature states by default.\nNote that specifying an empty array will result in the default behavior.\nTo restore no feature states, regardless of the `include_global_state` value, specify an array containing only the value `none` (`[\"none\"]`).", "x-found-in": "body" }, "ignore_index_settings": { "type": "array", "items": { "type": "string" }, "description": "The index settings to not restore from the snapshot.\nYou can't use this option to ignore `index.number_of_shards`.\n\nFor data streams, this option applies only to restored backing indices.\nNew backing indices are configured using the data stream's matching index template.", "x-found-in": "body" }, "ignore_unavailable": { "type": "boolean", "description": "If `true`, the request ignores any index or data stream in indices that's missing from the snapshot.\nIf `false`, the request returns an error for any missing index or data stream.", "x-found-in": "body" }, "include_aliases": { "type": "boolean", "description": "If `true`, the request restores aliases for any restored data streams and indices.\nIf `false`, the request doesn’t restore aliases.", "x-found-in": "body" }, "include_global_state": { "type": "boolean", "description": "If `true`, restore the cluster state. The cluster state includes:\n\n* Persistent cluster settings\n* Index templates\n* Legacy index templates\n* Ingest pipelines\n* Index lifecycle management (ILM) policies\n* Stored scripts\n* For snapshots taken after 7.12.0, feature states\n\nIf `include_global_state` is `true`, the restore operation merges the legacy index templates in your cluster with the templates contained in the snapshot, replacing any existing ones whose name matches one in the snapshot.\nIt completely removes all persistent settings, non-legacy index templates, ingest pipelines, and ILM lifecycle policies that exist in your cluster and replaces them with the corresponding items from the snapshot.\n\nUse the `feature_states` parameter to configure how feature states are restored.\n\nIf `include_global_state` is `true` and a snapshot was created without a global state then the restore request will fail.", "x-found-in": "body" }, "index_settings": { "$ref": "./indices._types.json#/$defs/indices._types__IndexSettings", "description": "Index settings to add or change in restored indices, including backing indices.\nYou can't use this option to change `index.number_of_shards`.\n\nFor data streams, this option applies only to restored backing indices.\nNew backing indices are configured using the data stream's matching index template.", "x-found-in": "body" }, "indices": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of indices and data streams to restore.\nIt supports a multi-target syntax.\nThe default behavior is all regular indices and regular data streams in the snapshot.\n\nYou can't use this parameter to restore system indices or system data streams.\nUse `feature_states` instead.", "x-found-in": "body" }, "partial": { "type": "boolean", "description": "If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.\n\nIf true, it allows restoring a partial snapshot of indices with unavailable shards.\nOnly shards that were successfully included in the snapshot will be restored.\nAll missing shards will be recreated as empty.", "x-found-in": "body" }, "rename_pattern": { "type": "string", "description": "A rename pattern to apply to restored data streams and indices.\nData streams and indices matching the rename pattern will be renamed according to `rename_replacement`.\n\nThe rename pattern is applied as defined by the regular expression that supports referencing the original text, according to the `appendReplacement` logic.", "x-found-in": "body" }, "rename_replacement": { "type": "string", "description": "The rename replacement string that is used with the `rename_pattern`.", "x-found-in": "body" } }, "required": ["repository", "snapshot"], "description": "Restore a snapshot.\n\nRestore a snapshot of a cluster or data streams and indices.\n\nYou can restore a snapshot only to a running cluster with an elected master node.\nThe snapshot repository must be registered and available to the cluster.\nThe snapshot and cluster versions must be compatible.\n\nTo restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.\n\nBefore you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:\n\n```\nGET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n```\n\nIf no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.\n\nIf your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.restore", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request returns a response when the restore operation completes.\nThe operation is complete when it finishes all attempts to recover primary shards for restored indices.\nThis applies even if one or more of the recovery attempts fail.\n\nIf `false`, the request returns a response when the restore operation initializes.", "x-found-in": "query" }, "feature_states": { "type": "array", "items": { "type": "string" }, "description": "The feature states to restore.\nIf `include_global_state` is `true`, the request restores all feature states in the snapshot by default.\nIf `include_global_state` is `false`, the request restores no feature states by default.\nNote that specifying an empty array will result in the default behavior.\nTo restore no feature states, regardless of the `include_global_state` value, specify an array containing only the value `none` (`[\"none\"]`).", "x-found-in": "body" }, "ignore_index_settings": { "type": "array", "items": { "type": "string" }, "description": "The index settings to not restore from the snapshot.\nYou can't use this option to ignore `index.number_of_shards`.\n\nFor data streams, this option applies only to restored backing indices.\nNew backing indices are configured using the data stream's matching index template.", "x-found-in": "body" }, "ignore_unavailable": { "type": "boolean", "description": "If `true`, the request ignores any index or data stream in indices that's missing from the snapshot.\nIf `false`, the request returns an error for any missing index or data stream.", "x-found-in": "body" }, "include_aliases": { "type": "boolean", "description": "If `true`, the request restores aliases for any restored data streams and indices.\nIf `false`, the request doesn’t restore aliases.", "x-found-in": "body" }, "include_global_state": { "type": "boolean", "description": "If `true`, restore the cluster state. The cluster state includes:\n\n* Persistent cluster settings\n* Index templates\n* Legacy index templates\n* Ingest pipelines\n* Index lifecycle management (ILM) policies\n* Stored scripts\n* For snapshots taken after 7.12.0, feature states\n\nIf `include_global_state` is `true`, the restore operation merges the legacy index templates in your cluster with the templates contained in the snapshot, replacing any existing ones whose name matches one in the snapshot.\nIt completely removes all persistent settings, non-legacy index templates, ingest pipelines, and ILM lifecycle policies that exist in your cluster and replaces them with the corresponding items from the snapshot.\n\nUse the `feature_states` parameter to configure how feature states are restored.\n\nIf `include_global_state` is `true` and a snapshot was created without a global state then the restore request will fail.", "x-found-in": "body" }, "index_settings": { "$ref": "./indices._types.json#/$defs/indices._types__IndexSettings", "description": "Index settings to add or change in restored indices, including backing indices.\nYou can't use this option to change `index.number_of_shards`.\n\nFor data streams, this option applies only to restored backing indices.\nNew backing indices are configured using the data stream's matching index template.", "x-found-in": "body" }, "indices": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of indices and data streams to restore.\nIt supports a multi-target syntax.\nThe default behavior is all regular indices and regular data streams in the snapshot.\n\nYou can't use this parameter to restore system indices or system data streams.\nUse `feature_states` instead.", "x-found-in": "body" }, "partial": { "type": "boolean", "description": "If `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available.\n\nIf true, it allows restoring a partial snapshot of indices with unavailable shards.\nOnly shards that were successfully included in the snapshot will be restored.\nAll missing shards will be recreated as empty.", "x-found-in": "body" }, "rename_pattern": { "type": "string", "description": "A rename pattern to apply to restored data streams and indices.\nData streams and indices matching the rename pattern will be renamed according to `rename_replacement`.\n\nThe rename pattern is applied as defined by the regular expression that supports referencing the original text, according to the `appendReplacement` logic.", "x-found-in": "body" }, "rename_replacement": { "type": "string", "description": "The rename replacement string that is used with the `rename_pattern`.", "x-found-in": "body" }, "repository": { "type": "string", "description": "The name of the repository to restore a snapshot from.", "x-found-in": "path" }, "snapshot": { "type": "string", "description": "The name of the snapshot to restore.", "x-found-in": "path" } }, "required": ["repository", "snapshot"], "description": "Restore a snapshot.\n\nRestore a snapshot of a cluster or data streams and indices.\n\nYou can restore a snapshot only to a running cluster with an elected master node.\nThe snapshot repository must be registered and available to the cluster.\nThe snapshot and cluster versions must be compatible.\n\nTo restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks.\n\nBefore you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API:\n\n```\nGET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream\n```\n\nIf no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices.\n\nIf your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot." }

package/lib/es/json/snapshot.status.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.status", "type": "object", "properties": { "repository": { "type": "string", "description": "The snapshot repository name used to limit the request.\nIt supports wildcards (`*`) if `<snapshot>` isn't specified.", "x-found-in": "path" }, "snapshot": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of snapshots to retrieve status for.\nThe default is currently running snapshots.\nWildcards (`*`) are not supported.", "x-found-in": "path" }, "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error for any snapshots that are unavailable.\nIf `true`, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" } }, "description": "Get the snapshot status.\n\nGet a detailed description of the current state for each shard participating in the snapshot.\n\nNote that this API should be used only to obtain detailed shard-level information for ongoing snapshots.\nIf this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.\n\nIf you omit the `<snapshot>` request path parameter, the request retrieves information only for currently running snapshots.\nThis usage is preferred.\nIf needed, you can specify `<repository>` and `<snapshot>` to retrieve information for specific snapshots, even if they're not currently running.\n\nNote that the stats will not be available for any shard snapshots in an ongoing snapshot completed by a node that (even momentarily) left the cluster.\nLoading the stats from the repository is an expensive operation (see the WARNING below).\nTherefore the stats values for such shards will be -1 even though the \"stage\" value will be \"DONE\", in order to minimize latency.\nA \"description\" field will be present for a shard snapshot completed by a departed node explaining why the shard snapshot's stats results are invalid.\nConsequently, the total stats for the index will be less than expected due to the missing values from these shards.\n\nWARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.\nThe API requires a read from the repository for each shard in each snapshot.\nFor example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).\n\nDepending on the latency of your storage, such requests can take an extremely long time to return results.\nThese requests can also tax machine resources and, when using cloud storage, incur high processing costs." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.status", "type": "object", "properties": { "ignore_unavailable": { "type": "boolean", "description": "If `false`, the request returns an error for any snapshots that are unavailable.\nIf `true`, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "repository": { "type": "string", "description": "The snapshot repository name used to limit the request.\nIt supports wildcards (`*`) if `<snapshot>` isn't specified.", "x-found-in": "path" }, "snapshot": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of snapshots to retrieve status for.\nThe default is currently running snapshots.\nWildcards (`*`) are not supported.", "x-found-in": "path" } }, "description": "Get the snapshot status.\n\nGet a detailed description of the current state for each shard participating in the snapshot.\n\nNote that this API should be used only to obtain detailed shard-level information for ongoing snapshots.\nIf this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API.\n\nIf you omit the `<snapshot>` request path parameter, the request retrieves information only for currently running snapshots.\nThis usage is preferred.\nIf needed, you can specify `<repository>` and `<snapshot>` to retrieve information for specific snapshots, even if they're not currently running.\n\nNote that the stats will not be available for any shard snapshots in an ongoing snapshot completed by a node that (even momentarily) left the cluster.\nLoading the stats from the repository is an expensive operation (see the WARNING below).\nTherefore the stats values for such shards will be -1 even though the \"stage\" value will be \"DONE\", in order to minimize latency.\nA \"description\" field will be present for a shard snapshot completed by a departed node explaining why the shard snapshot's stats results are invalid.\nConsequently, the total stats for the index will be less than expected due to the missing values from these shards.\n\nWARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive.\nThe API requires a read from the repository for each shard in each snapshot.\nFor example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).\n\nDepending on the latency of your storage, such requests can take an extremely long time to return results.\nThese requests can also tax machine resources and, when using cloud storage, incur high processing costs." }

package/lib/es/json/snapshot.verify_repository.request.json

@@ -0,0 +1 @@
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "snapshot.verify_repository", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.", "x-found-in": "query" }, "repository": { "type": "string", "description": "The name of the snapshot repository to verify.", "x-found-in": "path" } }, "required": ["repository"], "description": "Verify a snapshot repository.\n\nCheck for common misconfigurations in a snapshot repository." }

package/lib/es/json/sql.get_async.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "sql.get_async", "type": "object", "properties": { "id": { "type": "string", "description": "The identifier for the search.", "x-found-in": "path" }, "delimiter": { "type": "string", "description": "The separator for CSV results.\nThe API supports this parameter only for CSV responses.", "x-found-in": "query" }, "format": { "type": "string", "description": "The format for the response.\nYou must specify a format using this parameter or the `Accept` HTTP header.\nIf you specify both, the API uses this parameter.", "x-found-in": "query" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The retention period for the search and its results.\nIt defaults to the `keep_alive` period for the original SQL search.", "x-found-in": "query" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for complete results.\nIt defaults to no timeout, meaning the request waits for complete search results.", "x-found-in": "query" } }, "required": ["id"], "description": "Get async SQL search results.\n\nGet the current status and available results for an async SQL search or stored synchronous SQL search.\n\nIf the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "sql.get_async", "type": "object", "properties": { "delimiter": { "type": "string", "description": "The separator for CSV results.\nThe API supports this parameter only for CSV responses.", "x-found-in": "query" }, "format": { "type": "string", "description": "The format for the response.\nYou must specify a format using this parameter or the `Accept` HTTP header.\nIf you specify both, the API uses this parameter.", "x-found-in": "query" }, "keep_alive": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The retention period for the search and its results.\nIt defaults to the `keep_alive` period for the original SQL search.", "x-found-in": "query" }, "wait_for_completion_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for complete results.\nIt defaults to no timeout, meaning the request waits for complete search results.", "x-found-in": "query" }, "id": { "type": "string", "description": "The identifier for the search.", "x-found-in": "path" } }, "required": ["id"], "description": "Get async SQL search results.\n\nGet the current status and available results for an async SQL search or stored synchronous SQL search.\n\nIf the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API." }

package/lib/es/json/streams.logs_disable.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "streams.logs_disable", "type": "object", "properties": { "name": { "$ref": "./streams._types.json#/$defs/streams._types__StreamType", "description": "The stream type to disable.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "required": ["name"], "description": "Disable a named stream.\n\nTurn off the named stream feature for this cluster." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "streams.logs_disable", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "$ref": "./streams._types.json#/$defs/streams._types__StreamType", "description": "The stream type to disable.", "x-found-in": "path" } }, "required": ["name"], "description": "Disable a named stream.\n\nTurn off the named stream feature for this cluster." }

package/lib/es/json/streams.logs_enable.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "streams.logs_enable", "type": "object", "properties": { "name": { "$ref": "./streams._types.json#/$defs/streams._types__StreamType", "description": "The stream type to enable.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "required": ["name"], "description": "Enable a named stream.\n\nTurn on the named stream feature for this cluster.\n\nNOTE: To protect existing data, this feature can be turned on only if the cluster does not have\nexisting indices or data streams that match the pattern `<name>|<name>.*` for the enabled stream\ntype name. If those indices or data streams exist, a `409 - Conflict` response and error is\nreturned." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "streams.logs_enable", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "name": { "$ref": "./streams._types.json#/$defs/streams._types__StreamType", "description": "The stream type to enable.", "x-found-in": "path" } }, "required": ["name"], "description": "Enable a named stream.\n\nTurn on the named stream feature for this cluster.\n\nNOTE: To protect existing data, this feature can be turned on only if the cluster does not have\nexisting indices or data streams that match the pattern `<name>|<name>.*` for the enabled stream\ntype name. If those indices or data streams exist, a `409 - Conflict` response and error is\nreturned." }

package/lib/es/json/synonyms.delete_synonym_rule.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "synonyms.delete_synonym_rule", "type": "object", "properties": { "set_id": { "type": "string", "description": "The ID of the synonym set to update.", "x-found-in": "path" }, "rule_id": { "type": "string", "description": "The ID of the synonym rule to delete.", "x-found-in": "path" }, "refresh": { "type": "boolean", "description": "If `true`, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the deleted synonym rule", "x-found-in": "query" } }, "required": ["set_id", "rule_id"], "description": "Delete a synonym rule.\n\nDelete a synonym rule from a synonym set." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "synonyms.delete_synonym_rule", "type": "object", "properties": { "refresh": { "type": "boolean", "description": "If `true`, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the deleted synonym rule", "x-found-in": "query" }, "set_id": { "type": "string", "description": "The ID of the synonym set to update.", "x-found-in": "path" }, "rule_id": { "type": "string", "description": "The ID of the synonym rule to delete.", "x-found-in": "path" } }, "required": ["set_id", "rule_id"], "description": "Delete a synonym rule.\n\nDelete a synonym rule from a synonym set." }

package/lib/es/json/synonyms.get_synonym.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "synonyms.get_synonym", "type": "object", "properties": { "id": { "type": "string", "description": "The synonyms set identifier to retrieve.", "x-found-in": "path" }, "from": { "type": "number", "description": "The starting offset for synonym rules to retrieve.", "x-found-in": "query" }, "size": { "type": "number", "description": "The max number of synonym rules to retrieve.", "x-found-in": "query" }, "search_after": { "type": "string", "description": "The synonym rule ID to use as a cursor for pagination.\nThe next page of results will start after this rule ID.\nThis parameter cannot be used with `from`.", "x-found-in": "query" } }, "required": ["id"], "description": "Get a synonym set." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "synonyms.get_synonym", "type": "object", "properties": { "from": { "type": "number", "description": "The starting offset for synonym rules to retrieve.", "x-found-in": "query" }, "size": { "type": "number", "description": "The max number of synonym rules to retrieve.", "x-found-in": "query" }, "search_after": { "type": "string", "description": "The synonym rule ID to use as a cursor for pagination.\nThe next page of results will start after this rule ID.\nThis parameter cannot be used with `from`.", "x-found-in": "query" }, "id": { "type": "string", "description": "The synonyms set identifier to retrieve.", "x-found-in": "path" } }, "required": ["id"], "description": "Get a synonym set." }

package/lib/es/json/synonyms.put_synonym.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "synonyms.put_synonym", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the synonyms set to be created or updated.", "x-found-in": "path" }, "refresh": { "type": "boolean", "description": "If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym set", "x-found-in": "query" }, "append": { "type": "boolean", "description": "If `true`, the provided synonym rules are appended to the existing set, with matching IDs overwriting existing rules.\nIf `false`, the entire synonyms set is replaced with the new synonym rules definitions.", "x-found-in": "query" }, "synonyms_set": { "oneOf": [{ "$ref": "./synonyms._types.json#/$defs/synonyms._types__SynonymRule" }, { "type": "array", "items": { "$ref": "./synonyms._types.json#/$defs/synonyms._types__SynonymRule" } }], "description": "The synonym rules definitions for the synonyms set.", "x-found-in": "body" } }, "required": ["id", "synonyms_set"], "description": "Create or update a synonym set.\n\nSynonym sets are limited to a maximum of 100,000 synonym rules per set by default.\nThis limit is configurable using the `synonyms.max_synonym_rules` cluster setting.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\nFor practical examples of how to create or update a synonyms set, refer to the External documentation." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "synonyms.put_synonym", "type": "object", "properties": { "refresh": { "type": "boolean", "description": "If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym set", "x-found-in": "query" }, "append": { "type": "boolean", "description": "If `true`, the provided synonym rules are appended to the existing set, with matching IDs overwriting existing rules.\nIf `false`, the entire synonyms set is replaced with the new synonym rules definitions.", "x-found-in": "query" }, "synonyms_set": { "anyOf": [{ "$ref": "./synonyms._types.json#/$defs/synonyms._types__SynonymRule" }, { "type": "array", "items": { "$ref": "./synonyms._types.json#/$defs/synonyms._types__SynonymRule" } }], "description": "The synonym rules definitions for the synonyms set.", "x-found-in": "body" }, "id": { "type": "string", "description": "The ID of the synonyms set to be created or updated.", "x-found-in": "path" } }, "required": ["id", "synonyms_set"], "description": "Create or update a synonym set.\n\nSynonym sets are limited to a maximum of 100,000 synonym rules per set by default.\nThis limit is configurable using the `synonyms.max_synonym_rules` cluster setting.\n\nWhen an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.\nThis is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.\n\nFor practical examples of how to create or update a synonyms set, refer to the External documentation." }

package/lib/es/json/synonyms.put_synonym_rule.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "synonyms.put_synonym_rule", "type": "object", "properties": { "set_id": { "type": "string", "description": "The ID of the synonym set.", "x-found-in": "path" }, "rule_id": { "type": "string", "description": "The ID of the synonym rule to be updated or created.", "x-found-in": "path" }, "refresh": { "type": "boolean", "description": "If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym rule", "x-found-in": "query" }, "synonyms": { "type": "string", "description": "The synonym rule information definition, which must be in Solr format.", "x-found-in": "body" } }, "required": ["set_id", "rule_id", "synonyms"], "description": "Create or update a synonym rule.\n\nCreate or update a synonym rule in a synonym set.\n\nIf any of the synonym rules included is invalid, the API returns an error.\n\nWhen you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "synonyms.put_synonym_rule", "type": "object", "properties": { "refresh": { "type": "boolean", "description": "If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.\nIf `false`, analyzers will not be reloaded with the new synonym rule", "x-found-in": "query" }, "synonyms": { "type": "string", "description": "The synonym rule information definition, which must be in Solr format.", "x-found-in": "body" }, "set_id": { "type": "string", "description": "The ID of the synonym set.", "x-found-in": "path" }, "rule_id": { "type": "string", "description": "The ID of the synonym rule to be updated or created.", "x-found-in": "path" } }, "required": ["set_id", "rule_id", "synonyms"], "description": "Create or update a synonym rule.\n\nCreate or update a synonym rule in a synonym set.\n\nIf any of the synonym rules included is invalid, the API returns an error.\n\nWhen you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule." }

package/lib/es/json/tasks.cancel.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "tasks.cancel", "type": "object", "properties": { "task_id": { "type": "string", "description": "The task identifier.", "x-found-in": "path" }, "actions": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A comma-separated list or wildcard expression of actions that is used to limit the request.", "x-found-in": "query" }, "nodes": { "type": "array", "items": { "type": "string" }, "description": "A comma-separated list of node IDs or names that is used to limit the request.", "x-found-in": "query" }, "parent_task_id": { "type": "string", "description": "A parent task ID that is used to limit the tasks.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If true, the request blocks until all found tasks are complete.", "x-found-in": "query" } }, "description": "Cancel a task.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nA task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.\nIt is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.\nThe get task information API will continue to list these cancelled tasks until they complete.\nThe cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.\n\nTo troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.\nYou can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "tasks.cancel", "type": "object", "properties": { "actions": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A comma-separated list or wildcard expression of actions that is used to limit the request.", "x-found-in": "query" }, "nodes": { "type": "array", "items": { "type": "string" }, "description": "A comma-separated list of node IDs or names that is used to limit the request.", "x-found-in": "query" }, "parent_task_id": { "type": "string", "description": "A parent task ID that is used to limit the tasks.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If true, the request blocks until all found tasks are complete.", "x-found-in": "query" }, "task_id": { "type": "string", "description": "The task identifier.", "x-found-in": "path" } }, "description": "Cancel a task.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nA task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.\nIt is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.\nThe get task information API will continue to list these cancelled tasks until they complete.\nThe cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.\n\nTo troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running.\nYou can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task." }

package/lib/es/json/tasks.get.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "tasks.get", "type": "object", "properties": { "task_id": { "type": "string", "description": "The task identifier.", "x-found-in": "path" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks until the task has completed.", "x-found-in": "query" } }, "required": ["task_id"], "description": "Get task information.\n\nGet information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "tasks.get", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks until the task has completed.", "x-found-in": "query" }, "task_id": { "type": "string", "description": "The task identifier.", "x-found-in": "path" } }, "required": ["task_id"], "description": "Get task information.\n\nGet information about a task currently running in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nIf the task identifier is not found, a 404 response code indicates that there are no resources that match the request.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task." }

package/lib/es/json/tasks.list.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "tasks.list", "type": "object", "properties": { "actions": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A comma-separated list or wildcard expression of actions used to limit the request.\nFor example, you can use `cluser:*` to retrieve all cluster-related tasks.", "x-found-in": "query" }, "detailed": { "type": "boolean", "description": "If `true`, the response includes detailed information about the running tasks.\nThis information is useful to distinguish tasks from each other but is more costly to run.", "x-found-in": "query" }, "group_by": { "$ref": "./tasks._types.json#/$defs/tasks._types__GroupBy", "description": "A key that is used to group tasks in the response.\nThe task lists can be grouped either by nodes or by parent tasks.", "x-found-in": "query" }, "nodes": { "$ref": "./_types.json#/$defs/_types__NodeIds", "description": "A comma-separated list of node IDs or names that is used to limit the returned information.", "x-found-in": "query" }, "parent_task_id": { "type": "string", "description": "A parent task identifier that is used to limit returned information.\nTo return all tasks, omit this parameter or use a value of `-1`.\nIf the parent task is not found, the API does not return a 404 response code.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for each node to respond.\nIf a node does not respond before its timeout expires, the response does not include its information.\nHowever, timed out nodes are included in the `node_failures` property.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks until the operation is complete.", "x-found-in": "query" } }, "description": "Get all tasks.\n\nGet information about the tasks currently running on one or more nodes in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.\n\n**Identifying running tasks**\n\nThe `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.\nThis enables you to track certain calls or associate certain tasks with the client that started them.\nFor example:\n\n```\ncurl -i -H \"X-Opaque-Id: 123456\" \"http://localhost:9200/_tasks?group_by=parents\"\n```\n\nThe API returns the following result:\n\n```\nHTTP/1.1 200 OK\nX-Opaque-Id: 123456\ncontent-type: application/json; charset=UTF-8\ncontent-length: 831\n\n{\n  \"tasks\" : {\n    \"u5lcZHqcQhu-rUoFaqDphA:45\" : {\n      \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n      \"id\" : 45,\n      \"type\" : \"transport\",\n      \"action\" : \"cluster:monitor/tasks/lists\",\n      \"start_time_in_millis\" : 1513823752749,\n      \"running_time_in_nanos\" : 293139,\n      \"cancellable\" : false,\n      \"headers\" : {\n        \"X-Opaque-Id\" : \"123456\"\n      },\n      \"children\" : [\n        {\n          \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n          \"id\" : 46,\n          \"type\" : \"direct\",\n          \"action\" : \"cluster:monitor/tasks/lists[n]\",\n          \"start_time_in_millis\" : 1513823752750,\n          \"running_time_in_nanos\" : 92133,\n          \"cancellable\" : false,\n          \"parent_task_id\" : \"u5lcZHqcQhu-rUoFaqDphA:45\",\n          \"headers\" : {\n            \"X-Opaque-Id\" : \"123456\"\n          }\n        }\n      ]\n    }\n  }\n }\n```\nIn this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.\nThe `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.\nThe `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "tasks.list", "type": "object", "properties": { "actions": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A comma-separated list or wildcard expression of actions used to limit the request.\nFor example, you can use `cluser:*` to retrieve all cluster-related tasks.", "x-found-in": "query" }, "detailed": { "type": "boolean", "description": "If `true`, the response includes detailed information about the running tasks.\nThis information is useful to distinguish tasks from each other but is more costly to run.", "x-found-in": "query" }, "group_by": { "$ref": "./tasks._types.json#/$defs/tasks._types__GroupBy", "description": "A key that is used to group tasks in the response.\nThe task lists can be grouped either by nodes or by parent tasks.", "x-found-in": "query" }, "nodes": { "$ref": "./_types.json#/$defs/_types__NodeIds", "description": "A comma-separated list of node IDs or names that is used to limit the returned information.", "x-found-in": "query" }, "parent_task_id": { "type": "string", "description": "A parent task identifier that is used to limit returned information.\nTo return all tasks, omit this parameter or use a value of `-1`.\nIf the parent task is not found, the API does not return a 404 response code.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for each node to respond.\nIf a node does not respond before its timeout expires, the response does not include its information.\nHowever, timed out nodes are included in the `node_failures` property.", "x-found-in": "query" }, "wait_for_completion": { "type": "boolean", "description": "If `true`, the request blocks until the operation is complete.", "x-found-in": "query" } }, "description": "Get all tasks.\n\nGet information about the tasks currently running on one or more nodes in the cluster.\n\nWARNING: The task management API is new and should still be considered a beta feature.\nThe API may change in ways that are not backwards compatible.\n\nFor relocatable tasks, this API transparently follows the task across graceful shutdown relocations,\nso callers can keep using the original task ID. The returned task reports its `original_task_id` and `original_start_time_in_millis`\nif it is continuing work from an earlier task.\n\n**Identifying running tasks**\n\nThe `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.\nThis enables you to track certain calls or associate certain tasks with the client that started them.\nFor example:\n\n```\ncurl -i -H \"X-Opaque-Id: 123456\" \"http://localhost:9200/_tasks?group_by=parents\"\n```\n\nThe API returns the following result:\n\n```\nHTTP/1.1 200 OK\nX-Opaque-Id: 123456\ncontent-type: application/json; charset=UTF-8\ncontent-length: 831\n\n{\n  \"tasks\" : {\n    \"u5lcZHqcQhu-rUoFaqDphA:45\" : {\n      \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n      \"id\" : 45,\n      \"type\" : \"transport\",\n      \"action\" : \"cluster:monitor/tasks/lists\",\n      \"start_time_in_millis\" : 1513823752749,\n      \"running_time_in_nanos\" : 293139,\n      \"cancellable\" : false,\n      \"headers\" : {\n        \"X-Opaque-Id\" : \"123456\"\n      },\n      \"children\" : [\n        {\n          \"node\" : \"u5lcZHqcQhu-rUoFaqDphA\",\n          \"id\" : 46,\n          \"type\" : \"direct\",\n          \"action\" : \"cluster:monitor/tasks/lists[n]\",\n          \"start_time_in_millis\" : 1513823752750,\n          \"running_time_in_nanos\" : 92133,\n          \"cancellable\" : false,\n          \"parent_task_id\" : \"u5lcZHqcQhu-rUoFaqDphA:45\",\n          \"headers\" : {\n            \"X-Opaque-Id\" : \"123456\"\n          }\n        }\n      ]\n    }\n  }\n }\n```\nIn this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.\nThe `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.\nThe `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request." }