diff --git a/src/ApiGenerator/opensearch-openapi.yaml b/src/ApiGenerator/opensearch-openapi.yaml
index 0abbed25c2..6220e58ec0 100644
--- a/src/ApiGenerator/opensearch-openapi.yaml
+++ b/src/ApiGenerator/opensearch-openapi.yaml
@@ -1608,6 +1608,8 @@ paths:
- $ref: '#/components/parameters/_global::query.error_trace'
- $ref: '#/components/parameters/_global::query.source'
- $ref: '#/components/parameters/_global::query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/cluster.put_weighted_routing'
responses:
'200':
$ref: '#/components/responses/cluster.put_weighted_routing@200'
@@ -1619,6 +1621,8 @@ paths:
description: Delete weighted shard routing weights.
externalDocs:
url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights
+ requestBody:
+ $ref: '#/components/requestBodies/cluster.delete_weighted_routing'
responses:
'200':
$ref: '#/components/responses/cluster.delete_weighted_routing@200'
@@ -3438,6 +3442,428 @@ paths:
- $ref: '#/components/parameters/_global::query.error_trace'
- $ref: '#/components/parameters/_global::query.source'
- $ref: '#/components/parameters/_global::query.filter_path'
+ /_plugins/_flow_framework/workflow:
+ post:
+ operationId: flow_framework.create.0
+ x-operation-group: flow_framework.create
+ x-version-added: '2.12'
+ description: Create a workflow.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/
+ parameters:
+ - $ref: '#/components/parameters/flow_framework.create::query.provision'
+ - $ref: '#/components/parameters/flow_framework.create::query.reprovision'
+ - $ref: '#/components/parameters/flow_framework.create::query.update_fields'
+ - $ref: '#/components/parameters/flow_framework.create::query.use_case'
+ - $ref: '#/components/parameters/flow_framework.create::query.validation'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/flow_framework.create'
+ responses:
+ '201':
+ $ref: '#/components/responses/flow_framework.create@201'
+ '400':
+ $ref: '#/components/responses/flow_framework.create@400'
+ '403':
+ $ref: '#/components/responses/flow_framework.create@403'
+ /_plugins/_flow_framework/workflow/_search:
+ get:
+ operationId: flow_framework.search.1
+ x-operation-group: flow_framework.search
+ x-version-added: '2.12'
+ description: Search for workflows by using a query matching a field.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/
+ requestBody:
+ $ref: '#/components/requestBodies/flow_framework.search'
+ responses:
+ '200':
+ $ref: '#/components/responses/flow_framework.search@200'
+ '400':
+ $ref: '#/components/responses/flow_framework.search@400'
+ '403':
+ $ref: '#/components/responses/flow_framework.search@403'
+ '408':
+ $ref: '#/components/responses/flow_framework.search@408'
+ parameters:
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ post:
+ operationId: flow_framework.search.0
+ x-operation-group: flow_framework.search
+ x-version-added: '2.12'
+ description: Search for workflows by using a query matching a field.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/
+ requestBody:
+ $ref: '#/components/requestBodies/flow_framework.search'
+ responses:
+ '200':
+ $ref: '#/components/responses/flow_framework.search@200'
+ '400':
+ $ref: '#/components/responses/flow_framework.search@400'
+ '403':
+ $ref: '#/components/responses/flow_framework.search@403'
+ '408':
+ $ref: '#/components/responses/flow_framework.search@408'
+ parameters:
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ /_plugins/_flow_framework/workflow/_steps:
+ get:
+ operationId: flow_framework.get_steps.0
+ x-operation-group: flow_framework.get_steps
+ x-version-added: '2.12'
+ description: Get a list of workflow steps.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-steps/
+ parameters:
+ - $ref: '#/components/parameters/flow_framework.get_steps::query.workflow_step'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/flow_framework.get_steps@200'
+ '400':
+ $ref: '#/components/responses/flow_framework.get_steps@400'
+ '403':
+ $ref: '#/components/responses/flow_framework.get_steps@403'
+ /_plugins/_flow_framework/workflow/{workflow_id}:
+ delete:
+ operationId: flow_framework.delete.0
+ x-operation-group: flow_framework.delete
+ x-version-added: '2.12'
+ description: Delete a workflow.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/automating-configurations/api/delete-workflow/
+ parameters:
+ - $ref: '#/components/parameters/flow_framework.delete::path.workflow_id'
+ - $ref: '#/components/parameters/flow_framework.delete::query.clear_status'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/flow_framework.delete@200'
+ '400':
+ $ref: '#/components/responses/flow_framework.delete@400'
+ '403':
+ $ref: '#/components/responses/flow_framework.delete@403'
+ get:
+ operationId: flow_framework.get.0
+ x-operation-group: flow_framework.get
+ x-version-added: '2.12'
+ externalDocs:
+ url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow/
+ description: Get a workflow.
+ parameters:
+ - $ref: '#/components/parameters/flow_framework.get::path.workflow_id'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/flow_framework.get@200'
+ '404':
+ $ref: '#/components/responses/flow_framework.get@404'
+ put:
+ operationId: flow_framework.update.0
+ x-operation-group: flow_framework.update
+ x-version-added: '2.12'
+ description: Update a workflow. You can only update a complete workflow if it has not yet been provisioned.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/
+ parameters:
+ - $ref: '#/components/parameters/flow_framework.update::path.workflow_id'
+ - $ref: '#/components/parameters/flow_framework.update::query.provision'
+ - $ref: '#/components/parameters/flow_framework.update::query.reprovision'
+ - $ref: '#/components/parameters/flow_framework.update::query.update_fields'
+ - $ref: '#/components/parameters/flow_framework.update::query.use_case'
+ - $ref: '#/components/parameters/flow_framework.update::query.validation'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/flow_framework.update'
+ responses:
+ '201':
+ $ref: '#/components/responses/flow_framework.update@201'
+ description: It returns the workflow_id
+ '400':
+ $ref: '#/components/responses/flow_framework.update@400'
+ '404':
+ $ref: '#/components/responses/flow_framework.update@404'
+ /_plugins/_flow_framework/workflow/{workflow_id}/_deprovision:
+ post:
+ operationId: flow_framework.deprovision.0
+ x-operation-group: flow_framework.deprovision
+ x-version-added: '2.12'
+ description: Deprovision workflow's resources when you no longer need it.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/automating-configurations/api/deprovision-workflow/
+ parameters:
+ - $ref: '#/components/parameters/flow_framework.deprovision::path.workflow_id'
+ - $ref: '#/components/parameters/flow_framework.deprovision::query.allow_delete'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/flow_framework.deprovision@200'
+ '202':
+ $ref: '#/components/responses/flow_framework.deprovision@202'
+ '403':
+ $ref: '#/components/responses/flow_framework.deprovision@403'
+ '404':
+ $ref: '#/components/responses/flow_framework.deprovision@404'
+ /_plugins/_flow_framework/workflow/{workflow_id}/_provision:
+ post:
+ operationId: flow_framework.provision.0
+ x-operation-group: flow_framework.provision
+ x-version-added: '2.12'
+ description: Provisioning a workflow. This API is also executed when the Create or Update Workflow API is called with the provision parameter set to true.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/
+ parameters:
+ - $ref: '#/components/parameters/flow_framework.provision::path.workflow_id'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ requestBody:
+ description: |-
+ Pass dynamic substitution expressions as key-value pairs, either as query parameters or in the request body.
+ For example, if you specified a credential field in the template as `openai_key: '$'`,
+ you can pass `openai_key` as a query parameter or in the request body.
+ $ref: '#/components/requestBodies/flow_framework.provision'
+ responses:
+ '200':
+ $ref: '#/components/responses/flow_framework.provision@200'
+ '400':
+ $ref: '#/components/responses/flow_framework.provision@400'
+ '403':
+ $ref: '#/components/responses/flow_framework.provision@403'
+ /_plugins/_flow_framework/workflow/{workflow_id}/_status:
+ get:
+ operationId: flow_framework.get_status.0
+ x-operation-group: flow_framework.get_status
+ x-version-added: '2.12'
+ description: Get the provisioning deployment status until it is complete.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-status/
+ parameters:
+ - $ref: '#/components/parameters/flow_framework.get_status::path.workflow_id'
+ - $ref: '#/components/parameters/flow_framework.get_status::query.all'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/flow_framework.get_status@200'
+ '403':
+ $ref: '#/components/responses/flow_framework.get_status@403'
+ '404':
+ $ref: '#/components/responses/flow_framework.get_status@404'
+ /_plugins/_flow_framework/workflow/state/_search:
+ get:
+ operationId: flow_framework.search_state.1
+ x-operation-group: flow_framework.search_state
+ x-version-added: '2.12'
+ description: Search for workflows by using a query matching a field.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/automating-configurations/api/search-workflow-state/
+ requestBody:
+ $ref: '#/components/requestBodies/flow_framework.search_state'
+ responses:
+ '200':
+ $ref: '#/components/responses/flow_framework.search_state@200'
+ '400':
+ $ref: '#/components/responses/flow_framework.search_state@400'
+ '403':
+ $ref: '#/components/responses/flow_framework.search_state@403'
+ '408':
+ $ref: '#/components/responses/flow_framework.search_state@408'
+ parameters:
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ post:
+ operationId: flow_framework.search_state.0
+ x-operation-group: flow_framework.search_state
+ x-version-added: '2.12'
+ description: Search for workflows by using a query matching a field.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/automating-configurations/api/search-workflow-state/
+ requestBody:
+ $ref: '#/components/requestBodies/flow_framework.search_state'
+ responses:
+ '200':
+ $ref: '#/components/responses/flow_framework.search_state@200'
+ '400':
+ $ref: '#/components/responses/flow_framework.search_state@400'
+ '403':
+ $ref: '#/components/responses/flow_framework.search_state@403'
+ '408':
+ $ref: '#/components/responses/flow_framework.search_state@408'
+ parameters:
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ /_plugins/_ism/add/{index}:
+ post:
+ operationId: ism.add_policy.0
+ x-operation-group: ism.add_policy
+ description: Adds a policy to an index.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/im-plugin/ism/api/#add-policy
+ parameters:
+ - $ref: '#/components/parameters/ism.add_policy::path.index'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/ism.add_policy'
+ responses:
+ '200':
+ $ref: '#/components/responses/ism.add_policy@200'
+ /_plugins/_ism/change_policy/{index}:
+ post:
+ operationId: ism.change_policy.0
+ x-operation-group: ism.change_policy
+ description: Updates the managed index policy to a new policy.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/im-plugin/ism/api/#update-managed-index-policy
+ parameters:
+ - $ref: '#/components/parameters/ism.change_policy::path.index'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/ism.change_policy'
+ responses:
+ '200':
+ $ref: '#/components/responses/ism.change_policy@200'
+ /_plugins/_ism/explain/{index}:
+ get:
+ operationId: ism.explain_index.0
+ x-operation-group: ism.explain_index
+ description: Gets the currently applied policy on an index.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index
+ parameters:
+ - $ref: '#/components/parameters/ism.explain_index::path.index'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/ism.explain_index@200'
+ /_plugins/_ism/policies/{policy_id}:
+ delete:
+ operationId: ism.delete_policy.0
+ x-operation-group: ism.delete_policy
+ description: Deletes a policy.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/im-plugin/ism/api/#delete-policy
+ parameters:
+ - $ref: '#/components/parameters/ism.delete_policy::path.policy_id'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/ism.delete_policy@200'
+ get:
+ operationId: ism.get_policy.0
+ x-operation-group: ism.get_policy
+ description: Gets the policy.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/im-plugin/ism/api/#get-policy
+ parameters:
+ - $ref: '#/components/parameters/ism.get_policy::path.policy_id'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/ism.get_policy@200'
+ put:
+ operationId: ism.put_policy.0
+ x-operation-group: ism.put_policy
+ description: Creates or updates a policy.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/im-plugin/ism/api/#create-policy
+ parameters:
+ - $ref: '#/components/parameters/ism.put_policy::path.policy_id'
+ - $ref: '#/components/parameters/ism.put_policy::query.if_primary_term'
+ - $ref: '#/components/parameters/ism.put_policy::query.if_seq_no'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/ism.put_policy'
+ responses:
+ '200':
+ $ref: '#/components/responses/ism.put_policy@200'
+ '201':
+ $ref: '#/components/responses/ism.put_policy@201'
+ /_plugins/_ism/remove/{index}:
+ post:
+ operationId: ism.remove_policy.0
+ x-operation-group: ism.remove_policy
+ description: Removes a policy from an index.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/im-plugin/ism/api/#remove-policy
+ parameters:
+ - $ref: '#/components/parameters/ism.remove_policy::path.index'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/ism.remove_policy@200'
/_plugins/_knn/{node_id}/stats:
get:
operationId: knn.stats.2
@@ -6411,13 +6837,15 @@ paths:
'200':
$ref: '#/components/responses/transforms.search@200'
/_plugins/_transform/_preview:
- get:
+ post:
operationId: transforms.preview.0
x-operation-group: transforms.preview
x-version-added: '1.0'
description: Returns a preview of what a transformed index would look like.
externalDocs:
url: https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#preview-a-transform-jobs-results
+ requestBody:
+ $ref: '#/components/requestBodies/transforms.preview'
responses:
'200':
$ref: '#/components/responses/transforms.preview@200'
@@ -11054,6 +11482,147 @@ paths:
$ref: '#/components/responses/asynchronous_search.delete@200'
deprecated: true
x-ignorable: true
+ /_opendistro/_ism/add/{index}:
+ post:
+ operationId: ism.add_policy.0_superseded
+ x-operation-group: ism.add_policy
+ description: Adds a policy to an index.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/im-plugin/ism/api/#add-policy
+ parameters:
+ - $ref: '#/components/parameters/ism.add_policy::path.index'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/ism.add_policy'
+ responses:
+ '200':
+ $ref: '#/components/responses/ism.add_policy@200'
+ deprecated: true
+ x-ignorable: true
+ /_opendistro/_ism/change_policy/{index}:
+ post:
+ operationId: ism.change_policy.0_superseded
+ x-operation-group: ism.change_policy
+ description: Updates the managed index policy to a new policy.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/im-plugin/ism/api/#update-managed-index-policy
+ parameters:
+ - $ref: '#/components/parameters/ism.change_policy::path.index'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/ism.change_policy'
+ responses:
+ '200':
+ $ref: '#/components/responses/ism.change_policy@200'
+ deprecated: true
+ x-ignorable: true
+ /_opendistro/_ism/explain/{index}:
+ get:
+ operationId: ism.explain_index.0_superseded
+ x-operation-group: ism.explain_index
+ description: Gets the currently applied policy on an index.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/im-plugin/ism/api/#explain-index
+ parameters:
+ - $ref: '#/components/parameters/ism.explain_index::path.index'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/ism.explain_index@200'
+ deprecated: true
+ x-ignorable: true
+ /_opendistro/_ism/policies/{policyID}:
+ get:
+ operationId: ism.get_policy.0_superseded
+ x-operation-group: ism.get_policy
+ description: Gets the policy.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/im-plugin/ism/api/#get-policy
+ parameters:
+ - $ref: '#/components/parameters/ism.get_policy::path.policy_id'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/ism.get_policy@200'
+ deprecated: true
+ x-ignorable: true
+ put:
+ operationId: ism.put_policy.0_superseded
+ x-operation-group: ism.put_policy
+ description: Creates or updates a policy.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/im-plugin/ism/api/#create-policy
+ parameters:
+ - $ref: '#/components/parameters/ism.put_policy::path.policy_id'
+ - $ref: '#/components/parameters/ism.put_policy::query.if_primary_term'
+ - $ref: '#/components/parameters/ism.put_policy::query.if_seq_no'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ requestBody:
+ $ref: '#/components/requestBodies/ism.put_policy'
+ responses:
+ '200':
+ $ref: '#/components/responses/ism.put_policy@200'
+ '201':
+ $ref: '#/components/responses/ism.put_policy@201'
+ deprecated: true
+ x-ignorable: true
+ delete:
+ operationId: ism.delete_policy.0_superseded
+ x-operation-group: ism.delete_policy
+ description: Deletes a policy.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/im-plugin/ism/api/#delete-policy
+ parameters:
+ - $ref: '#/components/parameters/ism.delete_policy::path.policy_id'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/ism.delete_policy@200'
+ deprecated: true
+ x-ignorable: true
+ /_opendistro/_ism/remove/{index}:
+ post:
+ operationId: ism.remove_policy.0_superseded
+ x-operation-group: ism.remove_policy
+ description: Removes a policy from an index.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/im-plugin/ism/api/#remove-policy
+ parameters:
+ - $ref: '#/components/parameters/ism.remove_policy::path.index'
+ - $ref: '#/components/parameters/_global::query.pretty'
+ - $ref: '#/components/parameters/_global::query.human'
+ - $ref: '#/components/parameters/_global::query.error_trace'
+ - $ref: '#/components/parameters/_global::query.source'
+ - $ref: '#/components/parameters/_global::query.filter_path'
+ responses:
+ '200':
+ $ref: '#/components/responses/ism.remove_policy@200'
+ deprecated: true
+ x-ignorable: true
/_opendistro/_knn/stats/{stat}:
get:
operationId: knn.stats.1_superseded
@@ -13066,7 +13635,7 @@ components:
_global::query.filter_path:
name: filter_path
in: query
- description: Comma-separated list of filters used to reduce the response.
+ description: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-".
schema:
oneOf:
- type: string
@@ -13268,7 +13837,7 @@ components:
in: query
description: The unit in which to display byte values.
schema:
- $ref: '#/components/schemas/_common:Bytes'
+ $ref: '#/components/schemas/_common:ByteUnit'
cat.all_pit_segments::query.format:
name: format
in: query
@@ -13327,7 +13896,7 @@ components:
name: bytes
description: The unit used to display byte values.
schema:
- $ref: '#/components/schemas/_common:Bytes'
+ $ref: '#/components/schemas/_common:ByteUnit'
style: form
cat.allocation::query.cluster_manager_timeout:
name: cluster_manager_timeout
@@ -13537,7 +14106,7 @@ components:
name: bytes
description: The unit used to display byte values.
schema:
- $ref: '#/components/schemas/_common:Bytes'
+ $ref: '#/components/schemas/_common:ByteUnit'
style: form
cat.fielddata::query.fields:
in: query
@@ -13666,7 +14235,7 @@ components:
name: bytes
description: The unit used to display byte values.
schema:
- $ref: '#/components/schemas/_common:Bytes'
+ $ref: '#/components/schemas/_common:ByteUnit'
style: form
cat.indices::query.cluster_manager_timeout:
name: cluster_manager_timeout
@@ -13917,7 +14486,7 @@ components:
name: bytes
description: The unit used to display byte values.
schema:
- $ref: '#/components/schemas/_common:Bytes'
+ $ref: '#/components/schemas/_common:ByteUnit'
style: form
cat.nodes::query.cluster_manager_timeout:
name: cluster_manager_timeout
@@ -14087,7 +14656,7 @@ components:
in: query
description: The unit in which to display byte values.
schema:
- $ref: '#/components/schemas/_common:Bytes'
+ $ref: '#/components/schemas/_common:ByteUnit'
cat.pit_segments::query.format:
name: format
in: query
@@ -14225,7 +14794,7 @@ components:
name: bytes
description: The unit used to display byte values.
schema:
- $ref: '#/components/schemas/_common:Bytes'
+ $ref: '#/components/schemas/_common:ByteUnit'
style: form
cat.recovery::query.detailed:
in: query
@@ -14396,7 +14965,7 @@ components:
in: query
description: The unit in which to display byte values.
schema:
- $ref: '#/components/schemas/_common:Bytes'
+ $ref: '#/components/schemas/_common:ByteUnit'
cat.segment_replication::query.completed_only:
name: completed_only
in: query
@@ -14528,7 +15097,7 @@ components:
name: bytes
description: The unit used to display byte values.
schema:
- $ref: '#/components/schemas/_common:Bytes'
+ $ref: '#/components/schemas/_common:ByteUnit'
style: form
cat.segments::query.cluster_manager_timeout:
name: cluster_manager_timeout
@@ -14607,7 +15176,7 @@ components:
name: bytes
description: The unit used to display byte values.
schema:
- $ref: '#/components/schemas/_common:Bytes'
+ $ref: '#/components/schemas/_common:ByteUnit'
style: form
cat.shards::query.cluster_manager_timeout:
name: cluster_manager_timeout
@@ -16766,6 +17335,125 @@ components:
type: boolean
default: false
style: form
+ flow_framework.create::query.provision:
+ in: query
+ name: provision
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:Provision'
+ flow_framework.create::query.reprovision:
+ x-version-added: '2.17'
+ in: query
+ name: reprovision
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:Reprovision'
+ flow_framework.create::query.update_fields:
+ in: query
+ name: update_fields
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:UpdateFields'
+ flow_framework.create::query.use_case:
+ description: To use a workflow template, specify it in the use_case query parameter when creating a workflow.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/automating-configurations/workflow-templates/#supported-workflow-templates
+ in: query
+ name: use_case
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:UseCase'
+ flow_framework.create::query.validation:
+ in: query
+ name: validation
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:Validation'
+ flow_framework.delete::path.workflow_id:
+ name: workflow_id
+ in: path
+ required: true
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:WorkflowID'
+ flow_framework.delete::query.clear_status:
+ in: query
+ name: clear_status
+ schema:
+ description: Delete the workflow state (without deprovisioning resources) after deleting the template. OpenSearch deletes the workflow state only if the provisioning status is not IN_PROGRESS. Default is false.
+ type: boolean
+ default: false
+ flow_framework.deprovision::path.workflow_id:
+ name: workflow_id
+ in: path
+ required: true
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:WorkflowID'
+ flow_framework.deprovision::query.allow_delete:
+ in: query
+ name: allow_delete
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:AllowDelete'
+ flow_framework.get_status::path.workflow_id:
+ name: workflow_id
+ in: path
+ required: true
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:WorkflowID'
+ flow_framework.get_status::query.all:
+ description: The all parameter specifies whether the response should return all fields.
+ in: query
+ name: all
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:All'
+ flow_framework.get_steps::query.workflow_step:
+ in: query
+ name: workflow_step
+ required: false
+ schema:
+ description: The name of the step to retrieve.
+ $ref: '#/components/schemas/flow_framework.common:WorkflowStepName'
+ flow_framework.get::path.workflow_id:
+ name: workflow_id
+ in: path
+ required: true
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:WorkflowID'
+ flow_framework.provision::path.workflow_id:
+ name: workflow_id
+ in: path
+ required: true
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:WorkflowID'
+ flow_framework.update::path.workflow_id:
+ name: workflow_id
+ in: path
+ required: true
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:WorkflowID'
+ flow_framework.update::query.provision:
+ in: query
+ name: provision
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:Provision'
+ flow_framework.update::query.reprovision:
+ x-version-added: '2.17'
+ in: query
+ name: reprovision
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:Reprovision'
+ flow_framework.update::query.update_fields:
+ in: query
+ name: update_fields
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:UpdateFields'
+ flow_framework.update::query.use_case:
+ description: To use a workflow template, specify it in the use_case query parameter when creating a workflow.
+ externalDocs:
+ url: https://opensearch.org/docs/latest/automating-configurations/workflow-templates/#supported-workflow-templates
+ in: query
+ name: use_case
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:UseCase'
+ flow_framework.update::query.validation:
+ in: query
+ name: validation
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:Validation'
get_script::path.id:
in: path
name: id
@@ -19724,6 +20412,78 @@ components:
type: boolean
default: false
style: form
+ ism.add_policy::path.index:
+ name: index
+ in: path
+ description: |-
+ Comma-separated list of data streams, indices, and aliases.
+ Supports wildcards (`*`).
+ required: true
+ schema:
+ $ref: '#/components/schemas/_common:IndexName'
+ style: simple
+ ism.change_policy::path.index:
+ name: index
+ in: path
+ description: |-
+ Comma-separated list of data streams, indices, and aliases.
+ Supports wildcards (`*`).
+ required: true
+ schema:
+ $ref: '#/components/schemas/_common:IndexName'
+ style: simple
+ ism.delete_policy::path.policy_id:
+ name: policy_id
+ in: path
+ required: true
+ schema:
+ type: string
+ ism.explain_index::path.index:
+ name: index
+ in: path
+ description: |-
+ Comma-separated list of data streams, indices, and aliases.
+ Supports wildcards (`*`).
+ required: true
+ schema:
+ $ref: '#/components/schemas/_common:IndexName'
+ style: simple
+ ism.get_policy::path.policy_id:
+ name: policy_id
+ in: path
+ required: true
+ schema:
+ type: string
+ ism.put_policy::path.policy_id:
+ name: policy_id
+ in: path
+ required: true
+ schema:
+ type: string
+ ism.put_policy::query.if_primary_term:
+ name: if_primary_term
+ in: query
+ description: Only perform the operation if the document has this primary term.
+ schema:
+ type: number
+ style: form
+ ism.put_policy::query.if_seq_no:
+ name: if_seq_no
+ in: query
+ description: Only perform the operation if the document has this sequence number.
+ schema:
+ $ref: '#/components/schemas/_common:SequenceNumber'
+ style: form
+ ism.remove_policy::path.index:
+ name: index
+ in: path
+ description: |-
+ Comma-separated list of data streams, indices, and aliases.
+ Supports wildcards (`*`).
+ required: true
+ schema:
+ $ref: '#/components/schemas/_common:IndexName'
+ style: simple
knn.delete_model::path.model_id:
name: model_id
in: path
@@ -23607,6 +24367,11 @@ components:
description: Specifies the ID of the shard that you would like an explanation for.
type: number
description: The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'
+ cluster.delete_weighted_routing:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/cluster.weighted_routing:WeightsBase'
cluster.put_component_template:
content:
application/json:
@@ -23644,6 +24409,11 @@ components:
additionalProperties: {}
description: The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).
required: true
+ cluster.put_weighted_routing:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/cluster.weighted_routing:Weights'
cluster.reroute:
content:
application/json:
@@ -23722,6 +24492,34 @@ components:
runtime_mappings:
$ref: '#/components/schemas/_common.mapping:RuntimeFields'
description: An index filter specified with the Query DSL
+ flow_framework.create:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:FlowFrameworkCreate'
+ flow_framework.provision:
+ required: false
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:UserProvidedSubstitutionExpressions'
+ flow_framework.search:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:SearchWorkflowRequest'
+ flow_framework.search_state:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:SearchWorkflowRequest'
+ flow_framework.update:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/flow_framework.common:FlowFrameworkUpdate'
index:
content:
application/json:
@@ -24134,6 +24932,21 @@ components:
$ref: '#/components/schemas/ingest._common:Pipeline'
description: The simulate definition
required: true
+ ism.add_policy:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ism._common:AddPolicyRequest'
+ ism.change_policy:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ism._common:ChangePolicyRequest'
+ ism.put_policy:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ism._common:PutPolicyRequest'
knn.search_models:
content:
application/json:
@@ -25002,6 +25815,16 @@ components:
additionalProperties:
type: string
description: Define parameters and or supply a document to get termvectors for. See documentation.
+ transforms.preview:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ transform:
+ $ref: '#/components/schemas/transforms._common:Transform'
+ required:
+ - transform
transforms.put:
content:
application/json:
@@ -25431,11 +26254,19 @@ components:
application/json:
schema:
$ref: '#/components/schemas/_common:AcknowledgedResponseBase'
- cluster.delete_decommission_awareness@200: {}
+ cluster.delete_decommission_awareness@200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/_common:AcknowledgedResponseBase'
cluster.delete_voting_config_exclusions@200:
content:
application/json: {}
- cluster.delete_weighted_routing@200: {}
+ cluster.delete_weighted_routing@200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/_common:AcknowledgedResponseBase'
cluster.exists_component_template@200:
content:
application/json: {}
@@ -25451,7 +26282,11 @@ components:
$ref: '#/components/schemas/cluster._common:ComponentTemplate'
required:
- component_templates
- cluster.get_decommission_awareness@200: {}
+ cluster.get_decommission_awareness@200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/cluster.decommission_awareness:DecommissionStatusResponse'
cluster.get_settings@200:
content:
application/json:
@@ -25470,7 +26305,11 @@ components:
required:
- persistent
- transient
- cluster.get_weighted_routing@200: {}
+ cluster.get_weighted_routing@200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/cluster.weighted_routing:WeightsResponse'
cluster.health@200:
content:
application/json:
@@ -25496,7 +26335,11 @@ components:
application/json:
schema:
$ref: '#/components/schemas/_common:AcknowledgedResponseBase'
- cluster.put_decommission_awareness@200: {}
+ cluster.put_decommission_awareness@200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/_common:AcknowledgedResponseBase'
cluster.put_settings@200:
content:
application/json:
@@ -25515,7 +26358,11 @@ components:
- acknowledged
- persistent
- transient
- cluster.put_weighted_routing@200: {}
+ cluster.put_weighted_routing@200:
+ content:
+ application/json:
+ schema:
+ type: object
cluster.remote_info@200:
content:
application/json:
@@ -25559,6 +26406,8 @@ components:
schema:
type: object
properties:
+ terminated_early:
+ type: boolean
count:
type: number
_shards:
@@ -25629,42 +26478,12 @@ components:
content:
application/json:
schema:
- type: object
- properties:
- batches:
- type: number
- deleted:
- type: number
- failures:
- type: array
- items:
- $ref: '#/components/schemas/_common:BulkIndexByScrollFailure'
- noops:
- type: number
- requests_per_second:
- type: number
- retries:
- $ref: '#/components/schemas/_common:Retries'
- slice_id:
- type: number
- task:
- $ref: '#/components/schemas/_common:TaskId'
- throttled:
- $ref: '#/components/schemas/_common:Duration'
- throttled_millis:
- $ref: '#/components/schemas/_common:DurationValueUnitMillis'
- throttled_until:
- $ref: '#/components/schemas/_common:Duration'
- throttled_until_millis:
- $ref: '#/components/schemas/_common:DurationValueUnitMillis'
- timed_out:
- type: boolean
- took:
- $ref: '#/components/schemas/_common:DurationValueUnitMillis'
- total:
- type: number
- version_conflicts:
- type: number
+ oneOf:
+ - $ref: '#/components/schemas/_common:BulkByScrollResponseBase'
+ - type: object
+ properties:
+ task:
+ $ref: '#/components/schemas/_common:TaskId'
delete_pit@200:
content:
application/json:
@@ -25728,6 +26547,175 @@ components:
required:
- fields
- indices
+ flow_framework.create@201:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ workflow_id:
+ type: string
+ description: The ID of the workflow to be updated. Required for the PUT method.
+ required:
+ - workflow_id
+ flow_framework.create@400:
+ description: Bad Request - Multiple possible reasons
+ content:
+ application/json:
+ oneOf:
+ - $ref: '#/components/schemas/flow_framework.errors:InvalidParameterError'
+ - $ref: '#/components/schemas/flow_framework.errors:ConflictError'
+ - $ref: '#/components/schemas/flow_framework.errors:MissingParameterError'
+ - $ref: '#/components/schemas/flow_framework.errors:ParameterConflictError'
+ - $ref: '#/components/schemas/flow_framework.errors:MaxWorkflowsLimitError'
+ - $ref: '#/components/schemas/flow_framework.errors:WorkflowSaveError'
+ flow_framework.create@403:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError'
+ flow_framework.delete@200:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.common:FlowFrameworkDeleteResponse'
+ flow_framework.delete@400:
+ description: Work Flow Id Null Error
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:WorkFlowIdNullError'
+ flow_framework.delete@403:
+ description: Flow Framework API Disabled Error
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError'
+ flow_framework.deprovision@200:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.common:WorkflowID'
+ flow_framework.deprovision@202:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:DeprovisioningError'
+ flow_framework.deprovision@403:
+ content:
+ application/json:
+ oneOf:
+ - $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError'
+ - $ref: '#/components/schemas/flow_framework.errors:DeprovisioningForbiddenError'
+ flow_framework.deprovision@404:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:TemplateNotFoundError'
+ flow_framework.get_status@200:
+ content:
+ application/json:
+ oneOf:
+ - $ref: '#/components/schemas/flow_framework.common:WorkFlowStatusFullResponse'
+ - $ref: '#/components/schemas/flow_framework.common:WorkFlowStatusDefaultResponse'
+ flow_framework.get_status@403:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError'
+ flow_framework.get_status@404:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:TemplateNotFoundError'
+ flow_framework.get_steps@200:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.common:WorkflowStep'
+ flow_framework.get_steps@400:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:WorkflowStepsRetrieveError'
+ flow_framework.get_steps@403:
+ description: Flow Framework API Disabled Error
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError'
+ flow_framework.get@200:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.common:FlowFrameworkGetResponse'
+ flow_framework.get@404:
+ description: Template Not Found Error
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:TemplateNotFoundError'
+ flow_framework.provision@200:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.common:WorkflowID'
+ flow_framework.provision@400:
+ content:
+ application/json:
+ oneOf:
+ - $ref: '#/components/schemas/flow_framework.errors:WorkFlowIdNullError'
+ - $ref: '#/components/schemas/flow_framework.errors:RequestBodyParsingFailedError'
+ - $ref: '#/components/schemas/flow_framework.errors:InvalidRequestBodyFieldError'
+ - $ref: '#/components/schemas/flow_framework.errors:DuplicateKeyError'
+ flow_framework.provision@403:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError'
+ flow_framework.search_state@200:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.common:WorkflowSearchStateResponse'
+ flow_framework.search_state@400:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:BadRequestError'
+ flow_framework.search_state@403:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError'
+ flow_framework.search_state@408:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:RequestTimeoutError'
+ flow_framework.search@200:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.common:WorkflowSearchResponse'
+ flow_framework.search@400:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:BadRequestError'
+ flow_framework.search@403:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:FlowFrameworkAPIDisabledError'
+ flow_framework.search@408:
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:RequestTimeoutError'
+ flow_framework.update@201:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ workflow_id:
+ type: string
+ description: The ID of the workflow to be updated. Required for the PUT method.
+ required:
+ - workflow_id
+ flow_framework.update@400:
+ description: Bad Request - Multiple possible reasons
+ content:
+ application/json:
+ oneOf:
+ - $ref: '#/components/schemas/flow_framework.errors:InvalidParameterError'
+ - $ref: '#/components/schemas/flow_framework.errors:ConflictError'
+ - $ref: '#/components/schemas/flow_framework.errors:MissingParameterError'
+ - $ref: '#/components/schemas/flow_framework.errors:ParameterConflictError'
+ - $ref: '#/components/schemas/flow_framework.errors:MaxWorkflowsLimitError'
+ - $ref: '#/components/schemas/flow_framework.errors:WorkflowSaveError'
+ flow_framework.update@404:
+ description: Template Not Found Error
+ content:
+ application/json:
+ $ref: '#/components/schemas/flow_framework.errors:TemplateNotFoundError'
get_all_pits@200:
content:
application/json:
@@ -25912,10 +26900,10 @@ components:
items:
$ref: '#/components/schemas/indices.data_streams_stats:DataStreamsStatsItem'
total_store_sizes:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_store_size_bytes:
description: Total size, in bytes, of all shards for the selected data streams.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- _shards
- backing_indices
@@ -26344,6 +27332,46 @@ components:
$ref: '#/components/schemas/ingest.simulate:PipelineSimulation'
required:
- docs
+ ism.add_policy@200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ism._common:AddPolicyResponse'
+ ism.change_policy@200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ism._common:ChangePolicyResponse'
+ ism.delete_policy@200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ism._common:DeletePolicyResponse'
+ ism.explain_index@200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ism._common:ExplainIndexResponse'
+ ism.get_policy@200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ism._common:GetPolicyResponse'
+ ism.put_policy@200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ism._common:PutPolicyResponse'
+ ism.put_policy@201:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ism._common:PutPolicyResponse'
+ ism.remove_policy@200:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ism._common:RemovePolicyResponse'
knn.delete_model@200: {}
knn.get_model@200: {}
knn.search_models@200: {}
@@ -26756,42 +27784,12 @@ components:
content:
application/json:
schema:
- type: object
- properties:
- batches:
- type: number
- created:
- type: number
- deleted:
- type: number
- failures:
- type: array
- items:
- $ref: '#/components/schemas/_common:BulkIndexByScrollFailure'
- noops:
- type: number
- retries:
- $ref: '#/components/schemas/_common:Retries'
- requests_per_second:
- type: number
- slice_id:
- type: number
- task:
- $ref: '#/components/schemas/_common:TaskId'
- throttled_millis:
- $ref: '#/components/schemas/_common:EpochTimeUnitMillis'
- throttled_until_millis:
- $ref: '#/components/schemas/_common:EpochTimeUnitMillis'
- timed_out:
- type: boolean
- took:
- $ref: '#/components/schemas/_common:DurationValueUnitMillis'
- total:
- type: number
- updated:
- type: number
- version_conflicts:
- type: number
+ oneOf:
+ - $ref: '#/components/schemas/_common:BulkByScrollResponseBase'
+ - type: object
+ properties:
+ task:
+ $ref: '#/components/schemas/_common:TaskId'
remote_store.restore@200:
content:
application/json:
@@ -27756,7 +28754,7 @@ components:
task:
$ref: '#/components/schemas/tasks._common:TaskInfo'
response:
- type: object
+ $ref: '#/components/schemas/tasks._common:TaskResponse'
error:
$ref: '#/components/schemas/_common:ErrorCause'
required:
@@ -27845,42 +28843,12 @@ components:
content:
application/json:
schema:
- type: object
- properties:
- batches:
- type: number
- failures:
- type: array
- items:
- $ref: '#/components/schemas/_common:BulkIndexByScrollFailure'
- noops:
- type: number
- deleted:
- type: number
- requests_per_second:
- type: number
- retries:
- $ref: '#/components/schemas/_common:Retries'
- task:
- $ref: '#/components/schemas/_common:TaskId'
- timed_out:
- type: boolean
- took:
- $ref: '#/components/schemas/_common:DurationValueUnitMillis'
- total:
- type: number
- updated:
- type: number
- version_conflicts:
- type: number
- throttled:
- $ref: '#/components/schemas/_common:Duration'
- throttled_millis:
- $ref: '#/components/schemas/_common:DurationValueUnitMillis'
- throttled_until:
- $ref: '#/components/schemas/_common:Duration'
- throttled_until_millis:
- $ref: '#/components/schemas/_common:DurationValueUnitMillis'
+ oneOf:
+ - $ref: '#/components/schemas/_common:BulkByScrollResponseBase'
+ - type: object
+ properties:
+ task:
+ $ref: '#/components/schemas/_common:TaskId'
update@200:
content:
application/json:
@@ -27920,12 +28888,100 @@ components:
transport_address:
$ref: '#/components/schemas/_common:TransportAddress'
required:
- - attributes
- - host
- - ip
- name
- - transport_address
- _common:BulkIndexByScrollFailure:
+ _common:BulkByScrollFailure:
+ anyOf:
+ - $ref: '#/components/schemas/_common:BulkItemResponseFailure'
+ - $ref: '#/components/schemas/_common:ScrollableHitSourceSearchFailure'
+ _common:BulkByScrollResponseBase:
+ allOf:
+ - $ref: '#/components/schemas/_common:BulkByScrollTaskStatus'
+ - type: object
+ properties:
+ took:
+ type: integer
+ format: int64
+ timed_out:
+ type: boolean
+ failures:
+ type: array
+ items:
+ $ref: '#/components/schemas/_common:BulkByScrollFailure'
+ required:
+ - failures
+ - timed_out
+ - took
+ _common:BulkByScrollTaskStatus:
+ type: object
+ properties:
+ slice_id:
+ type: integer
+ format: int32
+ total:
+ description: The number of documents that were successfully processed.
+ type: integer
+ format: int64
+ updated:
+ description: The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it.
+ type: integer
+ format: int64
+ created:
+ description: The number of documents that were successfully created.
+ type: integer
+ format: int64
+ deleted:
+ description: The number of documents that were successfully deleted.
+ type: integer
+ format: int64
+ batches:
+ description: The number of scroll responses pulled back by the reindex.
+ type: integer
+ format: int32
+ version_conflicts:
+ description: The number of version conflicts that reindex hits.
+ type: integer
+ format: int64
+ noops:
+ description: The number of documents that were ignored.
+ type: integer
+ format: int64
+ retries:
+ $ref: '#/components/schemas/_common:Retries'
+ throttled_millis:
+ $ref: '#/components/schemas/_common:DurationValueUnitMillis'
+ throttled:
+ $ref: '#/components/schemas/_common:Duration'
+ requests_per_second:
+ description: The number of requests per second effectively executed during the reindex.
+ type: number
+ format: float
+ canceled:
+ type: string
+ throttled_until_millis:
+ $ref: '#/components/schemas/_common:DurationValueUnitMillis'
+ throttled_until:
+ $ref: '#/components/schemas/_common:Duration'
+ slices:
+ type: array
+ items:
+ $ref: '#/components/schemas/_common:BulkByScrollTaskStatusOrException'
+ required:
+ - batches
+ - deleted
+ - noops
+ - requests_per_second
+ - retries
+ - throttled_millis
+ - throttled_until_millis
+ - total
+ - version_conflicts
+ _common:BulkByScrollTaskStatusOrException:
+ oneOf:
+ - title: status
+ $ref: '#/components/schemas/_common:BulkByScrollTaskStatus'
+ - title: exception
+ $ref: '#/components/schemas/_common:ErrorCause'
+ _common:BulkItemResponseFailure:
type: object
properties:
cause:
@@ -27935,18 +28991,18 @@ components:
index:
$ref: '#/components/schemas/_common:IndexName'
status:
- type: number
- type:
- type: string
+ type: integer
+ format: int32
required:
- cause
- - id
- index
- status
- - type
_common:byte:
type: number
- _common:Bytes:
+ _common:ByteCount:
+ type: integer
+ format: int64
+ _common:ByteUnit:
type: string
enum:
- b
@@ -27960,10 +29016,6 @@ components:
- pb
- t
- tb
- _common:ByteSize:
- oneOf:
- - type: number
- - type: string
_common:ClusterDetails:
type: object
properties:
@@ -28024,9 +29076,9 @@ components:
properties:
size_in_bytes:
description: Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
fields:
type: object
additionalProperties:
@@ -28223,9 +29275,9 @@ components:
evictions:
type: number
memory_size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
memory_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
fields:
type: object
additionalProperties:
@@ -28236,9 +29288,9 @@ components:
type: object
properties:
memory_size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
memory_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- memory_size_in_bytes
_common:Fields:
@@ -28251,9 +29303,9 @@ components:
type: object
properties:
size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- size_in_bytes
_common:FieldValue:
@@ -28264,6 +29316,10 @@ components:
- number
- object
- string
+ _common:FieldWithOrder:
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/_common:ScoreSort'
_common:FlushStats:
type: object
properties:
@@ -28377,7 +29433,7 @@ components:
properties:
total:
type: number
- time:
+ getTime:
$ref: '#/components/schemas/_common:Duration'
time_in_millis:
$ref: '#/components/schemas/_common:DurationValueUnitMillis'
@@ -28439,6 +29495,9 @@ components:
- type: array
items:
type: string
+ _common:HumanReadableByteCount:
+ type: string
+ pattern: \d+(\.\d+)?(b|kb|k|mb|m|gb|g|tb|t|pb|p)
_common:IBDistribution:
type: string
enum:
@@ -28632,21 +29691,21 @@ components:
current_docs:
type: number
current_size:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
current_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
total:
type: number
total_auto_throttle:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_auto_throttle_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
total_docs:
type: number
total_size:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
total_stopped_time:
$ref: '#/components/schemas/_common:Duration'
total_stopped_time_in_millis:
@@ -28688,6 +29747,13 @@ components:
- type: string
_common:MultiTermQueryRewrite:
type: string
+ enum:
+ - constant_score
+ - constant_score_boolean
+ - scoring_boolean
+ - top_terms_N
+ - top_terms_blended_freqs_N
+ - top_terms_boost_N
_common:Name:
type: string
_common:Names:
@@ -28745,23 +29811,32 @@ components:
_common:NodeName:
type: string
_common:NodeRole:
- type: string
- enum:
- - client
- - cluster_manager
- - coordinating_only
- - data
- - data_cold
- - data_content
- - data_frozen
- - data_hot
- - data_warm
- - ingest
- - master
- - ml
- - remote_cluster_client
- - transform
- - voting_only
+ oneOf:
+ - type: string
+ enum:
+ - client
+ - coordinating_only
+ - data
+ - data_cold
+ - data_content
+ - data_frozen
+ - data_hot
+ - data_warm
+ - ingest
+ - ml
+ - remote_cluster_client
+ - transform
+ - voting_only
+ - type: string
+ enum:
+ - master
+ deprecated: true
+ x-version-deprecated: '2.0'
+ x-deprecation-message: To promote inclusive language, use 'cluster_manager' instead.
+ - type: string
+ enum:
+ - cluster_manager
+ x-version-added: '2.0'
_common:NodeRoles:
description: Node roles.
type: array
@@ -28810,13 +29885,13 @@ components:
$ref: '#/components/schemas/_common:ErrorCause'
total:
description: Total number of nodes selected by the request.
- type: number
+ type: integer
successful:
description: Number of nodes that responded successfully to the request.
- type: number
+ type: integer
failed:
description: Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.
- type: number
+ type: integer
required:
- failed
- successful
@@ -28869,10 +29944,11 @@ components:
- index
_common:Password:
type: string
- _common:Percentage:
- oneOf:
- - type: string
- - type: number
+ _common:PercentageNumber:
+ type: number
+ _common:PercentageString:
+ type: string
+ pattern: \d+(\.\d+)?
_common:PhaseTook:
type: object
properties:
@@ -28961,10 +30037,10 @@ components:
description: Total count of query cache hits across all shards assigned to selected nodes.
type: number
memory_size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
memory_size_in_bytes:
description: Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
miss_count:
description: Total count of query cache misses across all shards assigned to selected nodes.
type: number
@@ -29018,6 +30094,8 @@ components:
properties:
external_total:
type: number
+ external_total_time:
+ $ref: '#/components/schemas/_common:Duration'
external_total_time_in_millis:
$ref: '#/components/schemas/_common:DurationValueUnitMillis'
listeners:
@@ -29050,6 +30128,9 @@ components:
total_download_size:
description: The total amount of data download from the remote segment store.
$ref: '#/components/schemas/_common:RemoteStoreUploadDownloadStats'
+ total_time_spent:
+ description: The total duration, spent on downloads from the remote segment store.
+ $ref: '#/components/schemas/_common:Duration'
total_time_spent_in_millis:
description: The total duration, in milliseconds, spent on downloads from the remote segment store.
$ref: '#/components/schemas/_common:DurationValueUnitMillis'
@@ -29089,15 +30170,24 @@ components:
type: object
description: The total amount of data uploaded to the remote translog store.
properties:
+ failed:
+ description: The number of bytes that failed to upload to the remote translog store.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
failed_bytes:
description: The number of bytes that failed to upload to the remote translog store.
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
+ started:
+ description: The number of bytes successfully uploaded to the remote translog store.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
started_bytes:
description: The number of bytes successfully uploaded to the remote translog store.
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
+ succeeded:
+ description: The number of bytes successfully uploaded to the remote translog store.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
succeeded_bytes:
description: The number of bytes successfully uploaded to the remote translog store.
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- failed_bytes
- started_bytes
@@ -29123,15 +30213,24 @@ components:
type: object
description: The amount of data, in bytes, uploaded or downloaded to/from the remote segment store.
properties:
+ failed:
+ description: The number of bytes that failed to upload/upload to/from the remote segment store.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
failed_bytes:
description: The number of bytes that failed to upload/upload to/from the remote segment store.
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
+ started:
+ description: The number of bytes to upload/download to/from the remote segment store after the upload/download has started.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
started_bytes:
description: The number of bytes to upload/download to/from the remote segment store after the upload/download has started.
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
+ succeeded:
+ description: The number of bytes successfully uploaded/downloaded to/from the remote segment store.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
succeeded_bytes:
description: The number of bytes successfully uploaded/downloaded to/from the remote segment store.
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- failed_bytes
- started_bytes
@@ -29149,12 +30248,18 @@ components:
type: object
description: The amount of lag during upload between the remote segment store and the local store.
properties:
+ max:
+ description: The maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
max_bytes:
description: The maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store.
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
+ total:
+ description: The total number of bytes that lagged during the upload refresh between the remote segment store and the local store.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_bytes:
description: The total number of bytes that lagged during the upload refresh between the remote segment store and the local store.
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- max_bytes
- total_bytes
@@ -29162,6 +30267,9 @@ components:
type: object
description: Statistics related to uploads to the remote segment store.
properties:
+ max_refresh_time_lag:
+ description: The maximum duration that the remote refresh is behind the local refresh.
+ $ref: '#/components/schemas/_common:Duration'
max_refresh_time_lag_in_millis:
description: The maximum duration, in milliseconds, that the remote refresh is behind the local refresh.
$ref: '#/components/schemas/_common:DurationValueUnitMillis'
@@ -29169,6 +30277,9 @@ components:
$ref: '#/components/schemas/_common:RemoteStoreUploadPressureStats'
refresh_size_lag:
$ref: '#/components/schemas/_common:RemoteStoreUploadRefreshSizeLagStats'
+ total_time_spent:
+ description: The total amount of time, spent on uploads to the remote segment store.
+ $ref: '#/components/schemas/_common:Duration'
total_time_spent_in_millis:
description: The total amount of time, in milliseconds, spent on uploads to the remote segment store.
$ref: '#/components/schemas/_common:DurationValueUnitMillis'
@@ -29188,9 +30299,9 @@ components:
hit_count:
type: number
memory_size:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
memory_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
miss_count:
type: number
required:
@@ -29201,6 +30312,8 @@ components:
_common:RequestStats:
type: object
properties:
+ time:
+ $ref: '#/components/schemas/_common:Duration'
time_in_millis:
$ref: '#/components/schemas/_common:DurationValueUnitMillis'
current:
@@ -29219,9 +30332,11 @@ components:
type: object
properties:
bulk:
- type: number
+ type: integer
+ format: int64
search:
- type: number
+ type: integer
+ format: int64
required:
- bulk
- search
@@ -29298,6 +30413,24 @@ components:
- number
- string
- version
+ _common:ScrollableHitSourceSearchFailure:
+ type: object
+ properties:
+ index:
+ $ref: '#/components/schemas/_common:IndexName'
+ shard:
+ type: integer
+ format: int32
+ node:
+ type: string
+ status:
+ type: integer
+ format: int32
+ reason:
+ $ref: '#/components/schemas/_common:ErrorCause'
+ required:
+ - reason
+ - status
_common:ScrollId:
type: string
_common:ScrollIds:
@@ -29418,11 +30551,11 @@ components:
type: object
properties:
max_bytes_behind:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
max_replication_lag:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
total_bytes_behind:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- max_bytes_behind
- max_replication_lag
@@ -29434,10 +30567,10 @@ components:
description: Total number of segments across all shards assigned to selected nodes.
type: number
doc_values_memory:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
doc_values_memory_in_bytes:
description: Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
file_sizes:
description: |-
This object is not populated by the cluster stats API.
@@ -29446,55 +30579,62 @@ components:
additionalProperties:
$ref: '#/components/schemas/indices.stats:ShardFileSizeInfo'
fixed_bit_set:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
fixed_bit_set_memory_in_bytes:
description: Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
index_writer_memory:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
index_writer_max_memory_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
index_writer_memory_in_bytes:
description: Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
max_unsafe_auto_id_timestamp:
description: Unix timestamp, in milliseconds, of the most recently retried indexing request.
type: number
memory:
- $ref: '#/components/schemas/_common:ByteSize'
+ description: Total amount, of memory used for segments across all shards assigned to selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
memory_in_bytes:
description: Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
norms_memory:
- $ref: '#/components/schemas/_common:ByteSize'
+ description: Total amount of memory used for normalization factors across all shards assigned to selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
norms_memory_in_bytes:
description: Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
points_memory:
- $ref: '#/components/schemas/_common:ByteSize'
+ description: Total amount of memory used for points across all shards assigned to selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
points_memory_in_bytes:
description: Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
- type: number
- stored_memory:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
+ stored_fields_memory:
+ description: Total amount of memory used for stored fields across all shards assigned to selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
stored_fields_memory_in_bytes:
description: Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ terms_memory:
+ description: Total amount of memory used for terms across all shards assigned to selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
terms_memory_in_bytes:
description: Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
- type: number
- terms_memory:
- $ref: '#/components/schemas/_common:ByteSize'
- term_vectory_memory:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
+ term_vectors_memory:
+ description: Total amount of memory used for term vectors across all shards assigned to selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
term_vectors_memory_in_bytes:
description: Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
version_map_memory:
- $ref: '#/components/schemas/_common:ByteSize'
+ description: Total amount of memory used by all version maps across all shards assigned to selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
version_map_memory_in_bytes:
description: Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
remote_store:
$ref: '#/components/schemas/_common:RemoteStoreStats'
segment_replication:
@@ -29514,7 +30654,7 @@ components:
- terms_memory_in_bytes
- version_map_memory_in_bytes
_common:SequenceNumber:
- type: number
+ type: integer
format: int64
_common:ShardFailure:
type: object
@@ -29526,7 +30666,7 @@ components:
reason:
$ref: '#/components/schemas/_common:ErrorCause'
shard:
- type: number
+ type: integer
status:
type: string
required:
@@ -29590,6 +30730,7 @@ components:
_common:SortCombinations:
oneOf:
- $ref: '#/components/schemas/_common:Field'
+ - $ref: '#/components/schemas/_common:FieldWithOrder'
- $ref: '#/components/schemas/_common:SortOptions'
_common:SortMode:
type: string
@@ -29649,15 +30790,15 @@ components:
type: object
properties:
size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
size_in_bytes:
description: Total size, in bytes, of all shards assigned to selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
reserved:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
reserved_in_bytes:
description: A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- reserved_in_bytes
- size_in_bytes
@@ -29721,7 +30862,7 @@ components:
type: object
properties:
task_id:
- type: number
+ type: integer
node_id:
$ref: '#/components/schemas/_common:NodeId'
status:
@@ -29782,15 +30923,15 @@ components:
remote_store:
$ref: '#/components/schemas/_common:RemoteStoreTranslogStats'
size:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
uncommitted_operations:
type: number
uncommitted_size:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
uncommitted_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- earliest_last_modified_age
- operations
@@ -29803,16 +30944,17 @@ components:
type: string
x-version-removed: '2.0'
_common:uint:
- type: number
+ type: integer
_common:ulong:
type: number
_common:UnitMillis:
description: Time unit for milliseconds.
- type: number
+ type: integer
format: int64
_common:UnitNanos:
description: Time unit for nanoseconds.
- type: number
+ type: integer
+ format: int64
_common:UnitSeconds:
description: Time unit for seconds.
type: number
@@ -29821,7 +30963,7 @@ components:
_common:Uuid:
type: string
_common:VersionNumber:
- type: number
+ type: integer
format: int64
_common:VersionString:
type: string
@@ -29891,7 +31033,7 @@ components:
_index:
$ref: '#/components/schemas/_common:IndexName'
_primary_term:
- type: number
+ type: integer
format: int64
result:
$ref: '#/components/schemas/_common:Result'
@@ -29911,6 +31053,32 @@ components:
- _shards
- _version
- result
+ _common:XyCartesianCoordinates:
+ x-version-added: '2.4'
+ type: object
+ properties:
+ x:
+ description: The x coordinate.
+ type: number
+ y:
+ description: The y coordinate.
+ type: number
+ required:
+ - x
+ - y
+ _common:XyLocation:
+ x-version-added: '2.4'
+ description: |-
+ A two-dimensional Cartesian point specified by x and y coordinates. It can be represented in various ways:
+ - as a `{x, y}` object
+ - as a `[x, y]` array
+ - as a string in `"x, y"` or WKT point formats.
+ oneOf:
+ - $ref: '#/components/schemas/_common:XyCartesianCoordinates'
+ - type: array
+ items:
+ type: number
+ - type: string
_common.aggregations:AdjacencyMatrixAggregate:
allOf:
- $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseAdjacencyMatrixBucket'
@@ -35755,6 +36923,10 @@ components:
$ref: '#/components/schemas/_common.mapping:GeoOrientation'
strategy:
$ref: '#/components/schemas/_common.mapping:GeoStrategy'
+ deprecated: true
+ distance_error_pct:
+ type: number
+ deprecated: true
type:
type: string
enum:
@@ -36082,23 +37254,6 @@ components:
- percolator
required:
- type
- _common.mapping:PointProperty:
- allOf:
- - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase'
- - type: object
- properties:
- ignore_malformed:
- type: boolean
- ignore_z_value:
- type: boolean
- null_value:
- type: string
- type:
- type: string
- enum:
- - point
- required:
- - type
_common.mapping:Property:
type: object
discriminator:
@@ -36134,8 +37289,8 @@ components:
- $ref: '#/components/schemas/_common.mapping:TokenCountProperty'
- $ref: '#/components/schemas/_common.mapping:GeoPointProperty'
- $ref: '#/components/schemas/_common.mapping:GeoShapeProperty'
- - $ref: '#/components/schemas/_common.mapping:PointProperty'
- - $ref: '#/components/schemas/_common.mapping:ShapeProperty'
+ - $ref: '#/components/schemas/_common.mapping:XyPointProperty'
+ - $ref: '#/components/schemas/_common.mapping:XyShapeProperty'
- $ref: '#/components/schemas/_common.mapping:ByteNumberProperty'
- $ref: '#/components/schemas/_common.mapping:DoubleNumberProperty'
- $ref: '#/components/schemas/_common.mapping:FloatNumberProperty'
@@ -36303,25 +37458,6 @@ components:
- search_as_you_type
required:
- type
- _common.mapping:ShapeProperty:
- allOf:
- - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase'
- - type: object
- properties:
- coerce:
- type: boolean
- ignore_malformed:
- type: boolean
- ignore_z_value:
- type: boolean
- orientation:
- $ref: '#/components/schemas/_common.mapping:GeoOrientation'
- type:
- type: string
- enum:
- - shape
- required:
- - type
_common.mapping:ShortNumberProperty:
allOf:
- $ref: '#/components/schemas/_common.mapping:NumberPropertyBase'
@@ -36564,6 +37700,44 @@ components:
type: string
required:
- type
+ _common.mapping:XyPointProperty:
+ x-version-added: '2.4'
+ allOf:
+ - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase'
+ - type: object
+ properties:
+ ignore_malformed:
+ type: boolean
+ ignore_z_value:
+ type: boolean
+ null_value:
+ $ref: '#/components/schemas/_common:XyLocation'
+ type:
+ type: string
+ enum:
+ - xy_point
+ required:
+ - type
+ _common.mapping:XyShapeProperty:
+ x-version-added: '2.4'
+ allOf:
+ - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase'
+ - type: object
+ properties:
+ coerce:
+ type: boolean
+ ignore_malformed:
+ type: boolean
+ ignore_z_value:
+ type: boolean
+ orientation:
+ $ref: '#/components/schemas/_common.mapping:GeoOrientation'
+ type:
+ type: string
+ enum:
+ - xy_shape
+ required:
+ - type
_common.query_dsl:BoolQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl:QueryBase'
@@ -36939,6 +38113,9 @@ components:
$ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod'
ignore_unmapped:
$ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped'
+ additionalProperties:
+ $ref: '#/components/schemas/_common:GeoBounds'
+ minProperties: 1
_common.query_dsl:GeoDecayFunction:
allOf:
- $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase'
@@ -36960,11 +38137,11 @@ components:
$ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod'
ignore_unmapped:
$ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped'
- field:
- type: object
+ additionalProperties:
+ $ref: '#/components/schemas/_common:GeoLocation'
+ minProperties: 2
required:
- distance
- - field
_common.query_dsl:GeoExecution:
type: string
enum:
@@ -36979,6 +38156,22 @@ components:
$ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod'
ignore_unmapped:
$ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped'
+ _common.query_dsl:GeoShape:
+ type: object
+ properties:
+ type:
+ type: string
+ coordinates:
+ type: array
+ _common.query_dsl:GeoShapeField:
+ type: object
+ properties:
+ shape:
+ $ref: '#/components/schemas/_common.query_dsl:GeoShape'
+ relation:
+ $ref: '#/components/schemas/_common:GeoShapeRelation'
+ required:
+ - shape
_common.query_dsl:GeoShapeQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl:QueryBase'
@@ -36986,6 +38179,9 @@ components:
properties:
ignore_unmapped:
$ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped'
+ additionalProperties:
+ $ref: '#/components/schemas/_common.query_dsl:GeoShapeField'
+ minProperties: 1
_common.query_dsl:GeoValidationMethod:
type: string
enum:
@@ -37255,9 +38451,7 @@ components:
version_type:
$ref: '#/components/schemas/_common:VersionType'
_common.query_dsl:MatchAllQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl:QueryBase'
- - type: object
+ $ref: '#/components/schemas/_common.query_dsl:QueryBase'
_common.query_dsl:MatchBoolPrefixQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl:QueryBase'
@@ -37854,8 +39048,6 @@ components:
$ref: '#/components/schemas/_common.query_dsl:ScriptQuery'
script_score:
$ref: '#/components/schemas/_common.query_dsl:ScriptScoreQuery'
- shape:
- $ref: '#/components/schemas/_common.query_dsl:ShapeQuery'
simple_query_string:
$ref: '#/components/schemas/_common.query_dsl:SimpleQueryStringQuery'
span_containing:
@@ -37893,7 +39085,15 @@ components:
minProperties: 1
maxProperties: 1
terms:
- $ref: '#/components/schemas/_common.query_dsl:TermsQuery'
+ type: object
+ additionalProperties:
+ anyOf:
+ - $ref: '#/components/schemas/_common.query_dsl:TermsQuery'
+ - type: array
+ items:
+ type: string
+ minProperties: 1
+ maxProperties: 1
terms_set:
description: |-
Returns documents that contain a minimum number of exact terms in a provided field.
@@ -37910,6 +39110,8 @@ components:
$ref: '#/components/schemas/_common.query_dsl:TextExpansionQuery'
minProperties: 1
maxProperties: 1
+ type:
+ $ref: '#/components/schemas/_common.query_dsl:TypeQuery'
weighted_tokens:
description: Supports returning text_expansion query results by sending in precomputed tokens with the query.
type: object
@@ -37926,8 +39128,8 @@ components:
maxProperties: 1
wrapper:
$ref: '#/components/schemas/_common.query_dsl:WrapperQuery'
- type:
- $ref: '#/components/schemas/_common.query_dsl:TypeQuery'
+ xy_shape:
+ $ref: '#/components/schemas/_common.query_dsl:XyShapeQuery'
minProperties: 1
maxProperties: 1
_common.query_dsl:QueryStringQuery:
@@ -38159,13 +39361,6 @@ components:
required:
- query
- script
- _common.query_dsl:ShapeQuery:
- allOf:
- - $ref: '#/components/schemas/_common.query_dsl:QueryBase'
- - type: object
- properties:
- ignore_unmapped:
- $ref: '#/components/schemas/_common.query_dsl:IgnoreUnmapped'
_common.query_dsl:SimpleQueryStringFlag:
type: string
enum:
@@ -38407,9 +39602,18 @@ components:
required:
- value
_common.query_dsl:TermsQuery:
- allOf:
+ anyOf:
- $ref: '#/components/schemas/_common.query_dsl:QueryBase'
- type: object
+ properties:
+ index:
+ $ref: '#/components/schemas/_common:IndexName'
+ id:
+ $ref: '#/components/schemas/_common:Id'
+ path:
+ $ref: '#/components/schemas/_common:Field'
+ routing:
+ $ref: '#/components/schemas/_common:Routing'
_common.query_dsl:TermsSetQuery:
allOf:
- $ref: '#/components/schemas/_common.query_dsl:QueryBase'
@@ -38420,7 +39624,6 @@ components:
minimum_should_match_script:
$ref: '#/components/schemas/_common:Script'
terms:
- description: Array of terms you wish to find in the provided field.
type: array
items:
type: string
@@ -38514,6 +39717,31 @@ components:
type: string
required:
- query
+ _common.query_dsl:XyShape:
+ type: object
+ properties:
+ type:
+ type: string
+ coordinates:
+ type: array
+ _common.query_dsl:XyShapeField:
+ type: object
+ properties:
+ shape:
+ $ref: '#/components/schemas/_common.query_dsl:XyShape'
+ relation:
+ $ref: '#/components/schemas/_common:GeoShapeRelation'
+ required:
+ - shape
+ _common.query_dsl:XyShapeQuery:
+ x-version-added: '2.4'
+ allOf:
+ - $ref: '#/components/schemas/_common.query_dsl:QueryBase'
+ - type: object
+ additionalProperties:
+ $ref: '#/components/schemas/_common.query_dsl:XyShapeField'
+ minProperties: 1
+ maxProperties: 1
_common.query_dsl:ZeroTermsQuery:
type: string
enum:
@@ -40733,11 +41961,11 @@ components:
files_fetched:
type: string
files_percent:
- type: string
+ $ref: '#/components/schemas/_common:PercentageString'
bytes_fetched:
type: string
bytes_percent:
- type: string
+ $ref: '#/components/schemas/_common:PercentageString'
start_time:
type: string
stop_time:
@@ -40790,44 +42018,44 @@ components:
description: |-
Disk space used by the node's shards. Does not include disk space for the translog or unassigned shards.
IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index.
- anyOf:
- - $ref: '#/components/schemas/_common:ByteSize'
- - type: 'null'
+ type:
+ - 'null'
+ - string
disk.used:
description: |-
Total disk space in use.
OpenSearch retrieves this metric from the node's operating system (OS).
The metric includes disk space for: OpenSearch, including the translog and unassigned shards; the node's operating system; any other applications or files on the node.
Unlike `disk.indices`, this metric does not double-count disk space for hard-linked files.
- anyOf:
- - $ref: '#/components/schemas/_common:ByteSize'
- - type: 'null'
+ type:
+ - 'null'
+ - string
disk.avail:
description: |-
Free disk space available to OpenSearch.
OpenSearch retrieves this metric from the node's operating system.
Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space.
- anyOf:
- - $ref: '#/components/schemas/_common:ByteSize'
- - type: 'null'
+ type:
+ - 'null'
+ - string
disk.total:
description: Total disk space for the node, including in-use and available space.
- anyOf:
- - $ref: '#/components/schemas/_common:ByteSize'
- - type: 'null'
+ type:
+ - 'null'
+ - string
disk.percent:
description: Total percentage of disk space in use. Calculated as `disk.used / disk.total`.
- anyOf:
- - $ref: '#/components/schemas/_common:Percentage'
+ oneOf:
+ - $ref: '#/components/schemas/_common:PercentageString'
- type: 'null'
host:
description: Network host for the node. Set using the `network.host` setting.
- anyOf:
+ oneOf:
- $ref: '#/components/schemas/_common:Host'
- type: 'null'
ip:
description: IP address and port for the node.
- anyOf:
+ oneOf:
- $ref: '#/components/schemas/_common:Ip'
- type: 'null'
node:
@@ -40921,7 +42149,7 @@ components:
type: string
active_shards_percent:
description: active number of shards in percent
- type: string
+ $ref: '#/components/schemas/_common:PercentageString'
discovered_cluster_manager:
description: cluster manager is discovered or not
type: string
@@ -40978,352 +42206,640 @@ components:
- string
completion.size:
description: size of completion
- type: string
+ type:
+ - 'null'
+ - string
pri.completion.size:
description: size of completion
- type: string
+ type:
+ - 'null'
+ - string
fielddata.memory_size:
description: used fielddata cache
- type: string
+ type:
+ - 'null'
+ - string
pri.fielddata.memory_size:
description: used fielddata cache
- type: string
+ type:
+ - 'null'
+ - string
fielddata.evictions:
description: fielddata evictions
- type: string
+ type:
+ - 'null'
+ - string
pri.fielddata.evictions:
description: fielddata evictions
- type: string
+ type:
+ - 'null'
+ - string
query_cache.memory_size:
description: used query cache
- type: string
+ type:
+ - 'null'
+ - string
pri.query_cache.memory_size:
description: used query cache
- type: string
+ type:
+ - 'null'
+ - string
query_cache.evictions:
description: query cache evictions
- type: string
+ type:
+ - 'null'
+ - string
pri.query_cache.evictions:
description: query cache evictions
- type: string
+ type:
+ - 'null'
+ - string
request_cache.memory_size:
description: used request cache
- type: string
+ type:
+ - 'null'
+ - string
pri.request_cache.memory_size:
description: used request cache
- type: string
+ type:
+ - 'null'
+ - string
request_cache.evictions:
description: request cache evictions
- type: string
+ type:
+ - 'null'
+ - string
pri.request_cache.evictions:
description: request cache evictions
- type: string
+ type:
+ - 'null'
+ - string
request_cache.hit_count:
description: request cache hit count
- type: string
+ type:
+ - 'null'
+ - string
pri.request_cache.hit_count:
description: request cache hit count
- type: string
+ type:
+ - 'null'
+ - string
request_cache.miss_count:
description: request cache miss count
- type: string
+ type:
+ - 'null'
+ - string
pri.request_cache.miss_count:
description: request cache miss count
- type: string
+ type:
+ - 'null'
+ - string
flush.total:
description: number of flushes
- type: string
+ type:
+ - 'null'
+ - string
pri.flush.total:
description: number of flushes
- type: string
+ type:
+ - 'null'
+ - string
flush.total_time:
description: time spent in flush
- type: string
+ type:
+ - 'null'
+ - string
pri.flush.total_time:
description: time spent in flush
- type: string
+ type:
+ - 'null'
+ - string
get.current:
description: number of current get ops
- type: string
+ type:
+ - 'null'
+ - string
pri.get.current:
description: number of current get ops
- type: string
+ type:
+ - 'null'
+ - string
get.time:
description: time spent in get
- type: string
+ type:
+ - 'null'
+ - string
pri.get.time:
description: time spent in get
- type: string
+ type:
+ - 'null'
+ - string
get.total:
description: number of get ops
- type: string
+ type:
+ - 'null'
+ - string
pri.get.total:
description: number of get ops
- type: string
+ type:
+ - 'null'
+ - string
get.exists_time:
description: time spent in successful gets
- type: string
+ type:
+ - 'null'
+ - string
pri.get.exists_time:
description: time spent in successful gets
- type: string
+ type:
+ - 'null'
+ - string
get.exists_total:
description: number of successful gets
- type: string
+ type:
+ - 'null'
+ - string
pri.get.exists_total:
description: number of successful gets
- type: string
+ type:
+ - 'null'
+ - string
get.missing_time:
description: time spent in failed gets
- type: string
+ type:
+ - 'null'
+ - string
pri.get.missing_time:
description: time spent in failed gets
- type: string
+ type:
+ - 'null'
+ - string
get.missing_total:
description: number of failed gets
- type: string
+ type:
+ - 'null'
+ - string
pri.get.missing_total:
description: number of failed gets
- type: string
+ type:
+ - 'null'
+ - string
indexing.delete_current:
description: number of current deletions
- type: string
+ type:
+ - 'null'
+ - string
pri.indexing.delete_current:
description: number of current deletions
- type: string
+ type:
+ - 'null'
+ - string
indexing.delete_time:
description: time spent in deletions
- type: string
+ type:
+ - 'null'
+ - string
pri.indexing.delete_time:
description: time spent in deletions
- type: string
+ type:
+ - 'null'
+ - string
indexing.delete_total:
description: number of delete ops
- type: string
+ type:
+ - 'null'
+ - string
pri.indexing.delete_total:
description: number of delete ops
- type: string
+ type:
+ - 'null'
+ - string
indexing.index_current:
description: number of current indexing ops
- type: string
+ type:
+ - 'null'
+ - string
pri.indexing.index_current:
description: number of current indexing ops
- type: string
+ type:
+ - 'null'
+ - string
indexing.index_time:
description: time spent in indexing
- type: string
+ type:
+ - 'null'
+ - string
pri.indexing.index_time:
description: time spent in indexing
- type: string
+ type:
+ - 'null'
+ - string
indexing.index_total:
description: number of indexing ops
- type: string
+ type:
+ - 'null'
+ - string
pri.indexing.index_total:
description: number of indexing ops
- type: string
+ type:
+ - 'null'
+ - string
indexing.index_failed:
description: number of failed indexing ops
- type: string
+ type:
+ - 'null'
+ - string
pri.indexing.index_failed:
description: number of failed indexing ops
- type: string
+ type:
+ - 'null'
+ - string
merges.current:
description: number of current merges
- type: string
+ type:
+ - 'null'
+ - string
pri.merges.current:
description: number of current merges
- type: string
+ type:
+ - 'null'
+ - string
merges.current_docs:
description: number of current merging docs
- type: string
+ type:
+ - 'null'
+ - string
pri.merges.current_docs:
description: number of current merging docs
- type: string
+ type:
+ - 'null'
+ - string
merges.current_size:
description: size of current merges
- type: string
+ type:
+ - 'null'
+ - string
pri.merges.current_size:
description: size of current merges
- type: string
+ type:
+ - 'null'
+ - string
merges.total:
description: number of completed merge ops
- type: string
+ type:
+ - 'null'
+ - string
pri.merges.total:
description: number of completed merge ops
- type: string
+ type:
+ - 'null'
+ - string
merges.total_docs:
description: docs merged
- type: string
+ type:
+ - 'null'
+ - string
pri.merges.total_docs:
description: docs merged
- type: string
+ type:
+ - 'null'
+ - string
merges.total_size:
description: size merged
- type: string
+ type:
+ - 'null'
+ - string
pri.merges.total_size:
description: size merged
- type: string
+ type:
+ - 'null'
+ - string
merges.total_time:
description: time spent in merges
- type: string
+ type:
+ - 'null'
+ - string
pri.merges.total_time:
description: time spent in merges
- type: string
+ type:
+ - 'null'
+ - string
refresh.total:
description: total refreshes
- type: string
+ type:
+ - 'null'
+ - string
pri.refresh.total:
description: total refreshes
- type: string
+ type:
+ - 'null'
+ - string
refresh.time:
description: time spent in refreshes
- type: string
+ type:
+ - 'null'
+ - string
pri.refresh.time:
description: time spent in refreshes
- type: string
+ type:
+ - 'null'
+ - string
refresh.external_total:
description: total external refreshes
- type: string
+ type:
+ - 'null'
+ - string
pri.refresh.external_total:
description: total external refreshes
- type: string
+ type:
+ - 'null'
+ - string
refresh.external_time:
description: time spent in external refreshes
- type: string
+ type:
+ - 'null'
+ - string
pri.refresh.external_time:
description: time spent in external refreshes
- type: string
+ type:
+ - 'null'
+ - string
refresh.listeners:
description: number of pending refresh listeners
- type: string
+ type:
+ - 'null'
+ - string
pri.refresh.listeners:
description: number of pending refresh listeners
- type: string
+ type:
+ - 'null'
+ - string
search.fetch_current:
description: current fetch phase ops
- type: string
+ type:
+ - 'null'
+ - string
pri.search.fetch_current:
description: current fetch phase ops
- type: string
+ type:
+ - 'null'
+ - string
search.fetch_time:
description: time spent in fetch phase
- type: string
+ type:
+ - 'null'
+ - string
pri.search.fetch_time:
description: time spent in fetch phase
- type: string
+ type:
+ - 'null'
+ - string
search.fetch_total:
description: total fetch ops
- type: string
+ type:
+ - 'null'
+ - string
pri.search.fetch_total:
description: total fetch ops
- type: string
+ type:
+ - 'null'
+ - string
search.open_contexts:
description: open search contexts
- type: string
+ type:
+ - 'null'
+ - string
pri.search.open_contexts:
description: open search contexts
- type: string
+ type:
+ - 'null'
+ - string
search.query_current:
description: current query phase ops
- type: string
+ type:
+ - 'null'
+ - string
pri.search.query_current:
description: current query phase ops
- type: string
+ type:
+ - 'null'
+ - string
search.query_time:
description: time spent in query phase
- type: string
+ type:
+ - 'null'
+ - string
pri.search.query_time:
description: time spent in query phase
- type: string
+ type:
+ - 'null'
+ - string
search.query_total:
description: total query phase ops
- type: string
+ type:
+ - 'null'
+ - string
pri.search.query_total:
description: total query phase ops
- type: string
+ type:
+ - 'null'
+ - string
+ search.concurrent_query_current:
+ type:
+ - 'null'
+ - string
+ pri.search.concurrent_query_current:
+ type:
+ - 'null'
+ - string
+ search.concurrent_query_time:
+ type:
+ - 'null'
+ - string
+ pri.search.concurrent_query_time:
+ type:
+ - 'null'
+ - string
+ search.concurrent_query_total:
+ type:
+ - 'null'
+ - string
+ pri.search.concurrent_query_total:
+ type:
+ - 'null'
+ - string
+ search.concurrent_avg_slice_count:
+ type:
+ - 'null'
+ - string
+ pri.search.concurrent_avg_slice_count:
+ type:
+ - 'null'
+ - string
search.scroll_current:
description: open scroll contexts
- type: string
+ type:
+ - 'null'
+ - string
pri.search.scroll_current:
description: open scroll contexts
- type: string
+ type:
+ - 'null'
+ - string
search.scroll_time:
description: time scroll contexts held open
- type: string
+ type:
+ - 'null'
+ - string
pri.search.scroll_time:
description: time scroll contexts held open
- type: string
+ type:
+ - 'null'
+ - string
search.scroll_total:
description: completed scroll contexts
- type: string
+ type:
+ - 'null'
+ - string
pri.search.scroll_total:
description: completed scroll contexts
- type: string
+ type:
+ - 'null'
+ - string
+ search.point_in_time_current:
+ type:
+ - 'null'
+ - string
+ pri.search.point_in_time_current:
+ type:
+ - 'null'
+ - string
+ search.point_in_time_time:
+ type:
+ - 'null'
+ - string
+ pri.search.point_in_time_time:
+ type:
+ - 'null'
+ - string
+ search.point_in_time_total:
+ type:
+ - 'null'
+ - string
+ pri.search.point_in_time_total:
+ type:
+ - 'null'
+ - string
segments.count:
description: number of segments
- type: string
+ type:
+ - 'null'
+ - string
pri.segments.count:
description: number of segments
- type: string
+ type:
+ - 'null'
+ - string
segments.memory:
description: memory used by segments
- type: string
+ type:
+ - 'null'
+ - string
pri.segments.memory:
description: memory used by segments
- type: string
+ type:
+ - 'null'
+ - string
segments.index_writer_memory:
description: memory used by index writer
- type: string
+ type:
+ - 'null'
+ - string
pri.segments.index_writer_memory:
description: memory used by index writer
- type: string
+ type:
+ - 'null'
+ - string
segments.version_map_memory:
description: memory used by version map
- type: string
+ type:
+ - 'null'
+ - string
pri.segments.version_map_memory:
description: memory used by version map
- type: string
+ type:
+ - 'null'
+ - string
segments.fixed_bitset_memory:
description: memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields
- type: string
+ type:
+ - 'null'
+ - string
pri.segments.fixed_bitset_memory:
description: memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields
- type: string
+ type:
+ - 'null'
+ - string
warmer.current:
description: current warmer ops
- type: string
+ type:
+ - 'null'
+ - string
pri.warmer.current:
description: current warmer ops
- type: string
+ type:
+ - 'null'
+ - string
warmer.total:
description: total warmer ops
- type: string
+ type:
+ - 'null'
+ - string
pri.warmer.total:
description: total warmer ops
- type: string
+ type:
+ - 'null'
+ - string
warmer.total_time:
description: time spent in warmers
- type: string
+ type:
+ - 'null'
+ - string
pri.warmer.total_time:
description: time spent in warmers
- type: string
+ type:
+ - 'null'
+ - string
suggest.current:
description: number of current suggest ops
- type: string
+ type:
+ - 'null'
+ - string
pri.suggest.current:
description: number of current suggest ops
- type: string
+ type:
+ - 'null'
+ - string
suggest.time:
description: time spend in suggest
- type: string
+ type:
+ - 'null'
+ - string
pri.suggest.time:
description: time spend in suggest
- type: string
+ type:
+ - 'null'
+ - string
suggest.total:
description: number of suggest ops
- type: string
+ type:
+ - 'null'
+ - string
pri.suggest.total:
description: number of suggest ops
- type: string
+ type:
+ - 'null'
+ - string
memory.total:
description: total used memory
type: string
@@ -41333,36 +42849,6 @@ components:
search.throttled:
description: indicates if the index is search throttled
type: string
- bulk.total_operations:
- description: number of bulk shard ops
- type: string
- pri.bulk.total_operations:
- description: number of bulk shard ops
- type: string
- bulk.total_time:
- description: time spend in shard bulk
- type: string
- pri.bulk.total_time:
- description: time spend in shard bulk
- type: string
- bulk.total_size_in_bytes:
- description: total size in bytes of shard bulk
- type: string
- pri.bulk.total_size_in_bytes:
- description: total size in bytes of shard bulk
- type: string
- bulk.avg_time:
- description: average time spend in shard bulk
- type: string
- pri.bulk.avg_time:
- description: average time spend in shard bulk
- type: string
- bulk.avg_size_in_bytes:
- description: average size in bytes of shard bulk
- type: string
- pri.bulk.avg_size_in_bytes:
- description: average size in bytes of shard bulk
- type: string
cat.master:MasterRecord:
type: object
properties:
@@ -41437,18 +42923,18 @@ components:
description: The Java version.
type: string
disk.total:
- $ref: '#/components/schemas/_common:ByteSize'
+ type: string
disk.used:
- $ref: '#/components/schemas/_common:ByteSize'
+ type: string
disk.avail:
- $ref: '#/components/schemas/_common:ByteSize'
+ type: string
disk.used_percent:
- $ref: '#/components/schemas/_common:Percentage'
+ $ref: '#/components/schemas/_common:PercentageString'
heap.current:
description: The used heap.
type: string
heap.percent:
- $ref: '#/components/schemas/_common:Percentage'
+ $ref: '#/components/schemas/_common:PercentageString'
heap.max:
description: The maximum configured heap.
type: string
@@ -41456,7 +42942,7 @@ components:
description: The used machine memory.
type: string
ram.percent:
- $ref: '#/components/schemas/_common:Percentage'
+ $ref: '#/components/schemas/_common:PercentageString'
ram.max:
description: The total machine memory.
type: string
@@ -41464,7 +42950,7 @@ components:
description: The used file descriptors.
type: string
file_desc.percent:
- $ref: '#/components/schemas/_common:Percentage'
+ $ref: '#/components/schemas/_common:PercentageString'
file_desc.max:
description: The maximum number of file descriptors.
type: string
@@ -41654,6 +43140,14 @@ components:
search.query_total:
description: The total query phase operations.
type: string
+ search.concurrent_query_current:
+ type: string
+ search.concurrent_query_time:
+ type: string
+ search.concurrent_query_total:
+ type: string
+ search.concurrent_avg_slice_count:
+ type: string
search.scroll_current:
description: The open scroll contexts.
type: string
@@ -41663,6 +43157,12 @@ components:
search.scroll_total:
description: The completed scroll contexts.
type: string
+ search.point_in_time_current:
+ type: string
+ search.point_in_time_time:
+ type: string
+ search.point_in_time_total:
+ type: string
segments.count:
description: The number of segments.
type: string
@@ -41746,11 +43246,11 @@ components:
start_time:
$ref: '#/components/schemas/_common:DateTime'
start_time_millis:
- $ref: '#/components/schemas/_common:EpochTimeUnitMillis'
+ $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitMillis'
stop_time:
$ref: '#/components/schemas/_common:DateTime'
stop_time_millis:
- $ref: '#/components/schemas/_common:EpochTimeUnitMillis'
+ $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitMillis'
time:
$ref: '#/components/schemas/_common:Duration'
type:
@@ -41784,7 +43284,7 @@ components:
description: The files recovered.
type: string
files_percent:
- $ref: '#/components/schemas/_common:Percentage'
+ $ref: '#/components/schemas/_common:PercentageString'
files_total:
description: The total number of files.
type: string
@@ -41795,7 +43295,7 @@ components:
description: The bytes recovered.
type: string
bytes_percent:
- $ref: '#/components/schemas/_common:Percentage'
+ $ref: '#/components/schemas/_common:PercentageString'
bytes_total:
description: The total number of bytes.
type: string
@@ -41806,7 +43306,7 @@ components:
description: The translog operations recovered.
type: string
translog_ops_percent:
- $ref: '#/components/schemas/_common:Percentage'
+ $ref: '#/components/schemas/_common:PercentageString'
cat.repositories:RepositoriesRecord:
type: object
properties:
@@ -41854,9 +43354,9 @@ components:
Also, OpenSearch creates extra deleted documents to internally track the recent history of operations on a shard.
type: string
size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
size.memory:
- $ref: '#/components/schemas/_common:ByteSize'
+ type: string
committed:
description: |-
If `true`, the segment is synced to disk.
@@ -41913,7 +43413,9 @@ components:
- string
id:
description: The unique identifier for the node.
- type: string
+ type:
+ - 'null'
+ - string
node:
description: The name of node.
type:
@@ -41921,7 +43423,9 @@ components:
- string
sync_id:
description: The sync identifier.
- type: string
+ type:
+ - 'null'
+ - string
unassigned.reason:
description: |-
The reason for the last change to the state of an unassigned shard.
@@ -41944,204 +43448,372 @@ components:
`REINITIALIZED`: When a shard moves from started back to initializing.
`REPLICA_ADDED`: Unassigned as a result of explicit addition of a replica.
`REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute command.
- type: string
+ type:
+ - 'null'
+ - string
unassigned.at:
description: The time at which the shard became unassigned in Coordinated Universal Time (UTC).
- type: string
+ type:
+ - 'null'
+ - string
unassigned.for:
description: The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC).
- type: string
+ type:
+ - 'null'
+ - string
unassigned.details:
description: |-
Additional details as to why the shard became unassigned.
It does not explain why the shard is not assigned; use the cluster allocation explain API for that information.
- type: string
+ type:
+ - 'null'
+ - string
recoverysource.type:
description: The type of recovery source.
- type: string
+ type:
+ - 'null'
+ - string
completion.size:
description: The size of completion.
- type: string
+ type:
+ - 'null'
+ - string
fielddata.memory_size:
description: The used fielddata cache memory.
- type: string
+ type:
+ - 'null'
+ - string
fielddata.evictions:
description: The fielddata cache evictions.
- type: string
+ type:
+ - 'null'
+ - string
query_cache.memory_size:
description: The used query cache memory.
- type: string
+ type:
+ - 'null'
+ - string
query_cache.evictions:
description: The query cache evictions.
- type: string
+ type:
+ - 'null'
+ - string
flush.total:
description: The number of flushes.
- type: string
+ type:
+ - 'null'
+ - string
flush.total_time:
description: The time spent in flush.
- type: string
+ type:
+ - 'null'
+ - string
get.current:
description: The number of current get operations.
- type: string
+ type:
+ - 'null'
+ - string
get.time:
description: The time spent in get operations.
- type: string
+ type:
+ - 'null'
+ - string
get.total:
description: The number of get operations.
- type: string
+ type:
+ - 'null'
+ - string
get.exists_time:
description: The time spent in successful get operations.
- type: string
+ type:
+ - 'null'
+ - string
get.exists_total:
description: The number of successful get operations.
- type: string
+ type:
+ - 'null'
+ - string
get.missing_time:
description: The time spent in failed get operations.
- type: string
+ type:
+ - 'null'
+ - string
get.missing_total:
description: The number of failed get operations.
- type: string
+ type:
+ - 'null'
+ - string
indexing.delete_current:
description: The number of current deletion operations.
- type: string
+ type:
+ - 'null'
+ - string
indexing.delete_time:
description: The time spent in deletion operations.
- type: string
+ type:
+ - 'null'
+ - string
indexing.delete_total:
description: The number of delete operations.
- type: string
+ type:
+ - 'null'
+ - string
indexing.index_current:
description: The number of current indexing operations.
- type: string
+ type:
+ - 'null'
+ - string
indexing.index_time:
description: The time spent in indexing operations.
- type: string
+ type:
+ - 'null'
+ - string
indexing.index_total:
description: The number of indexing operations.
- type: string
+ type:
+ - 'null'
+ - string
indexing.index_failed:
description: The number of failed indexing operations.
- type: string
+ type:
+ - 'null'
+ - string
merges.current:
description: The number of current merge operations.
- type: string
+ type:
+ - 'null'
+ - string
merges.current_docs:
description: The number of current merging documents.
- type: string
+ type:
+ - 'null'
+ - string
merges.current_size:
description: The size of current merge operations.
- type: string
+ type:
+ - 'null'
+ - string
merges.total:
description: The number of completed merge operations.
- type: string
+ type:
+ - 'null'
+ - string
merges.total_docs:
description: The number of merged documents.
- type: string
+ type:
+ - 'null'
+ - string
merges.total_size:
description: The size of current merges.
- type: string
+ type:
+ - 'null'
+ - string
merges.total_time:
description: The time spent merging documents.
- type: string
+ type:
+ - 'null'
+ - string
refresh.total:
description: The total number of refreshes.
- type: string
+ type:
+ - 'null'
+ - string
refresh.time:
description: The time spent in refreshes.
- type: string
+ type:
+ - 'null'
+ - string
refresh.external_total:
description: The total number of external refreshes.
- type: string
+ type:
+ - 'null'
+ - string
refresh.external_time:
description: The time spent in external refreshes.
- type: string
+ type:
+ - 'null'
+ - string
refresh.listeners:
description: The number of pending refresh listeners.
- type: string
+ type:
+ - 'null'
+ - string
search.fetch_current:
description: The current fetch phase operations.
- type: string
+ type:
+ - 'null'
+ - string
search.fetch_time:
description: The time spent in fetch phase.
- type: string
+ type:
+ - 'null'
+ - string
search.fetch_total:
description: The total number of fetch operations.
- type: string
+ type:
+ - 'null'
+ - string
search.open_contexts:
description: The number of open search contexts.
- type: string
+ type:
+ - 'null'
+ - string
search.query_current:
description: The current query phase operations.
- type: string
+ type:
+ - 'null'
+ - string
search.query_time:
description: The time spent in query phase.
- type: string
+ type:
+ - 'null'
+ - string
search.query_total:
description: The total number of query phase operations.
- type: string
+ type:
+ - 'null'
+ - string
+ search.concurrent_query_current:
+ type:
+ - 'null'
+ - string
+ search.concurrent_query_time:
+ type:
+ - 'null'
+ - string
+ search.concurrent_query_total:
+ type:
+ - 'null'
+ - string
+ search.concurrent_avg_slice_count:
+ type:
+ - 'null'
+ - string
search.scroll_current:
description: The open scroll contexts.
- type: string
+ type:
+ - 'null'
+ - string
search.scroll_time:
description: The time scroll contexts were held open.
- type: string
+ type:
+ - 'null'
+ - string
search.scroll_total:
description: The number of completed scroll contexts.
- type: string
+ type:
+ - 'null'
+ - string
+ search.point_in_time_current:
+ type:
+ - 'null'
+ - string
+ search.point_in_time_time:
+ type:
+ - 'null'
+ - string
+ search.point_in_time_total:
+ type:
+ - 'null'
+ - string
+ search.search_idle_reactivate_count_total:
+ type:
+ - 'null'
+ - string
segments.count:
description: The number of segments.
- type: string
+ type:
+ - 'null'
+ - string
segments.memory:
description: The memory used by segments.
- type: string
+ type:
+ - 'null'
+ - string
segments.index_writer_memory:
description: The memory used by the index writer.
- type: string
+ type:
+ - 'null'
+ - string
segments.version_map_memory:
description: The memory used by the version map.
- type: string
+ type:
+ - 'null'
+ - string
segments.fixed_bitset_memory:
description: The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields.
- type: string
+ type:
+ - 'null'
+ - string
seq_no.max:
description: The maximum sequence number.
- type: string
+ type:
+ - 'null'
+ - string
seq_no.local_checkpoint:
description: The local checkpoint.
- type: string
+ type:
+ - 'null'
+ - string
seq_no.global_checkpoint:
description: The global checkpoint.
- type: string
+ type:
+ - 'null'
+ - string
warmer.current:
description: The number of current warmer operations.
- type: string
+ type:
+ - 'null'
+ - string
warmer.total:
description: The total number of warmer operations.
- type: string
+ type:
+ - 'null'
+ - string
warmer.total_time:
description: The time spent in warmer operations.
- type: string
+ type:
+ - 'null'
+ - string
path.data:
description: The shard data path.
- type: string
+ type:
+ - 'null'
+ - string
path.state:
description: The shard state path.
- type: string
+ type:
+ - 'null'
+ - string
bulk.total_operations:
description: The number of bulk shard operations.
- type: string
+ type:
+ - 'null'
+ - string
bulk.total_time:
description: The time spent in shard bulk operations.
- type: string
+ type:
+ - 'null'
+ - string
bulk.total_size_in_bytes:
description: The total size in bytes of shard bulk operations.
- type: string
+ type:
+ - 'null'
+ - string
bulk.avg_time:
description: The average time spent in shard bulk operations.
- type: string
+ type:
+ - 'null'
+ - string
bulk.avg_size_in_bytes:
description: The average size in bytes of shard bulk operations.
- type: string
+ type:
+ - 'null'
+ - string
+ docs.deleted:
+ type:
+ - 'null'
+ - string
cat.snapshots:SnapshotsRecord:
type: object
properties:
@@ -42304,6 +43976,8 @@ components:
completed:
description: The number of completed tasks.
type: string
+ total_wait_time:
+ type: string
core:
description: The core number of active threads allowed in a scaling thread pool.
type:
@@ -42394,7 +44068,7 @@ components:
in_sync:
type: boolean
matching_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
matching_sync_id:
type: boolean
store_exception:
@@ -42416,7 +44090,9 @@ components:
shard_sizes:
type: object
additionalProperties:
- type: number
+ oneOf:
+ - $ref: '#/components/schemas/_common:ByteCount'
+ - $ref: '#/components/schemas/_common:HumanReadableByteCount'
shard_data_set_sizes:
type: object
additionalProperties:
@@ -42471,16 +44147,22 @@ components:
properties:
path:
type: string
+ total:
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ used:
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
used_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ free:
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
free_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
free_disk_percent:
- type: number
+ $ref: '#/components/schemas/_common:PercentageNumber'
used_disk_percent:
- type: number
+ $ref: '#/components/schemas/_common:PercentageNumber'
required:
- free_bytes
- free_disk_percent
@@ -42588,6 +44270,19 @@ components:
- REINITIALIZED
- REPLICA_ADDED
- REROUTE_CANCELLED
+ cluster.decommission_awareness:DecommissionStatusResponse:
+ oneOf:
+ - $ref: '#/components/schemas/cluster.decommission_awareness:ZoneDecommissionStatusResponse'
+ cluster.decommission_awareness:ZoneDecommissionStatusResponse:
+ type: object
+ additionalProperties:
+ type: string
+ enum:
+ - DRAINING
+ - FAILED
+ - INIT
+ - IN_PROGRESS
+ - SUCCESSFUL
cluster.health:AwarenessAttributeStats:
type: object
x-version-added: '2.5'
@@ -42613,8 +44308,10 @@ components:
active_shards:
description: The total number of active primary and replica shards.
type: number
+ active_shards_percent:
+ $ref: '#/components/schemas/_common:PercentageString'
active_shards_percent_as_number:
- $ref: '#/components/schemas/_common:Percentage'
+ $ref: '#/components/schemas/_common:PercentageNumber'
awareness_attributes:
description: Cluster health information for each awareness attribute.
type: object
@@ -43029,21 +44726,37 @@ components:
cluster.stats:ClusterFileSystem:
type: object
properties:
+ available:
+ description: |-
+ Total number of bytes available to JVM in file stores across all selected nodes.
+ Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.
+ This is the actual amount of free disk space the selected OpenSearch nodes can use.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
available_in_bytes:
description: |-
Total number of bytes available to JVM in file stores across all selected nodes.
Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.
This is the actual amount of free disk space the selected OpenSearch nodes can use.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ free:
+ description: Total number of unallocated bytes in file stores across all selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
free_in_bytes:
description: Total number of unallocated bytes in file stores across all selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ total:
+ description: Total size, of all file stores across all selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_in_bytes:
description: Total size, in bytes, of all file stores across all selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ cache_reserved:
+ description: Total size, of all cache reserved across all selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
+ x-version-added: '2.7'
cache_reserved_in_bytes:
description: Total size, in bytes, of all cache reserved across all selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
x-version-added: '2.7'
required:
- available_in_bytes
@@ -43131,6 +44844,8 @@ components:
cluster.stats:ClusterJvm:
type: object
properties:
+ max_uptime:
+ $ref: '#/components/schemas/_common:Duration'
max_uptime_in_millis:
$ref: '#/components/schemas/_common:DurationValueUnitMillis'
mem:
@@ -43151,12 +44866,18 @@ components:
cluster.stats:ClusterJvmMemory:
type: object
properties:
+ heap_max:
+ description: Maximum amount of memory available for use by the heap across all selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
heap_max_in_bytes:
description: Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ heap_used:
+ description: Memory currently in use by the heap across all selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
heap_used_in_bytes:
description: Memory, in bytes, currently in use by the heap across all selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- heap_max_in_bytes
- heap_used_in_bytes
@@ -43389,7 +45110,7 @@ components:
description: |-
Percentage of CPU used across all selected nodes.
Returns `-1` if not supported.
- type: number
+ $ref: '#/components/schemas/_common:PercentageNumber'
required:
- percent
cluster.stats:ClusterProcessOpenFileDescriptors:
@@ -43495,10 +45216,10 @@ components:
description: Total number of fields in all non-system indices, accounting for mapping deduplication.
type: number
total_deduplicated_mapping_size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_deduplicated_mapping_size_in_bytes:
description: Total size of all mappings, in bytes, after deduplication and compression.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- field_types
cluster.stats:IndexingPressure:
@@ -43514,7 +45235,7 @@ components:
current:
$ref: '#/components/schemas/cluster.stats:IndexingPressureMemorySummary'
limit_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
total:
$ref: '#/components/schemas/cluster.stats:IndexingPressureMemorySummary'
required:
@@ -43525,19 +45246,19 @@ components:
type: object
properties:
all_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
combined_coordinating_and_primary_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
coordinating_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
coordinating_rejections:
type: number
primary_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
primary_rejections:
type: number
replica_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
replica_rejections:
type: number
required:
@@ -43554,7 +45275,7 @@ components:
primary_shard_count:
type: number
total_primary_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
version:
$ref: '#/components/schemas/_common:VersionString'
required:
@@ -43582,22 +45303,31 @@ components:
properties:
adjusted_total_in_bytes:
description: Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ free:
+ description: Amount, in bytes, of free physical memory across all selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
free_in_bytes:
description: Amount, in bytes, of free physical memory across all selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
free_percent:
description: Percentage of free physical memory across all selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:PercentageNumber'
+ total:
+ description: Total amount of physical memory across all selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_in_bytes:
description: Total amount, in bytes, of physical memory across all selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ used:
+ description: Amount of physical memory in use across all selected nodes.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
used_in_bytes:
description: Amount, in bytes, of physical memory in use across all selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
used_percent:
description: Percentage of physical memory in use across all selected nodes.
- type: number
+ $ref: '#/components/schemas/_common:PercentageNumber'
required:
- free_in_bytes
- free_percent
@@ -43690,6 +45420,25 @@ components:
- nodes
- status
- timestamp
+ cluster.weighted_routing:Weights:
+ allOf:
+ - $ref: '#/components/schemas/cluster.weighted_routing:WeightsBase'
+ - type: object
+ properties:
+ weights:
+ type: object
+ cluster.weighted_routing:WeightsBase:
+ type: object
+ properties:
+ _version:
+ $ref: '#/components/schemas/_common:VersionNumber'
+ cluster.weighted_routing:WeightsResponse:
+ allOf:
+ - $ref: '#/components/schemas/cluster.weighted_routing:Weights'
+ - type: object
+ properties:
+ discovered_cluster_manager:
+ type: boolean
dangling_indices.list_dangling_indices:DanglingIndex:
type: object
properties:
@@ -43708,6 +45457,539 @@ components:
- index_name
- index_uuid
- node_ids
+ flow_framework.common:All:
+ description: The all parameter specifies whether the response should return all fields.
+ type: boolean
+ default: false
+ flow_framework.common:AllowDelete:
+ description: Required when deleting resources involves a high potential for data loss.
+ type: string
+ flow_framework.common:FlowFrameworkCreate:
+ type: object
+ properties:
+ name:
+ type: string
+ description: The name of the workflow.
+ description:
+ type: string
+ description: A description of the workflow.
+ use_case:
+ type: string
+ description: A use case, which can be used with the Search Workflow API to find related workflows.
+ version:
+ $ref: '#/components/schemas/flow_framework.common:version'
+ workflows:
+ type: object
+ description: A map of workflows. Presently, only the provision key is supported. The value for the workflow key is a key-value map that includes fields for user_params and lists of nodes and edges.
+ required:
+ - name
+ flow_framework.common:FlowFrameworkDeleteResponse:
+ type: object
+ properties:
+ _index:
+ type: string
+ description: The name of the index where the document was stored.
+ _id:
+ type: string
+ description: The unique identifier of the deleted document.
+ _version:
+ type: integer
+ description: The version of the document after the deletion.
+ result:
+ type: string
+ description: The result of the deletion operation.
+ enum:
+ - deleted
+ - not_found
+ _shards:
+ $ref: '#/components/schemas/flow_framework.common:shards'
+ _seq_no:
+ type: integer
+ description: The sequence number assigned to the document after the deletion.
+ _primary_term:
+ type: integer
+ description: The primary term assigned to the document after the deletion.
+ flow_framework.common:FlowFrameworkGetResponse:
+ type: object
+ properties:
+ name:
+ type: string
+ description:
+ type: string
+ use_case:
+ type: string
+ workflows:
+ type: object
+ user:
+ $ref: '#/components/schemas/flow_framework.common:user'
+ created_time:
+ type: integer
+ last_updated_time:
+ type: integer
+ flow_framework.common:FlowFrameworkUpdate:
+ type: object
+ properties:
+ name:
+ type: string
+ description: The name of the workflow.
+ description:
+ type: string
+ description: A description of the workflow.
+ use_case:
+ type: string
+ description: A use case, which can be used with the Search Workflow API to find related workflows.
+ version:
+ $ref: '#/components/schemas/flow_framework.common:version'
+ minProperties: 1
+ flow_framework.common:hits:
+ type: object
+ properties:
+ total:
+ $ref: '#/components/schemas/flow_framework.common:total'
+ max_score:
+ type: number
+ format: float
+ description: The maximum score of the search hits.
+ hits:
+ type: array
+ items:
+ $ref: '#/components/schemas/flow_framework.common:itemsObject'
+ flow_framework.common:itemsObject:
+ type: object
+ properties:
+ _index:
+ type: string
+ description: The index name where the document resides.
+ _id:
+ type: string
+ description: The document ID.
+ _version:
+ type: integer
+ description: The version of the document.
+ _seq_no:
+ type: integer
+ description: The sequence number of the document.
+ _primary_term:
+ type: integer
+ description: The primary term of the document.
+ _score:
+ type: number
+ format: float
+ description: The score of the search hit.
+ _source:
+ $ref: '#/components/schemas/flow_framework.common:FlowFrameworkGetResponse'
+ flow_framework.common:Provision:
+ description: Provision the workflow as part of the request.
+ type: boolean
+ default: false
+ flow_framework.common:query:
+ type: object
+ description: The search query to match workflows. Use `match_all` to retrieve all workflows, or `match` to search by specific fields like `use_case`.
+ properties:
+ match:
+ type: object
+ match_all:
+ type: object
+ flow_framework.common:Reprovision:
+ type: boolean
+ default: false
+ flow_framework.common:SearchStateResponse:
+ type: object
+ properties:
+ workflow_id:
+ type: string
+ provisioning_progress:
+ type: string
+ state:
+ type: string
+ user:
+ $ref: '#/components/schemas/flow_framework.common:user'
+ flow_framework.common:SearchWorkflowRequest:
+ type: object
+ properties:
+ query:
+ $ref: '#/components/schemas/flow_framework.common:query'
+ flow_framework.common:shards:
+ type: object
+ properties:
+ total:
+ type: integer
+ description: The total number of shards involved in the deletion.
+ successful:
+ type: integer
+ description: The number of shards where the deletion was successful.
+ failed:
+ type: integer
+ description: The number of shards where the deletion failed.
+ flow_framework.common:StateHits:
+ type: object
+ properties:
+ total:
+ $ref: '#/components/schemas/flow_framework.common:total'
+ max_score:
+ type: number
+ format: float
+ description: The maximum score of the search hits.
+ hits:
+ type: array
+ items:
+ $ref: '#/components/schemas/flow_framework.common:StateItems'
+ flow_framework.common:StateItems:
+ type: object
+ properties:
+ _index:
+ type: string
+ description: The index name where the document resides.
+ _id:
+ type: string
+ description: The document ID.
+ _version:
+ type: integer
+ description: The version of the document.
+ _seq_no:
+ type: integer
+ description: The sequence number of the document.
+ _primary_term:
+ type: integer
+ description: The primary term of the document.
+ _score:
+ type: number
+ format: float
+ description: The score of the search hit.
+ _source:
+ $ref: '#/components/schemas/flow_framework.common:SearchStateResponse'
+ flow_framework.common:total:
+ type: object
+ properties:
+ value:
+ type: integer
+ description: Total number of matching documents.
+ relation:
+ type: string
+ description: The relation of the total hits.
+ flow_framework.common:UpdateFields:
+ description: Update only the fields included in the request body.
+ type: boolean
+ default: false
+ flow_framework.common:UseCase:
+ type: string
+ flow_framework.common:user:
+ type: object
+ properties:
+ name:
+ type: string
+ backend_roles:
+ type: array
+ items:
+ type: string
+ roles:
+ type: array
+ items:
+ type: string
+ custom_attribute_names:
+ type: array
+ items:
+ type: string
+ user_requested_tenant:
+ type: string
+ nullable: true
+ flow_framework.common:UserProvidedSubstitutionExpressions:
+ type: object
+ additionalProperties:
+ type: string
+ description: The value for the user-provided key. Keys represent substitution expressions.
+ flow_framework.common:Validation:
+ description: Validate the workflow. Valid values are all (validate the template) and none (do not validate the template). Default is all.
+ type: string
+ default: all
+ flow_framework.common:version:
+ type: object
+ description: A key-value map with two fields, template, which identifies the template version, and compatibility, which identifies a list of minimum required OpenSearch versions.
+ properties:
+ template:
+ type: string
+ description: The template version of the workflow.
+ compatibility:
+ type: array
+ items:
+ type: string
+ description: A list of minimum required OpenSearch versions.
+ flow_framework.common:WorkflowID:
+ type: string
+ flow_framework.common:WorkflowSearchResponse:
+ type: object
+ properties:
+ took:
+ type: integer
+ description: Time in milliseconds that the request took to complete.
+ timed_out:
+ type: boolean
+ description: Indicates if the request timed out.
+ _shards:
+ $ref: '#/components/schemas/flow_framework.common:shards'
+ hits:
+ $ref: '#/components/schemas/flow_framework.common:hits'
+ flow_framework.common:WorkflowSearchStateResponse:
+ type: object
+ properties:
+ took:
+ type: integer
+ description: Time in milliseconds that the request took to complete.
+ timed_out:
+ type: boolean
+ description: Indicates if the request timed out.
+ _shards:
+ $ref: '#/components/schemas/flow_framework.common:shards'
+ hits:
+ $ref: '#/components/schemas/flow_framework.common:StateHits'
+ flow_framework.common:WorkFlowStatusDefaultResponse:
+ type: object
+ properties:
+ workflow_id:
+ type: string
+ description: The ID of the workflow
+ error:
+ type: string
+ description: Any error state associated with the workflow
+ nullable: true
+ state:
+ type: string
+ description: The current state of the workflow
+ resources_created:
+ type: array
+ items:
+ type: string
+ description: A list of resources created by the workflow
+ flow_framework.common:WorkFlowStatusFullResponse:
+ type: object
+ properties:
+ workflow_id:
+ type: string
+ description: The ID of the workflow
+ error:
+ type: string
+ description: Any error state associated with the workflow
+ nullable: true
+ state:
+ type: string
+ description: The current state of the workflow
+ enum:
+ - COMPLETED
+ - FAILED
+ - NOT_STARTED
+ - PROVISIONING
+ resources_created:
+ type: array
+ items:
+ type: string
+ description: A list of resources created by the workflow
+ provisioning_progress:
+ type: string
+ description: The progress of the provisioning process
+ nullable: true
+ provision_start_time:
+ type: string
+ format: date-time
+ description: The start time of the provisioning process
+ provision_end_time:
+ type: string
+ format: date-time
+ description: The end time of the provisioning process
+ user:
+ $ref: '#/components/schemas/flow_framework.common:user'
+ user_outputs:
+ type: array
+ items:
+ type: string
+ description: Outputs generated by the user
+ flow_framework.common:WorkflowStep:
+ type: object
+ properties:
+ inputs:
+ type: array
+ items:
+ type: string
+ description: The list of required inputs for the workflow step
+ outputs:
+ type: array
+ items:
+ type: string
+ description: The list of outputs generated by the workflow step
+ required_plugins:
+ type: array
+ items:
+ type: string
+ description: The list of plugins required for the workflow step
+ flow_framework.common:WorkflowStepName:
+ type: string
+ flow_framework.errors:BadRequestError:
+ type: object
+ properties:
+ error:
+ type: string
+ description: Error message when the request body or parameters are invalid.
+ example: Invalid request body or query parameters.
+ status:
+ type: integer
+ description: HTTP status code for the error.
+ example: 400
+ flow_framework.errors:ConflictError:
+ content:
+ application/json:
+ type: object
+ properties:
+ message:
+ type: string
+ example: You cannot use both the 'provision_workflow' and 'update_workflow_fields' parameters in the same request.
+ status:
+ type: integer
+ flow_framework.errors:DeprovisioningError:
+ type: object
+ properties:
+ error:
+ type: string
+ description: Describes the deprovisioning error and identifies resources that were not deprovisioned
+ example: Failed to deprovision some resources [connector_id Lw7PX4wBfVtHp98y06wV].
+ required:
+ - error
+ flow_framework.errors:DeprovisioningForbiddenError:
+ type: object
+ properties:
+ error:
+ type: string
+ description: Describes the resources that require the allow_delete parameter for deprovisioning
+ example: These resources require the allow_delete parameter to deprovision [index_name my-index].
+ required:
+ - error
+ flow_framework.errors:DuplicateKeyError:
+ type: object
+ properties:
+ error:
+ type: string
+ description: Error message when a duplicate key is found in the request.
+ status:
+ type: integer
+ description: HTTP status code for the error.
+ example: 400
+ flow_framework.errors:FlowFrameworkAPIDisabledError:
+ content:
+ application/json:
+ type: object
+ properties:
+ message:
+ type: string
+ example: This API is disabled. To enable it, set [flow_framework.enabled] to true.
+ status:
+ type: integer
+ flow_framework.errors:InvalidParameterError:
+ content:
+ application/json:
+ type: object
+ properties:
+ message:
+ type: string
+ example: Only the parameters [param1, param2] are permitted unless the provision parameter is set to true.
+ status:
+ type: integer
+ flow_framework.errors:InvalidRequestBodyFieldError:
+ type: object
+ properties:
+ error:
+ type: string
+ description: Error message when a request body field is not a string.
+ status:
+ type: integer
+ description: HTTP status code for the error.
+ flow_framework.errors:MaxWorkflowsLimitError:
+ content:
+ application/json:
+ type: object
+ properties:
+ message:
+ type: string
+ example: Maximum workflows limit reached 50
+ code:
+ type: integer
+ flow_framework.errors:MissingParameterError:
+ content:
+ application/json:
+ type: object
+ properties:
+ message:
+ type: string
+ example: You cannot use the 'reprovision_workflow' parameter to create a new template.
+ status:
+ type: integer
+ flow_framework.errors:ParameterConflictError:
+ content:
+ application/json:
+ type: object
+ properties:
+ message:
+ type: string
+ example: You cannot use the 'reprovision_workflow' and 'use_case' parameters in the same request.
+ status:
+ type: integer
+ flow_framework.errors:RequestBodyParsingFailedError:
+ type: object
+ properties:
+ error:
+ type: string
+ description: Error message when request body parsing fails.
+ status:
+ type: integer
+ description: HTTP status code for the error.
+ example: 400
+ flow_framework.errors:RequestTimeoutError:
+ type: object
+ properties:
+ error:
+ type: string
+ description: Error message when the request times out.
+ status:
+ type: integer
+ description: HTTP status code for the error.
+ example: 408
+ flow_framework.errors:TemplateNotFoundError:
+ content:
+ application/json:
+ type: object
+ properties:
+ message:
+ type: string
+ example: Failed to retrieve template (12345) from global context.
+ code:
+ type: integer
+ flow_framework.errors:WorkFlowIdNullError:
+ content:
+ application/json:
+ type: object
+ properties:
+ message:
+ type: string
+ example: Workflow ID can not be null
+ status:
+ type: integer
+ flow_framework.errors:WorkflowSaveError:
+ content:
+ application/json:
+ type: object
+ properties:
+ message:
+ type: string
+ example: Failed to save workflow state
+ status:
+ type: integer
+ flow_framework.errors:WorkflowStepsRetrieveError:
+ content:
+ application/json:
+ type: object
+ properties:
+ message:
+ type: string
+ example: Failed to retrieve workflow step json.
+ code:
+ type: integer
indices._common:Alias:
type: object
properties:
@@ -43857,13 +46139,13 @@ components:
max_docs:
type: number
min_size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
max_size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
min_primary_shard_size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
max_primary_shard_size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
min_primary_shard_docs:
type: number
max_primary_shard_docs:
@@ -44697,7 +46979,7 @@ components:
durability:
$ref: '#/components/schemas/indices._common:TranslogDurability'
flush_threshold_size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
retention:
$ref: '#/components/schemas/indices._common:TranslogRetention'
indices._common:TranslogDurability:
@@ -44709,7 +46991,7 @@ components:
type: object
properties:
size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
age:
$ref: '#/components/schemas/_common:Duration'
indices.add_block:IndicesBlockOptions:
@@ -44872,10 +47154,10 @@ components:
maximum_timestamp:
$ref: '#/components/schemas/_common:EpochTimeUnitMillis'
store_size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
store_size_bytes:
description: Total size, in bytes, of all shards for the data stream's backing indices.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- backing_indices
- data_stream
@@ -44953,23 +47235,23 @@ components:
type: object
properties:
percent:
- $ref: '#/components/schemas/_common:Percentage'
+ $ref: '#/components/schemas/_common:PercentageString'
recovered:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
recovered_in_bytes:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
recovered_from_snapshot:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
recovered_from_snapshot_in_bytes:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
reused:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
reused_in_bytes:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
total:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_in_bytes:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- percent
- recovered_in_bytes
@@ -44983,7 +47265,7 @@ components:
items:
$ref: '#/components/schemas/indices.recovery:FileDetails'
percent:
- $ref: '#/components/schemas/_common:Percentage'
+ $ref: '#/components/schemas/_common:PercentageString'
recovered:
type: number
reused:
@@ -45123,7 +47405,7 @@ components:
type: object
properties:
percent:
- $ref: '#/components/schemas/_common:Percentage'
+ $ref: '#/components/schemas/_common:PercentageString'
recovered:
type: number
total:
@@ -45209,21 +47491,21 @@ components:
max_docs:
type: number
max_size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
max_size_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
min_size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
min_size_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
max_primary_shard_size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
max_primary_shard_size_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
min_primary_shard_size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
min_primary_shard_size_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
max_primary_shard_docs:
type: number
min_primary_shard_docs:
@@ -45235,35 +47517,41 @@ components:
type: object
additionalProperties:
oneOf:
- - $ref: '#/components/schemas/indices.segments:ShardsSegment'
- type: array
items:
$ref: '#/components/schemas/indices.segments:ShardsSegment'
+ - $ref: '#/components/schemas/indices.segments:ShardsSegment'
required:
- shards
indices.segments:Segment:
type: object
properties:
- attributes:
- type: object
- additionalProperties:
- type: string
+ generation:
+ type: integer
+ num_docs:
+ type: integer
+ deleted_docs:
+ type: integer
+ size:
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
+ size_in_bytes:
+ $ref: '#/components/schemas/_common:ByteCount'
+ memory:
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
+ memory_in_bytes:
+ $ref: '#/components/schemas/_common:ByteCount'
committed:
type: boolean
- compound:
- type: boolean
- deleted_docs:
- type: number
- generation:
- type: number
search:
type: boolean
- size_in_bytes:
- type: number
- num_docs:
- type: number
version:
$ref: '#/components/schemas/_common:VersionString'
+ compound:
+ type: boolean
+ attributes:
+ type: object
+ additionalProperties:
+ type: string
required:
- attributes
- committed
@@ -45490,14 +47778,16 @@ components:
properties:
description:
type: string
+ size:
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
min_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
max_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
average_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
count:
type: number
required:
@@ -46619,6 +48909,379 @@ components:
type: string
status:
$ref: '#/components/schemas/_common:ActionStatusOptions'
+ ism._common:Action:
+ type: object
+ description: An action to perform.
+ properties:
+ timeout:
+ $ref: '#/components/schemas/ism._common:ActionTimeout'
+ retry:
+ $ref: '#/components/schemas/ism._common:ActionRetry'
+ alias:
+ $ref: '#/components/schemas/ism._common:ActionAlias'
+ delete:
+ $ref: '#/components/schemas/ism._common:ActionDelete'
+ force_merge:
+ $ref: '#/components/schemas/ism._common:ActionForceMerge'
+ read_only:
+ $ref: '#/components/schemas/ism._common:ActionReadOnly'
+ read_write:
+ $ref: '#/components/schemas/ism._common:ActionReadWrite'
+ replica_count:
+ $ref: '#/components/schemas/ism._common:ActionReplicaCount'
+ index_priority:
+ $ref: '#/components/schemas/ism._common:ActionIndexPriority'
+ close:
+ $ref: '#/components/schemas/ism._common:ActionClose'
+ open:
+ $ref: '#/components/schemas/ism._common:ActionOpen'
+ snapshot:
+ $ref: '#/components/schemas/ism._common:ActionSnapshot'
+ rollover:
+ $ref: '#/components/schemas/ism._common:ActionRollover'
+ notification:
+ $ref: '#/components/schemas/ism._common:ActionNotification'
+ allocation:
+ $ref: '#/components/schemas/ism._common:ActionAllocation'
+ rollup:
+ $ref: '#/components/schemas/ism._common:ActionRollup'
+ transform:
+ $ref: '#/components/schemas/ism._common:ActionTransform'
+ shrink:
+ $ref: '#/components/schemas/ism._common:ActionShrink'
+ custom:
+ $ref: '#/components/schemas/ism._common:ActionCustom'
+ ism._common:ActionAlias:
+ type: object
+ properties:
+ actions:
+ type: object
+ additionalProperties: true
+ ism._common:ActionAllocation:
+ type: object
+ properties:
+ require:
+ type: object
+ additionalProperties: true
+ include:
+ type: object
+ additionalProperties: true
+ exclude:
+ type: object
+ additionalProperties: true
+ wait_for:
+ type: boolean
+ ism._common:ActionClose:
+ type: object
+ ism._common:ActionCustom:
+ type: object
+ additionalProperties: true
+ ism._common:ActionDelete:
+ type: object
+ ism._common:ActionForceMerge:
+ type: object
+ properties:
+ max_num_segments:
+ type: integer
+ ism._common:ActionIndexPriority:
+ type: object
+ properties:
+ priority:
+ type: number
+ ism._common:ActionNotification:
+ type: object
+ additionalProperties: true
+ ism._common:ActionOpen:
+ type: object
+ ism._common:ActionReadOnly:
+ type: object
+ ism._common:ActionReadWrite:
+ type: object
+ ism._common:ActionReplicaCount:
+ type: object
+ properties:
+ number_of_replicas:
+ type: number
+ ism._common:ActionRetry:
+ type: object
+ properties:
+ count:
+ type: integer
+ backoff:
+ type: string
+ delay:
+ type: string
+ ism._common:ActionRollover:
+ type: object
+ properties:
+ min_size:
+ type: number
+ min_index_age:
+ type: number
+ min_doc_count:
+ type: number
+ min_primary_shard_size:
+ type: number
+ copy_alias:
+ type: boolean
+ ism._common:ActionRollup:
+ type: object
+ additionalProperties: true
+ ism._common:ActionShrink:
+ type: object
+ additionalProperties: true
+ ism._common:ActionSnapshot:
+ type: object
+ properties:
+ repository:
+ type: string
+ snapshot:
+ type: string
+ include_global_state:
+ type: boolean
+ ism._common:ActionTimeout:
+ type: object
+ properties:
+ timeout:
+ type: object
+ ism._common:ActionTransform:
+ type: object
+ additionalProperties: true
+ ism._common:AddPolicyRequest:
+ type: object
+ properties:
+ policy_id:
+ type: string
+ required:
+ - policy_id
+ ism._common:AddPolicyResponse:
+ $ref: '#/components/schemas/ism._common:ChangePolicyResponse'
+ ism._common:ChangePolicyRequest:
+ type: object
+ properties:
+ policy_id:
+ type: string
+ state:
+ type: string
+ include:
+ type: array
+ items:
+ $ref: '#/components/schemas/ism._common:IncludeState'
+ required:
+ - policy_id
+ ism._common:ChangePolicyResponse:
+ type: object
+ properties:
+ updated_indices:
+ type: number
+ failures:
+ type: boolean
+ failed_indices:
+ type: array
+ items:
+ $ref: '#/components/schemas/ism._common:FailedIndex'
+ ism._common:Channel:
+ type: object
+ properties:
+ id:
+ type: string
+ ism._common:DeletePolicyResponse:
+ $ref: '#/components/schemas/_common:WriteResponseBase'
+ ism._common:ErrorNotification:
+ type: object
+ properties:
+ destination:
+ $ref: '#/components/schemas/ism._common:ErrorNotificationDestination'
+ channel:
+ $ref: '#/components/schemas/ism._common:Channel'
+ message_template:
+ type: object
+ additionalProperties: true
+ ism._common:ErrorNotificationChime:
+ type: object
+ properties:
+ url:
+ type: string
+ ism._common:ErrorNotificationDestination:
+ type: object
+ properties:
+ name:
+ type: string
+ last_update_time:
+ type: integer
+ additionalProperties:
+ anyOf:
+ - $ref: '#/components/schemas/ism._common:ErrorNotificationChime'
+ - $ref: '#/components/schemas/ism._common:ErrorNotificationSlack'
+ ism._common:ErrorNotificationSlack:
+ type: object
+ properties:
+ url:
+ type: string
+ custom_webhook:
+ $ref: '#/components/schemas/ism._common:SlackCustomWebhook'
+ ism._common:ExplainIndexResponse:
+ type: object
+ properties:
+ total_managed_indices:
+ type: number
+ additionalProperties:
+ $ref: '#/components/schemas/ism._common:ExplainPolicy'
+ ism._common:ExplainPolicy:
+ type: object
+ properties:
+ index.plugins.index_state_management.policy_id:
+ type:
+ - 'null'
+ - string
+ index.opendistro.index_state_management.policy_id:
+ type:
+ - 'null'
+ - string
+ enabled:
+ type:
+ - boolean
+ - 'null'
+ ism._common:FailedIndex:
+ type: object
+ properties:
+ index_name:
+ type: string
+ index_uuid:
+ type: string
+ reason:
+ type: string
+ ism._common:GetPolicyResponse:
+ allOf:
+ - $ref: '#/components/schemas/ism._common:Metadata'
+ - $ref: '#/components/schemas/ism._common:PolicyEnvelope'
+ ism._common:IncludeState:
+ type: object
+ properties:
+ state:
+ type: string
+ ism._common:IsmTemplate:
+ type: object
+ properties:
+ index_patterns:
+ type: array
+ items:
+ type: string
+ priority:
+ type: number
+ last_updated_time:
+ type: integer
+ ism._common:Metadata:
+ type: object
+ properties:
+ _id:
+ $ref: '#/components/schemas/_common:Id'
+ _primary_term:
+ type: number
+ _seq_no:
+ $ref: '#/components/schemas/_common:SequenceNumber'
+ _version:
+ $ref: '#/components/schemas/_common:VersionNumber'
+ ism._common:Policy:
+ type: object
+ description: A policy defines how an index is managed throughout its lifetime.
+ properties:
+ policy_id:
+ type: string
+ description:
+ type: string
+ last_updated_time:
+ type: integer
+ schema_version:
+ type: number
+ error_notification:
+ oneOf:
+ - $ref: '#/components/schemas/ism._common:ErrorNotification'
+ - type: 'null'
+ default_state:
+ type: string
+ description: The default state an index is in.
+ states:
+ type: array
+ description: List of states for the index to transition between.
+ items:
+ $ref: '#/components/schemas/ism._common:States'
+ ism_template:
+ oneOf:
+ - $ref: '#/components/schemas/ism._common:IsmTemplate'
+ - type: 'null'
+ - type: array
+ items:
+ $ref: '#/components/schemas/ism._common:IsmTemplate'
+ ism._common:PolicyEnvelope:
+ type: object
+ properties:
+ policy:
+ $ref: '#/components/schemas/ism._common:Policy'
+ ism._common:PutPolicyRequest:
+ $ref: '#/components/schemas/ism._common:PolicyEnvelope'
+ ism._common:PutPolicyResponse:
+ allOf:
+ - $ref: '#/components/schemas/ism._common:Metadata'
+ - type: object
+ properties:
+ policy:
+ $ref: '#/components/schemas/ism._common:PolicyEnvelope'
+ ism._common:RemovePolicyResponse:
+ $ref: '#/components/schemas/ism._common:ChangePolicyResponse'
+ ism._common:SlackCustomWebhook:
+ type: object
+ properties:
+ url:
+ type: string
+ scheme:
+ type: string
+ host:
+ type: string
+ port:
+ type: integer
+ path:
+ type: string
+ query_params:
+ type: object
+ additionalProperties: true
+ header_params:
+ type: object
+ additionalProperties: true
+ username:
+ type: string
+ password:
+ type: string
+ ism._common:States:
+ type: object
+ description: |-
+ A list of actions to perform, and transitions to enter a new state.
+ Once a managed index enters a state it will sequentially execute the actions
+ in the same order listed in the policy. Once all actions have been successfully completed
+ state transitions will be checked until a true condition is eventually met.
+ If you define multiple transitions in a state, the first one in the list that is true will be used.
+ properties:
+ name:
+ type: string
+ actions:
+ type: array
+ description: A list of actions to perform.
+ items:
+ $ref: '#/components/schemas/ism._common:Action'
+ transitions:
+ type: array
+ description: A list of transitions to enter a new state.
+ items:
+ $ref: '#/components/schemas/ism._common:Transition'
+ ism._common:Transition:
+ type: object
+ description: A transition into a new state.
+ properties:
+ state_name:
+ type: string
+ conditions:
+ type: object
+ additionalProperties: true
knn._common:DefaultOperator:
type: string
description: The default operator for query string query (AND or OR).
@@ -46657,7 +49320,7 @@ components:
type: string
description: The model group name.
latest_version:
- type: number
+ type: integer
description: The latest version.
description:
type: string
@@ -46814,16 +49477,16 @@ components:
properties:
estimated_size:
description: Estimated memory used for the operation.
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
estimated_size_in_bytes:
description: Estimated memory used, in bytes, for the operation.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
limit_size:
description: Memory limit for the circuit breaker.
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
limit_size_in_bytes:
description: Memory limit, in bytes, for the circuit breaker.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
overhead:
description: A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate.
type: number
@@ -46915,7 +49578,7 @@ components:
type: number
request_size_bytes:
description: Cumulative size in bytes of all requests from this client.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
x_opaque_id:
description: |-
Value from the client's `x-opaque-id` HTTP header.
@@ -47005,7 +49668,7 @@ components:
type: object
properties:
percent:
- type: number
+ $ref: '#/components/schemas/_common:PercentageNumber'
sys:
$ref: '#/components/schemas/_common:Duration'
sys_in_millis:
@@ -47035,34 +49698,38 @@ components:
properties:
available:
description: Total amount of disk space available to this Java virtual machine on this file store.
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
available_in_bytes:
description: Total number of bytes available to this Java virtual machine on this file store.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ cache_reserved:
+ x-version-added: '2.7'
+ description: Total number of cache bytes reserved available to this Java virtual machine on this file store.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
cache_reserved_in_bytes:
x-version-added: '2.7'
description: Total number of cache bytes reserved available to this Java virtual machine on this file store.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
disk_queue:
type: string
disk_reads:
type: number
disk_read_size:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
disk_read_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
disk_writes:
type: number
disk_write_size:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
disk_write_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
free:
description: Total amount of unallocated disk space in the file store.
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
free_in_bytes:
description: Total number of unallocated bytes in the file store.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
mount:
description: 'Mount point of the file store (for example: `/dev/sda2`).'
type: string
@@ -47071,10 +49738,10 @@ components:
type: string
total:
description: Total size of the file store.
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_in_bytes:
description: Total size of the file store in bytes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
type:
description: 'Type of the file store (ex: ext4).'
type: string
@@ -47107,10 +49774,10 @@ components:
properties:
free_percent:
description: Percentage of free memory.
- type: number
+ $ref: '#/components/schemas/_common:PercentageNumber'
used_percent:
description: Percentage of used memory.
- type: number
+ $ref: '#/components/schemas/_common:PercentageNumber'
nodes._common:FileSystem:
type: object
properties:
@@ -47136,29 +49803,33 @@ components:
Total disk space available to this Java virtual machine on all file stores.
Depending on OS or process level restrictions, this might appear less than `free`.
This is the actual amount of free disk space the OpenSearch node can utilize.
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
available_in_bytes:
description: |-
Total number of bytes available to this Java virtual machine on all file stores.
Depending on OS or process level restrictions, this might appear less than `free_in_bytes`.
This is the actual amount of free disk space the OpenSearch node can utilize.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
free:
description: Total unallocated disk space in all file stores.
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
free_in_bytes:
description: Total number of unallocated bytes in all file stores.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
total:
description: Total size of all file stores.
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_in_bytes:
description: Total size of all file stores in bytes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ cache_reserved:
+ x-version-added: '2.7'
+ description: Total size of cache bytes reserved in all file stores.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
cache_reserved_in_bytes:
x-version-added: '2.7'
description: Total size of cache bytes reserved in all file stores.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
nodes._common:GarbageCollector:
type: object
properties:
@@ -47204,12 +49875,12 @@ components:
type: object
properties:
limit:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
limit_in_bytes:
description: |-
Configured memory limit, in bytes, for the indexing requests.
Replica requests have an automatic limit that is 1.5x this value.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
current:
$ref: '#/components/schemas/nodes._common:PressureMemory'
total:
@@ -47243,6 +49914,8 @@ components:
type: object
additionalProperties:
$ref: '#/components/schemas/nodes._common:KeyedProcessor'
+ time:
+ $ref: '#/components/schemas/_common:Duration'
time_in_millis:
$ref: '#/components/schemas/_common:DurationValueUnitMillis'
nodes._common:IoStatDevice:
@@ -47328,24 +50001,39 @@ components:
nodes._common:JvmMemoryStats:
type: object
properties:
+ heap_used:
+ description: Memory currently in use by the heap.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
heap_used_in_bytes:
description: Memory, in bytes, currently in use by the heap.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
heap_used_percent:
description: Percentage of memory currently in use by the heap.
- type: number
+ $ref: '#/components/schemas/_common:PercentageNumber'
+ heap_committed:
+ description: Amount of memory available for use by the heap.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
heap_committed_in_bytes:
description: Amount of memory, in bytes, available for use by the heap.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ heap_max:
+ description: Maximum amount of memory available for use by the heap.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
heap_max_in_bytes:
description: Maximum amount of memory, in bytes, available for use by the heap.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ non_heap_used:
+ description: Non-heap memory used.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
non_heap_used_in_bytes:
description: Non-heap memory used, in bytes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ non_heap_committed:
+ description: Amount of non-heap memory available.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
non_heap_committed_in_bytes:
description: Amount of non-heap memory available, in bytes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
pools:
description: Contains statistics about heap memory usage for the node.
type: object
@@ -47370,12 +50058,16 @@ components:
nodes._common:LastGcStats:
type: object
properties:
+ used:
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
used_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ max:
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
max_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
usage_percent:
- type: number
+ $ref: '#/components/schemas/_common:PercentageNumber'
nodes._common:MemoryStats:
type: object
properties:
@@ -47383,28 +50075,37 @@ components:
description: |-
If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property then this reports the overridden value in bytes.
Otherwise it reports the same value as `total_in_bytes`.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
resident:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
resident_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
share:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
share_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
total_virtual:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_virtual_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ total:
+ description: Total amount of physical memory.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_in_bytes:
description: Total amount of physical memory in bytes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ free:
+ description: Amount of free physical memory.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
free_in_bytes:
description: Amount of free physical memory in bytes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ used:
+ description: Amount of used physical memory.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
used_in_bytes:
description: Amount of used physical memory in bytes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
nodes._common:NodeBufferPool:
type: object
properties:
@@ -47413,16 +50114,16 @@ components:
type: number
total_capacity:
description: Total capacity of buffer pools.
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_capacity_in_bytes:
description: Total capacity of buffer pools in bytes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
used:
description: Size of buffer pools.
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
used_in_bytes:
description: Size of buffer pools in bytes.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
nodes._common:NodeReloadError:
type: object
properties:
@@ -47457,18 +50158,30 @@ components:
nodes._common:Pool:
type: object
properties:
+ used:
+ description: Memory used by the heap.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
used_in_bytes:
description: Memory, in bytes, used by the heap.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ max:
+ description: Maximum amount of memory available for use by the heap.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
max_in_bytes:
description: Maximum amount of memory, in bytes, available for use by the heap.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ peak_used:
+ description: Largest amount of memory historically used by the heap.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
peak_used_in_bytes:
description: Largest amount of memory, in bytes, historically used by the heap.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ peak_max:
+ description: Largest amount of memory historically used by the heap.
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
peak_max_in_bytes:
description: Largest amount of memory, in bytes, historically used by the heap.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
last_gc_stats:
description: Most recent GC cycle stats for a particular memory pool.
$ref: '#/components/schemas/nodes._common:LastGcStats'
@@ -47476,32 +50189,32 @@ components:
type: object
properties:
all:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
all_in_bytes:
description: Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
combined_coordinating_and_primary:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
combined_coordinating_and_primary_in_bytes:
description: |-
Memory consumed, in bytes, by indexing requests in the coordinating or primary stage.
This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
coordinating:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
coordinating_in_bytes:
description: Memory consumed, in bytes, by indexing requests in the coordinating stage.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
primary:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
primary_in_bytes:
description: Memory consumed, in bytes, by indexing requests in the primary stage.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
replica:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
replica_in_bytes:
description: Memory consumed, in bytes, by indexing requests in the replica stage.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
coordinating_rejections:
description: Number of indexing requests rejected in the coordinating stage.
type: number
@@ -47541,6 +50254,8 @@ components:
failed:
description: Number of failed operations for the processor.
type: number
+ time:
+ $ref: '#/components/schemas/_common:Duration'
time_in_millis:
$ref: '#/components/schemas/_common:DurationValueUnitMillis'
nodes._common:PublishedClusterStates:
@@ -47621,13 +50336,13 @@ components:
count:
type: number
uncompressed_size:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
uncompressed_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
compressed_size:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
compressed_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
nodes._common:ShardAdmissionControlStats:
type: object
properties:
@@ -47642,8 +50357,10 @@ components:
nodes._common:ShardCacheStats:
type: object
properties:
+ size:
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
evictions:
type: number
hit_count:
@@ -47691,16 +50408,16 @@ components:
timestamp:
type: number
cpu_utilization_percent:
- $ref: '#/components/schemas/_common:Percentage'
+ $ref: '#/components/schemas/_common:PercentageString'
memory_utilization_percent:
- $ref: '#/components/schemas/_common:Percentage'
+ $ref: '#/components/schemas/_common:PercentageString'
io_usage_stats:
$ref: '#/components/schemas/nodes._common:ShardResourceUsageStatsIoUsageStats'
nodes._common:ShardResourceUsageStatsIoUsageStats:
type: object
properties:
max_io_utilization_percent:
- $ref: '#/components/schemas/_common:Percentage'
+ $ref: '#/components/schemas/_common:PercentageString'
nodes._common:ShardSearchBackpressureMode:
type: string
enum:
@@ -47724,7 +50441,7 @@ components:
cancellation_limit_reached_count:
type: number
cancelled_task_percentage:
- type: number
+ $ref: '#/components/schemas/_common:PercentageNumber'
current_cancellation_eligible_tasks_count:
type: number
nodes._common:ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats:
@@ -47732,8 +50449,12 @@ components:
properties:
cancellation_count:
type: number
+ current_max:
+ $ref: '#/components/schemas/_common:Duration'
current_max_millis:
$ref: '#/components/schemas/_common:DurationValueUnitMillis'
+ current_avg:
+ $ref: '#/components/schemas/_common:Duration'
current_avg_millis:
$ref: '#/components/schemas/_common:DurationValueUnitMillis'
nodes._common:ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats:
@@ -47741,8 +50462,12 @@ components:
properties:
cancellation_count:
type: number
+ current_max:
+ $ref: '#/components/schemas/_common:Duration'
current_max_millis:
$ref: '#/components/schemas/_common:DurationValueUnitMillis'
+ current_avg:
+ $ref: '#/components/schemas/_common:Duration'
current_avg_millis:
$ref: '#/components/schemas/_common:DurationValueUnitMillis'
nodes._common:ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats:
@@ -47750,12 +50475,18 @@ components:
properties:
cancellation_count:
type: number
+ current_max:
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
current_max_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ current_avg:
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
current_avg_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
+ rolling_avg:
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
rolling_avg_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
nodes._common:ShardSearchBackpressureTaskResourceTrackerStats:
type: object
properties:
@@ -47789,6 +50520,8 @@ components:
properties:
count:
type: number
+ time:
+ $ref: '#/components/schemas/_common:Duration'
time_in_millis:
$ref: '#/components/schemas/_common:DurationValueUnitMillis'
current:
@@ -47935,6 +50668,11 @@ components:
threads:
description: Number of threads in the thread pool.
type: number
+ total_wait_time:
+ description: |
+ The total amount of time that tasks spend waiting in the thread pool queue.
+ Currently, only `search`, `search_throttled`, and `index_searcher` thread pools support this metric.
+ $ref: '#/components/schemas/_common:Duration'
total_wait_time_in_nanos:
description: |
The total amount of time that tasks spend waiting in the thread pool queue.
@@ -47967,10 +50705,10 @@ components:
type: number
rx_size:
description: Size of RX packets received by the node during internal cluster communication.
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
rx_size_in_bytes:
description: Size, in bytes, of RX packets received by the node during internal cluster communication.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
server_open:
description: Current number of inbound TCP connections used for internal communication between nodes.
type: number
@@ -47979,10 +50717,10 @@ components:
type: number
tx_size:
description: Size of TX packets sent by the node during internal cluster communication.
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
tx_size_in_bytes:
description: Size, in bytes, of TX packets sent by the node during internal cluster communication.
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
total_outbound_connections:
description: |-
The cumulative number of outbound transport connections that this node has opened since it started.
@@ -48084,7 +50822,7 @@ components:
description: Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings.
type: number
total_indexing_buffer_in_bytes:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:ByteCount'
transport:
$ref: '#/components/schemas/nodes.info:NodeInfoTransport'
transport_address:
@@ -48154,9 +50892,9 @@ components:
items:
type: string
max_content_length:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
max_content_length_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
publish_address:
type: string
required:
@@ -48197,25 +50935,25 @@ components:
type: object
properties:
direct_max:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
direct_max_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
heap_init:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
heap_init_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
heap_max:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
heap_max_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
non_heap_init:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
non_heap_init_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
non_heap_max:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
non_heap_max_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- direct_max_in_bytes
- heap_init_in_bytes
@@ -48226,9 +50964,9 @@ components:
type: object
properties:
total:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
total_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- total
- total_in_bytes
@@ -48259,9 +50997,9 @@ components:
type: object
properties:
cache_size:
- type: string
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
cache_size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
cores_per_socket:
type: number
mhz:
@@ -50881,7 +53619,7 @@ components:
file_count:
type: number
size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- file_count
- size_in_bytes
@@ -50891,9 +53629,9 @@ components:
shard_count:
type: number
size:
- $ref: '#/components/schemas/_common:ByteSize'
+ $ref: '#/components/schemas/_common:HumanReadableByteCount'
size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
max_segments_per_shard:
type: number
required:
@@ -50997,7 +53735,7 @@ components:
file_count:
type: number
size_in_bytes:
- type: number
+ $ref: '#/components/schemas/_common:ByteCount'
required:
- file_count
- size_in_bytes
@@ -51366,32 +54104,43 @@ components:
- nodes
- none
- parents
- tasks._common:NodeTasks:
+ tasks._common:PersistentTaskStatus:
type: object
properties:
- name:
- $ref: '#/components/schemas/_common:NodeId'
- transport_address:
- $ref: '#/components/schemas/_common:TransportAddress'
- host:
- $ref: '#/components/schemas/_common:Host'
- ip:
- $ref: '#/components/schemas/_common:Ip'
- roles:
- type: array
- items:
- type: string
- attributes:
- type: object
- additionalProperties:
- type: string
- tasks:
- type: object
- additionalProperties:
- $ref: '#/components/schemas/tasks._common:TaskInfo'
+ state:
+ type: string
required:
- - tasks
- tasks._common:ParentTaskInfo:
+ - state
+ tasks._common:RawTaskStatus:
+ type: object
+ additionalProperties:
+ title: metadata
+ tasks._common:ReplicationTaskStatus:
+ type: object
+ properties:
+ phase:
+ type: string
+ required:
+ - phase
+ tasks._common:Status:
+ description: Task status information can vary wildly from task to task.
+ anyOf:
+ - $ref: '#/components/schemas/tasks._common:ReplicationTaskStatus'
+ - $ref: '#/components/schemas/_common:BulkByScrollTaskStatus'
+ - $ref: '#/components/schemas/tasks._common:PersistentTaskStatus'
+ - $ref: '#/components/schemas/tasks._common:RawTaskStatus'
+ tasks._common:TaskExecutingNode:
+ allOf:
+ - $ref: '#/components/schemas/_common:BaseNode'
+ - type: object
+ properties:
+ tasks:
+ type: object
+ additionalProperties:
+ $ref: '#/components/schemas/tasks._common:TaskInfo'
+ required:
+ - tasks
+ tasks._common:TaskGroup:
allOf:
- $ref: '#/components/schemas/tasks._common:TaskInfo'
- type: object
@@ -51399,7 +54148,7 @@ components:
children:
type: array
items:
- $ref: '#/components/schemas/tasks._common:TaskInfo'
+ $ref: '#/components/schemas/tasks._common:TaskGroup'
tasks._common:TaskInfo:
type: object
properties:
@@ -51416,7 +54165,8 @@ components:
additionalProperties:
type: string
id:
- type: number
+ type: integer
+ format: int64
node:
$ref: '#/components/schemas/_common:NodeId'
running_time:
@@ -51426,8 +54176,7 @@ components:
start_time_in_millis:
$ref: '#/components/schemas/_common:EpochTimeUnitMillis'
status:
- description: Task status information can vary wildly from task to task.
- type: object
+ $ref: '#/components/schemas/tasks._common:Status'
type:
type: string
parent_task_id:
@@ -51443,12 +54192,14 @@ components:
- type
tasks._common:TaskInfos:
oneOf:
- - type: array
+ - title: grouped_by_none
+ type: array
items:
$ref: '#/components/schemas/tasks._common:TaskInfo'
- - type: object
+ - title: grouped_by_parents
+ type: object
additionalProperties:
- $ref: '#/components/schemas/tasks._common:ParentTaskInfo'
+ $ref: '#/components/schemas/tasks._common:TaskGroup'
tasks._common:TaskListResponseBase:
type: object
properties:
@@ -51464,9 +54215,12 @@ components:
description: Task information grouped by node, if `group_by` was set to `node` (the default).
type: object
additionalProperties:
- $ref: '#/components/schemas/tasks._common:NodeTasks'
+ $ref: '#/components/schemas/tasks._common:TaskExecutingNode'
tasks:
$ref: '#/components/schemas/tasks._common:TaskInfos'
+ tasks._common:TaskResponse:
+ anyOf:
+ - $ref: '#/components/schemas/_common:BulkByScrollResponseBase'
transforms._common:ContinuousStats:
type: object
properties:
diff --git a/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs b/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs
index aa5bb56c74..9b1f18dd16 100644
--- a/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs
+++ b/src/OpenSearch.Client/_Generated/Descriptors.Cat.cs
@@ -123,7 +123,7 @@ public partial class CatAllPitSegmentsDescriptor
// values part of the url path
// Request parameters
/// The unit in which to display byte values.
- public CatAllPitSegmentsDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
+ public CatAllPitSegmentsDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes);
/// A short version of the Accept header, e.g. json, yaml.
public CatAllPitSegmentsDescriptor Format(string format) => Qs("format", format);
@@ -171,7 +171,7 @@ public CatAllocationDescriptor NodeId(NodeIds nodeId) =>
// Request parameters
/// The unit used to display byte values.
- public CatAllocationDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
+ public CatAllocationDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes);
/// Operation timeout for connection to cluster-manager node.
/// Supported by OpenSearch servers of version 2.0.0 or greater.
@@ -332,7 +332,7 @@ public CatFielddataDescriptor Fields(params Expression>[] fie
// Request parameters
/// The unit used to display byte values.
- public CatFielddataDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
+ public CatFielddataDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes);
/// A short version of the Accept header, e.g. json, yaml.
public CatFielddataDescriptor Format(string format) => Qs("format", format);
@@ -428,7 +428,7 @@ public CatIndicesDescriptor Index()
// Request parameters
/// The unit used to display byte values.
- public CatIndicesDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
+ public CatIndicesDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes);
/// Operation timeout for connection to cluster-manager node.
/// Supported by OpenSearch servers of version 2.0.0 or greater.
@@ -572,7 +572,7 @@ public partial class CatNodesDescriptor
// values part of the url path
// Request parameters
/// The unit used to display byte values.
- public CatNodesDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
+ public CatNodesDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes);
/// Operation timeout for connection to cluster-manager node.
/// Supported by OpenSearch servers of version 2.0.0 or greater.
@@ -671,7 +671,7 @@ public partial class CatPitSegmentsDescriptor
// values part of the url path
// Request parameters
/// The unit in which to display byte values.
- public CatPitSegmentsDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
+ public CatPitSegmentsDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes);
/// A short version of the Accept header, e.g. json, yaml.
public CatPitSegmentsDescriptor Format(string format) => Qs("format", format);
@@ -776,7 +776,7 @@ public CatRecoveryDescriptor ActiveOnly(bool? activeonly = true) =>
Qs("active_only", activeonly);
/// The unit used to display byte values.
- public CatRecoveryDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
+ public CatRecoveryDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes);
/// If `true`, the response includes detailed information about shard recoveries.
public CatRecoveryDescriptor Detailed(bool? detailed = true) => Qs("detailed", detailed);
@@ -888,7 +888,7 @@ public CatSegmentReplicationDescriptor AllowNoIndices(bool? allownoindices = tru
Qs("allow_no_indices", allownoindices);
/// The unit in which to display byte values.
- public CatSegmentReplicationDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
+ public CatSegmentReplicationDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes);
/// If `true`, the response only includes latest completed segment replication events.
public CatSegmentReplicationDescriptor CompletedOnly(bool? completedonly = true) =>
@@ -971,7 +971,7 @@ public CatSegmentsDescriptor Index()
// Request parameters
/// The unit used to display byte values.
- public CatSegmentsDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
+ public CatSegmentsDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes);
/// Operation timeout for connection to cluster-manager node.
/// Supported by OpenSearch servers of version 2.0.0 or greater.
@@ -1035,7 +1035,7 @@ public CatShardsDescriptor Index()
// Request parameters
/// The unit used to display byte values.
- public CatShardsDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
+ public CatShardsDescriptor Bytes(ByteUnit? bytes) => Qs("bytes", bytes);
/// Operation timeout for connection to cluster-manager node.
/// Supported by OpenSearch servers of version 2.0.0 or greater.
diff --git a/src/OpenSearch.Client/_Generated/Requests.Cat.cs b/src/OpenSearch.Client/_Generated/Requests.Cat.cs
index d29c92c640..77fe8b7dcb 100644
--- a/src/OpenSearch.Client/_Generated/Requests.Cat.cs
+++ b/src/OpenSearch.Client/_Generated/Requests.Cat.cs
@@ -157,9 +157,9 @@ public partial class CatAllPitSegmentsRequest
// Request parameters
/// The unit in which to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -233,9 +233,9 @@ public CatAllocationRequest(NodeIds nodeId)
// Request parameters
/// The unit used to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -483,9 +483,9 @@ public CatFielddataRequest(Fields fields)
// Request parameters
/// The unit used to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -635,9 +635,9 @@ public CatIndicesRequest(Indices index)
// Request parameters
/// The unit used to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -908,9 +908,9 @@ public partial class CatNodesRequest
// Request parameters
/// The unit used to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -1084,9 +1084,9 @@ public partial class CatPitSegmentsRequest
// Request parameters
/// The unit in which to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -1246,9 +1246,9 @@ public bool? ActiveOnly
}
/// The unit used to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -1427,9 +1427,9 @@ public bool? AllowNoIndices
}
/// The unit in which to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -1552,9 +1552,9 @@ public CatSegmentsRequest(Indices index)
// Request parameters
/// The unit used to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -1646,9 +1646,9 @@ public CatShardsRequest(Indices index)
// Request parameters
/// The unit used to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
diff --git a/src/OpenSearch.Net/_Generated/Api/Enums.cs b/src/OpenSearch.Net/_Generated/Api/Enums.cs
index 746e357fde..48300aeb2b 100644
--- a/src/OpenSearch.Net/_Generated/Api/Enums.cs
+++ b/src/OpenSearch.Net/_Generated/Api/Enums.cs
@@ -53,7 +53,7 @@
namespace OpenSearch.Net
{
[StringEnum]
- public enum Bytes
+ public enum ByteUnit
{
[EnumMember(Value = "b")]
B,
@@ -467,7 +467,7 @@ public static partial class KnownEnums
{
static partial void RegisterEnumStringResolvers()
{
- AddEnumStringResolver(GetStringValue);
+ AddEnumStringResolver(GetStringValue);
AddEnumStringResolver(GetStringValue);
AddEnumStringResolver(GetStringValue);
AddEnumStringResolver(GetStringValue);
@@ -484,22 +484,22 @@ static partial void RegisterEnumStringResolvers()
AddEnumStringResolver(GetStringValue);
}
- public static string GetStringValue(this Bytes enumValue) =>
+ public static string GetStringValue(this ByteUnit enumValue) =>
enumValue switch
{
- Bytes.B => "b",
- Bytes.G => "g",
- Bytes.Gb => "gb",
- Bytes.K => "k",
- Bytes.Kb => "kb",
- Bytes.M => "m",
- Bytes.Mb => "mb",
- Bytes.P => "p",
- Bytes.Pb => "pb",
- Bytes.T => "t",
- Bytes.Tb => "tb",
+ ByteUnit.B => "b",
+ ByteUnit.G => "g",
+ ByteUnit.Gb => "gb",
+ ByteUnit.K => "k",
+ ByteUnit.Kb => "kb",
+ ByteUnit.M => "m",
+ ByteUnit.Mb => "mb",
+ ByteUnit.P => "p",
+ ByteUnit.Pb => "pb",
+ ByteUnit.T => "t",
+ ByteUnit.Tb => "tb",
_ => throw new ArgumentException(
- $"'{enumValue.ToString()}' is not a valid value for enum 'Bytes'"
+ $"'{enumValue.ToString()}' is not a valid value for enum 'ByteUnit'"
),
};
diff --git a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cat.cs b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cat.cs
index 41aa98763d..0f84ab4139 100644
--- a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cat.cs
+++ b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cat.cs
@@ -121,9 +121,9 @@ public partial class CatAllPitSegmentsRequestParameters
public override bool SupportsBody => false;
/// The unit in which to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -175,9 +175,9 @@ public partial class CatAllocationRequestParameters
public override bool SupportsBody => false;
/// The unit used to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -372,9 +372,9 @@ public partial class CatFielddataRequestParameters
public override bool SupportsBody => false;
/// The unit used to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -493,9 +493,9 @@ public partial class CatIndicesRequestParameters
public override bool SupportsBody => false;
/// The unit used to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -742,9 +742,9 @@ public partial class CatNodesRequestParameters : RequestParameters false;
/// The unit used to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -903,9 +903,9 @@ public partial class CatPitSegmentsRequestParameters
public override bool SupportsBody => true;
/// The unit in which to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -1036,9 +1036,9 @@ public bool? ActiveOnly
}
/// The unit used to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -1193,9 +1193,9 @@ public bool? AllowNoIndices
}
/// The unit in which to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -1303,9 +1303,9 @@ public partial class CatSegmentsRequestParameters
public override bool SupportsBody => false;
/// The unit used to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
@@ -1374,9 +1374,9 @@ public partial class CatShardsRequestParameters : RequestParameters false;
/// The unit used to display byte values.
- public Bytes? Bytes
+ public ByteUnit? Bytes
{
- get => Q("bytes");
+ get => Q("bytes");
set => Q("bytes", value);
}
diff --git a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cluster.cs b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cluster.cs
index 6415954714..83e0135d9b 100644
--- a/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cluster.cs
+++ b/src/OpenSearch.Net/_Generated/Api/RequestParameters/RequestParameters.Cluster.cs
@@ -142,7 +142,7 @@ public partial class DeleteWeightedRoutingRequestParameters
: RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.DELETE;
- public override bool SupportsBody => false;
+ public override bool SupportsBody => true;
}
/// Request options for ComponentTemplateExists https://opensearch.org/docs/latest
@@ -577,7 +577,7 @@ public partial class PutWeightedRoutingRequestParameters
: RequestParameters
{
public override HttpMethod DefaultHttpMethod => HttpMethod.PUT;
- public override bool SupportsBody => false;
+ public override bool SupportsBody => true;
}
/// Request options for RemoteInfo https://opensearch.org/docs/latest/api-reference/remote-info/
diff --git a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cluster.cs b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cluster.cs
index faefa62ca2..223e801b31 100644
--- a/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cluster.cs
+++ b/src/OpenSearch.Net/_Generated/OpenSearchLowLevelClient.Cluster.cs
@@ -194,22 +194,26 @@ public Task DeleteVotingConfigExclusionsAsync(
);
/// DELETE on /_cluster/routing/awareness/weights https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights
+ ///
/// Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse DeleteWeightedRouting(
+ PostData body,
DeleteWeightedRoutingRequestParameters requestParameters = null
)
where TResponse : class, IOpenSearchResponse, new() =>
DoRequest(
DELETE,
"_cluster/routing/awareness/weights",
- null,
+ body,
RequestParams(requestParameters)
);
/// DELETE on /_cluster/routing/awareness/weights https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights
+ ///
/// Request specific configuration such as querystring parameters & request specific connection settings.
- [MapsApi("cluster.delete_weighted_routing", "")]
+ [MapsApi("cluster.delete_weighted_routing", "body")]
public Task DeleteWeightedRoutingAsync(
+ PostData body,
DeleteWeightedRoutingRequestParameters requestParameters = null,
CancellationToken ctx = default
)
@@ -218,7 +222,7 @@ public Task DeleteWeightedRoutingAsync(
DELETE,
"_cluster/routing/awareness/weights",
ctx,
- null,
+ body,
RequestParams(requestParameters)
);
@@ -635,25 +639,29 @@ public Task PutSettingsAsync(
/// PUT on /_cluster/routing/awareness/{attribute}/weights https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-weighted-round-robin-search
/// Awareness attribute name.
+ ///
/// Request specific configuration such as querystring parameters & request specific connection settings.
public TResponse PutWeightedRouting(
string attribute,
+ PostData body,
PutWeightedRoutingRequestParameters requestParameters = null
)
where TResponse : class, IOpenSearchResponse, new() =>
DoRequest(
PUT,
Url($"_cluster/routing/awareness/{attribute:attribute}/weights"),
- null,
+ body,
RequestParams(requestParameters)
);
/// PUT on /_cluster/routing/awareness/{attribute}/weights https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-weighted-round-robin-search
/// Awareness attribute name.
+ ///
/// Request specific configuration such as querystring parameters & request specific connection settings.
- [MapsApi("cluster.put_weighted_routing", "attribute")]
+ [MapsApi("cluster.put_weighted_routing", "attribute, body")]
public Task PutWeightedRoutingAsync(
string attribute,
+ PostData body,
PutWeightedRoutingRequestParameters requestParameters = null,
CancellationToken ctx = default
)
@@ -662,7 +670,7 @@ public Task PutWeightedRoutingAsync(
PUT,
Url($"_cluster/routing/awareness/{attribute:attribute}/weights"),
ctx,
- null,
+ body,
RequestParams(requestParameters)
);