From e57625147d1afdf8be60e30ac910f2679dd5590c Mon Sep 17 00:00:00 2001 From: pquentin <42327+pquentin@users.noreply.github.com> Date: Tue, 18 Mar 2025 04:07:02 +0000 Subject: [PATCH] Update rest-api-spec --- output/schema/schema-serverless.json | 10 +++++----- output/schema/schema.json | 4 ++-- ...rence.put.openai.json => inference.put_openai.json} | 0 ...nce.put.watsonx.json => inference.put_watsonx.json} | 0 4 files changed, 7 insertions(+), 7 deletions(-) rename specification/_json_spec/{inference.put.openai.json => inference.put_openai.json} (100%) rename specification/_json_spec/{inference.put.watsonx.json => inference.put_watsonx.json} (100%) diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index c30f355fda..b633172af9 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -19086,7 +19086,7 @@ "description": "If true, returns partial results if there are shard failures. If false, returns an error with no partial results.", "name": "allow_partial_search_results", "required": false, - "serverDefault": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -32533,7 +32533,7 @@ "aliases": [ "indexes" ], - "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the machine\nlearning nodes must have the `remote_cluster_client` role.", + "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the master\nnodes and the machine learning nodes must have the `remote_cluster_client` role.", "name": "indices", "required": false, "type": { @@ -43811,12 +43811,12 @@ }, "description": "Update an API key.\n\nUpdate attributes of an existing API key.\nThis API supports updates to an API key's access scope, expiration, and metadata.\n\nTo use this API, you must have at least the `manage_own_api_key` cluster privilege.\nUsers can only update API keys that they created or that were granted to them.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.\n\nUse this API to update API keys created by the create API key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.\nIt's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.\n\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope.\nThis change can occur if the owner user's permissions have changed since the API key was created or last modified.", "examples": { - "RequestExample1": { + "UpdateApiKeyRequestExample1": { "description": "Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to assign new role descriptors and metadata to an API key.\n", "summary": "Update role and metadata", "value": "{\n \"role_descriptors\": {\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\"*\"],\n \"privileges\": [\"write\"]\n }\n ]\n }\n },\n \"metadata\": {\n \"environment\": {\n \"level\": 2,\n \"trusted\": true,\n \"tags\": [\"production\"]\n }\n }\n}" }, - "RequestExample2": { + "UpdateApiKeyRequestExample2": { "description": "Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to remove the API key's previously assigned permissions. It will inherit the owner user's full permissions.\n", "summary": "Remove permissions", "value": "{\n \"role_descriptors\": {}\n}" @@ -43869,7 +43869,7 @@ ] }, "examples": { - "ResponseExample1": { + "UpdateApiKeyResponseExample1": { "description": "A successful response from `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx`. The API key's effective permissions after the update will be the intersection of the supplied role descriptors and the owner user's permissions.\n", "summary": "Update role and metadata", "value": "{\n \"updated\": true\n}" diff --git a/output/schema/schema.json b/output/schema/schema.json index b214304e1e..582e356127 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -123791,7 +123791,7 @@ "description": "If true, returns partial results if there are shard failures. If false, returns an error with no partial results.", "name": "allow_partial_search_results", "required": false, - "serverDefault": false, + "serverDefault": true, "type": { "kind": "instance_of", "type": { @@ -179975,7 +179975,7 @@ "aliases": [ "indexes" ], - "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the master \nnodes and the machine learning nodes must have the `remote_cluster_client` role.", + "description": "An array of index names. Wildcards are supported. If any of the indices are in remote clusters, the master\nnodes and the machine learning nodes must have the `remote_cluster_client` role.", "name": "indices", "required": false, "type": { diff --git a/specification/_json_spec/inference.put.openai.json b/specification/_json_spec/inference.put_openai.json similarity index 100% rename from specification/_json_spec/inference.put.openai.json rename to specification/_json_spec/inference.put_openai.json diff --git a/specification/_json_spec/inference.put.watsonx.json b/specification/_json_spec/inference.put_watsonx.json similarity index 100% rename from specification/_json_spec/inference.put.watsonx.json rename to specification/_json_spec/inference.put_watsonx.json