From e179262798f2ea36fd23c366c0bab60f4fa0ffcc Mon Sep 17 00:00:00 2001 From: pquentin <42327+pquentin@users.noreply.github.com> Date: Sat, 22 Feb 2025 04:06:27 +0000 Subject: [PATCH] Update rest-api-spec --- output/schema/validation-errors.json | 11 ----------- specification/_json_spec/cat.help.json | 11 ----------- specification/_json_spec/cat.segments.json | 8 ++++++++ specification/_json_spec/cat.tasks.json | 10 ++++++++++ 4 files changed, 18 insertions(+), 22 deletions(-) diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index 551146d60b..b8a18c3a33 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -56,13 +56,6 @@ ], "response": [] }, - "cat.help": { - "request": [ - "Request: missing json spec query parameter 'help'", - "Request: missing json spec query parameter 's'" - ], - "response": [] - }, "cat.indices": { "request": [ "request definition cat.indices:Request / body - A request with inherited properties must have a PropertyBody" @@ -138,8 +131,6 @@ }, "cat.segments": { "request": [ - "Request: query parameter 'local' does not exist in the json spec", - "Request: query parameter 'master_timeout' does not exist in the json spec", "request definition cat.segments:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] @@ -158,8 +149,6 @@ }, "cat.tasks": { "request": [ - "Request: query parameter 'timeout' does not exist in the json spec", - "Request: query parameter 'wait_for_completion' does not exist in the json spec", "request definition cat.tasks:Request / body - A request with inherited properties must have a PropertyBody" ], "response": [] diff --git a/specification/_json_spec/cat.help.json b/specification/_json_spec/cat.help.json index 07d8b8af0f..d37747f882 100644 --- a/specification/_json_spec/cat.help.json +++ b/specification/_json_spec/cat.help.json @@ -16,17 +16,6 @@ "methods": ["GET"] } ] - }, - "params": { - "help": { - "type": "boolean", - "description": "Return help information", - "default": false - }, - "s": { - "type": "list", - "description": "Comma-separated list of column names or column aliases to sort by" - } } } } diff --git a/specification/_json_spec/cat.segments.json b/specification/_json_spec/cat.segments.json index 765f0b41ef..369c813aba 100644 --- a/specification/_json_spec/cat.segments.json +++ b/specification/_json_spec/cat.segments.json @@ -32,6 +32,14 @@ "type": "string", "description": "a short version of the Accept header, e.g. json, yaml" }, + "local": { + "type": "boolean", + "description": "Return local information, do not retrieve the state from master node (default: false)" + }, + "master_timeout": { + "type": "time", + "description": "Explicit operation timeout for connection to master node" + }, "bytes": { "type": "enum", "description": "The unit in which to display byte values", diff --git a/specification/_json_spec/cat.tasks.json b/specification/_json_spec/cat.tasks.json index e8a74574f5..24164f3857 100644 --- a/specification/_json_spec/cat.tasks.json +++ b/specification/_json_spec/cat.tasks.json @@ -60,6 +60,16 @@ "type": "boolean", "description": "Verbose mode. Display column headers", "default": false + }, + "timeout": { + "type": "time", + "default": "30s", + "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error." + }, + "wait_for_completion": { + "type": "boolean", + "default": false, + "description": "If `true`, the request blocks until the task has completed." } } }