diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml index b1dffe9c20..26fe52654b 100644 --- a/docs/overlays/elasticsearch-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-openapi-overlays.yaml @@ -265,3 +265,52 @@ actions: examples: indicesOpenResponseExample1: $ref: "../../specification/indices/open/indicesOpenResponseExample1.yaml" + - target: "$.paths['/_autoscaling/policy/{name}']['delete']" + description: "Add examples for delete autoscaling policy response" + update: + responses: + 200: + content: + application/json: + examples: + deleteAutoscalingPolicyResponseExample1: + $ref: "../../specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.yaml" + - target: "$.paths['/_autoscaling/capacity']['get']" + description: "Add examples for get autoscaling capacity response" + update: + responses: + 200: + content: + application/json: + examples: + getAutoscalingCapacityResponseExample1: + $ref: "../../specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.yaml" + - target: "$.paths['/_autoscaling/policy/{name}']['get']" + description: "Add examples for get autoscaling policy response" + update: + responses: + 200: + content: + application/json: + examples: + getAutoscalingPolicyResponseExample1: + $ref: "../../specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.yaml" + - target: "$.paths['/_autoscaling/policy/{name}']['put']" + description: "Add examples for create autoscaling policy operation" + update: + update: + requestBody: + content: + application/json: + examples: + createAutoscalingPolicyRequestExample1: + $ref: "../../specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.yaml" + createAutoscalingPolicyRequestExample2: + $ref: "../../specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.yaml" + responses: + 200: + content: + application/json: + examples: + createAutoscalingPolicyResponseExample1: + $ref: "../../specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.yaml" diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 6834782daa..8f09da203d 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -471,8 +471,11 @@ "tags": [ "autoscaling" ], - "summary": "Retrieves an autoscaling policy", - "description": "Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "summary": "Get an autoscaling policy", + "description": "NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html" + }, "operationId": "autoscaling-get-autoscaling-policy", "parameters": [ { @@ -505,8 +508,11 @@ "tags": [ "autoscaling" ], - "summary": "Creates a new autoscaling policy", - "description": "Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "summary": "Create or update an autoscaling policy", + "description": "NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html" + }, "operationId": "autoscaling-put-autoscaling-policy", "parameters": [ { @@ -549,8 +555,11 @@ "tags": [ "autoscaling" ], - "summary": "Deletes an autoscaling policy", - "description": "Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "summary": "Delete an autoscaling policy", + "description": "NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html" + }, "operationId": "autoscaling-delete-autoscaling-policy", "parameters": [ { @@ -585,8 +594,11 @@ "tags": [ "autoscaling" ], - "summary": "Gets the current autoscaling capacity based on the configured autoscaling policy", - "description": "Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "summary": "Get the autoscaling capacity", + "description": "NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nThis API gets the current autoscaling capacity based on the configured autoscaling policy.\nIt will return information to size the cluster appropriately to the current workload.\n\nThe `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy.\n\nThe operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.\n\nThe response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required.\nThis information is provided for diagnosis only.\nDo not use this information to make autoscaling decisions.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html" + }, "operationId": "autoscaling-get-autoscaling-capacity", "responses": { "200": { @@ -48654,7 +48666,10 @@ } }, "deciders": { - "description": "Decider settings", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-deciders.html" + }, + "description": "Decider settings.", "type": "object", "additionalProperties": { "type": "object" diff --git a/output/schema/schema.json b/output/schema/schema.json index 8d47d2195c..ca147b8d29 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -324,9 +324,11 @@ "stability": "stable" } }, - "description": "Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Delete an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "docId": "autoscaling-delete-autoscaling-policy", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-delete-autoscaling-policy.html", + "extDocId": "autoscaling", + "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.delete_autoscaling_policy", "request": { "name": "Request", @@ -356,9 +358,11 @@ "stability": "stable" } }, - "description": "Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Get the autoscaling capacity.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nThis API gets the current autoscaling capacity based on the configured autoscaling policy.\nIt will return information to size the cluster appropriately to the current workload.\n\nThe `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy.\n\nThe operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.\n\nThe response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required.\nThis information is provided for diagnosis only.\nDo not use this information to make autoscaling decisions.", "docId": "autoscaling-get-autoscaling-capacity", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-get-autoscaling-capacity.html", + "extDocId": "autoscaling", + "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.get_autoscaling_capacity", "request": { "name": "Request", @@ -388,9 +392,11 @@ "stability": "stable" } }, - "description": "Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Get an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "docId": "autoscaling-get-autoscaling-capacity", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-get-autoscaling-capacity.html", + "extDocId": "autoscaling", + "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.get_autoscaling_policy", "request": { "name": "Request", @@ -420,9 +426,11 @@ "stability": "stable" } }, - "description": "Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Create or update an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "docId": "autoscaling-put-autoscaling-policy", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-put-autoscaling-policy.html", + "extDocId": "autoscaling", + "extDocUrl": "https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html", "name": "autoscaling.put_autoscaling_policy", "request": { "name": "Request", @@ -88478,7 +88486,9 @@ } }, { - "description": "Decider settings", + "description": "Decider settings.", + "extDocId": "autoscaling-deciders", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-deciders.html", "name": "deciders", "required": true, "type": { @@ -88497,7 +88507,7 @@ } } ], - "specLocation": "autoscaling/_types/AutoscalingPolicy.ts#L23-L27" + "specLocation": "autoscaling/_types/AutoscalingPolicy.ts#L23-L30" }, { "kind": "request", @@ -88507,7 +88517,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Delete an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "inherits": { "type": { "name": "RequestBase", @@ -88533,7 +88543,7 @@ } ], "query": [], - "specLocation": "autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts#L23-L32" + "specLocation": "autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts#L23-L36" }, { "kind": "response", @@ -88753,7 +88763,7 @@ "body": { "kind": "no_body" }, - "description": "Gets the current autoscaling capacity based on the configured autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Get the autoscaling capacity.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.\n\nThis API gets the current autoscaling capacity based on the configured autoscaling policy.\nIt will return information to size the cluster appropriately to the current workload.\n\nThe `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy.\n\nThe operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information.\n\nThe response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required.\nThis information is provided for diagnosis only.\nDo not use this information to make autoscaling decisions.", "inherits": { "type": { "name": "RequestBase", @@ -88766,7 +88776,7 @@ }, "path": [], "query": [], - "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts#L22-L27" + "specLocation": "autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts#L22-L42" }, { "kind": "response", @@ -88811,7 +88821,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Get an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "inherits": { "type": { "name": "RequestBase", @@ -88837,7 +88847,7 @@ } ], "query": [], - "specLocation": "autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts#L23-L32" + "specLocation": "autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts#L23-L36" }, { "kind": "response", @@ -88873,7 +88883,7 @@ } } }, - "description": "Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.", + "description": "Create or update an autoscaling policy.\n\nNOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.", "inherits": { "type": { "name": "RequestBase", @@ -88899,7 +88909,7 @@ } ], "query": [], - "specLocation": "autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts#L24-L35" + "specLocation": "autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts#L24-L39" }, { "kind": "response", diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index a534c32bca..0a16b8758e 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -10,6 +10,8 @@ api-date-math-index-names,https://www.elastic.co/guide/en/elasticsearch/referenc append-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/append-processor.html async-search,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/async-search.html attachment,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/attachment.html +autoscaling,https://www.elastic.co/guide/en/cloud/current/ec-autoscaling.html +autoscaling-deciders,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-deciders.html autoscaling-delete-autoscaling-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-delete-autoscaling-policy.html autoscaling-get-autoscaling-capacity,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-get-autoscaling-capacity.html autoscaling-get-autoscaling-policy,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/autoscaling-get-autoscaling-policy.html diff --git a/specification/autoscaling/_types/AutoscalingPolicy.ts b/specification/autoscaling/_types/AutoscalingPolicy.ts index 00e34f87af..73b2abf3a6 100644 --- a/specification/autoscaling/_types/AutoscalingPolicy.ts +++ b/specification/autoscaling/_types/AutoscalingPolicy.ts @@ -22,6 +22,9 @@ import { UserDefinedValue } from '@spec_utils/UserDefinedValue' export class AutoscalingPolicy { roles: string[] - /** Decider settings */ + /** + * Decider settings. + * @ext_doc_id autoscaling-deciders + */ deciders: Dictionary } diff --git a/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts b/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts index 0b99c541ce..f0764cf92d 100644 --- a/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts +++ b/specification/autoscaling/delete_autoscaling_policy/DeleteAutoscalingPolicyRequest.ts @@ -21,9 +21,13 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * Delete an autoscaling policy. + * + * NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. * @rest_spec_name autoscaling.delete_autoscaling_policy * @availability stack since=7.11.0 stability=stable * @doc_id autoscaling-delete-autoscaling-policy + * @ext_doc_id autoscaling */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.json b/specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.json deleted file mode 100644 index 38e84a9444..0000000000 --- a/specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response of deleting one or more autoscaling policy.", - "description": "This may be a respons to either `DELETE /_autoscaling/policy/my_autoscaling_policy` or `DELETE /_autoscaling/policy/*`.", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\": true\n}" -} diff --git a/specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.yaml b/specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.yaml new file mode 100644 index 0000000000..7ee291eec5 --- /dev/null +++ b/specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.yaml @@ -0,0 +1,6 @@ +summary: A successful response of deleting one or more autoscaling policy. +description: > + This may be a response to either `DELETE /_autoscaling/policy/my_autoscaling_policy` or `DELETE /_autoscaling/policy/*`. +# type: "response" +# response_code: 200 +value: "{\n \"acknowledged\": true\n}" diff --git a/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts b/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts index 6f64d2c261..0af9f01e07 100644 --- a/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts +++ b/specification/autoscaling/get_autoscaling_capacity/GetAutoscalingCapacityRequest.ts @@ -20,8 +20,23 @@ import { RequestBase } from '@_types/Base' /** + * Get the autoscaling capacity. + * + * NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. + * + * This API gets the current autoscaling capacity based on the configured autoscaling policy. + * It will return information to size the cluster appropriately to the current workload. + * + * The `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy. + * + * The operator should verify that the `current_nodes` match the operator’s knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information. + * + * The response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required. + * This information is provided for diagnosis only. + * Do not use this information to make autoscaling decisions. * @rest_spec_name autoscaling.get_autoscaling_capacity * @availability stack since=7.11.0 stability=stable * @doc_id autoscaling-get-autoscaling-capacity + * @ext_doc_id autoscaling */ export interface Request extends RequestBase {} diff --git a/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json b/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json deleted file mode 100644 index 04a9e9098f..0000000000 --- a/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response for retrieving the current autoscaling capacity.", - "description": "This may be a response to `GET /_autoscaling/capacity`.", - "type": "response", - "response_code": 200, - "value": "{\n policies: {}\n}" -} diff --git a/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.yaml b/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.yaml new file mode 100644 index 0000000000..62cfb5d82c --- /dev/null +++ b/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.yaml @@ -0,0 +1,5 @@ +summary: 'A successful response for retrieving the current autoscaling capacity.' +description: 'This may be a response to `GET /_autoscaling/capacity`.' +# type: "response" +# response_code: 200 +value: "{\n policies: {}\n}" diff --git a/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts b/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts index 10981b5661..01ded9d9ce 100644 --- a/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts +++ b/specification/autoscaling/get_autoscaling_policy/GetAutoscalingPolicyRequest.ts @@ -21,9 +21,13 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * Get an autoscaling policy. + * + * NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. * @rest_spec_name autoscaling.get_autoscaling_policy * @availability stack since=7.11.0 stability=stable * @doc_id autoscaling-get-autoscaling-capacity + * @ext_doc_id autoscaling */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json b/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json deleted file mode 100644 index 418325e902..0000000000 --- a/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response for retrieving an autoscaling policy.", - "description": "This may be a response to `GET /_autoscaling/policy/my_autoscaling_policy`.", - "type": "response", - "response_code": 200, - "value": "{\n \"roles\": ,\n \"deciders\": \n}" -} diff --git a/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.yaml b/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.yaml new file mode 100644 index 0000000000..4e435653c2 --- /dev/null +++ b/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.yaml @@ -0,0 +1,5 @@ +summary: 'A successful response for retrieving an autoscaling policy.' +description: 'This may be a response to `GET /_autoscaling/policy/my_autoscaling_policy`.' +# type: "response" +# response_code: 200 +value: "{\n \"roles\": ,\n \"deciders\": \n}" diff --git a/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts b/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts index 6cfd9fe0cb..03b1a4f115 100644 --- a/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts +++ b/specification/autoscaling/put_autoscaling_policy/PutAutoscalingPolicyRequest.ts @@ -22,9 +22,13 @@ import { RequestBase } from '@_types/Base' import { Name } from '@_types/common' /** + * Create or update an autoscaling policy. + * + * NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. * @rest_spec_name autoscaling.put_autoscaling_policy * @availability stack since=7.11.0 stability=stable * @doc_id autoscaling-put-autoscaling-policy + * @ext_doc_id autoscaling */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.json b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.json deleted file mode 100644 index 64bd4cb34c..0000000000 --- a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "Creates or updates an autoscaling policy.", - "method_request": "PUT /_autoscaling/policy/", - "description": "", - "type": "request", - "value": "{\n \"roles\": [],\n \"deciders\": {\n \"fixed\": {\n }\n }\n}" -} diff --git a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.yaml b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.yaml new file mode 100644 index 0000000000..2e8447645d --- /dev/null +++ b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.yaml @@ -0,0 +1,5 @@ +summary: 'Creates or updates an autoscaling policy.' +# method_request: "PUT /_autoscaling/policy/" +# description: "" +# type: "request" +value: "{\n \"roles\": [],\n \"deciders\": {\n \"fixed\": {\n }\n }\n}" diff --git a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json deleted file mode 100644 index 3e64f1618d..0000000000 --- a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "Creates an autoscaling policy.", - "method_request": "PUT /_autoscaling/policy/my_autoscaling_policy", - "description": "The API method and path for this request: `PUT /_autoscaling/policy/my_autoscaling_policy`. It creates `my_autoscaling_policy` using the fixed autoscaling decider, applying to the set of nodes having (only) the `data_hot` role.", - "type": "request", - "value": "{\n \"roles\" : [ \"data_hot\" ],\n \"deciders\": {\n \"fixed\": {\n }\n }\n}" -} diff --git a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.yaml b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.yaml new file mode 100644 index 0000000000..4cd9e5be04 --- /dev/null +++ b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.yaml @@ -0,0 +1,5 @@ +summary: 'Creates an autoscaling policy.' +# method_request: "PUT /_autoscaling/policy/my_autoscaling_policy" +description: 'The API method and path for this request: `PUT /_autoscaling/policy/my_autoscaling_policy`. It creates `my_autoscaling_policy` using the fixed autoscaling decider, applying to the set of nodes having (only) the `data_hot` role.' +# type: "request" +value: "{\n \"roles\" : [ \"data_hot\" ],\n \"deciders\": {\n \"fixed\": {\n }\n }\n}" diff --git a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.json b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.json deleted file mode 100644 index 5bcdde84b9..0000000000 --- a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response when creating an autoscaling policy.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\": true\n}" -} diff --git a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.yaml b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.yaml new file mode 100644 index 0000000000..b1ecfe7a30 --- /dev/null +++ b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.yaml @@ -0,0 +1,5 @@ +summary: 'A successful response when creating an autoscaling policy.' +# description: "", +# type: "response", +# response_code: 200, +value: "{\n \"acknowledged\": true\n}"