From a4442567b90ecb2e06d3f3c751b3d4051d0d6c1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Thu, 15 Aug 2024 12:31:43 +0200 Subject: [PATCH 1/5] Adds autoscaling and CCR API request and reponse examples. --- ...scalingApisDeleteAutoscalingPolicyResponseExample1.json | 7 +++++++ ...oscalingApisGetAutoscalingCapacityResponseExample1.json | 7 +++++++ ...utoscalingApisGetAutoscalingPolicyResponseExample1.json | 7 +++++++ ...autoscalingApisPutAutoscalingPolicyRequestExample1.json | 7 +++++++ ...autoscalingApisPutAutoscalingPolicyRequestExample2.json | 7 +++++++ ...utoscalingApisPutAutoscalingPolicyResponseExample1.json | 7 +++++++ .../ccr/follow/ccrApisFollowPutFollowRequestExample1.json | 7 +++++++ .../ccr/follow/ccrApisFollowPutFollowRequestExample3.json | 7 +++++++ .../ccr/follow/ccrApisFollowPutFollowResponseExample1.json | 7 +++++++ .../ccrApisFollowPostForgetFollowerRequestExample1.json | 7 +++++++ .../ccrApisFollowPostForgetFollowerResponseExample1.json | 7 +++++++ ...rApisAutoFollowPutAutoFollowPatternRequestExample1.json | 7 +++++++ ...rApisAutoFollowPutAutoFollowPatternRequestExample2.json | 7 +++++++ ...ApisAutoFollowPutAutoFollowPatternResponseExample1.json | 7 +++++++ .../ccrApisFollowPostResumeFollowRequestExample2.json | 7 +++++++ .../ccrApisFollowPostResumeFollowResponseExample1.json | 7 +++++++ 16 files changed, 112 insertions(+) create mode 100644 specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.json create mode 100644 specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json create mode 100644 specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json create mode 100644 specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.json create mode 100644 specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json create mode 100644 specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.json create mode 100644 specification/ccr/follow/ccrApisFollowPutFollowRequestExample1.json create mode 100644 specification/ccr/follow/ccrApisFollowPutFollowRequestExample3.json create mode 100644 specification/ccr/follow/ccrApisFollowPutFollowResponseExample1.json create mode 100644 specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerRequestExample1.json create mode 100644 specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerResponseExample1.json create mode 100644 specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample1.json create mode 100644 specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample2.json create mode 100644 specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternResponseExample1.json create mode 100644 specification/ccr/resume_follow/ccrApisFollowPostResumeFollowRequestExample2.json create mode 100644 specification/ccr/resume_follow/ccrApisFollowPostResumeFollowResponseExample1.json diff --git a/specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.json b/specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.json new file mode 100644 index 0000000000..53c20289d8 --- /dev/null +++ b/specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.json @@ -0,0 +1,7 @@ +{ + "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}" +} \ No newline at end of file diff --git a/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json b/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json new file mode 100644 index 0000000000..0385208b87 --- /dev/null +++ b/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful respons 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}" +} \ No newline at end of file diff --git a/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json b/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json new file mode 100644 index 0000000000..5e7ed20e26 --- /dev/null +++ b/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful respons 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}" +} \ No newline at end of file diff --git a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.json b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.json new file mode 100644 index 0000000000..9acbb7c837 --- /dev/null +++ b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.json @@ -0,0 +1,7 @@ +{ + "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}" +} \ No newline at end of file diff --git a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json new file mode 100644 index 0000000000..2b0768aa5b --- /dev/null +++ b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json @@ -0,0 +1,7 @@ +{ + "summary": "Creates an autoscaling policy named `my_autoscaling_policy` using the fixed autoscaling decider, applying to the set of nodes having (only) the `data_hot` role", + "method_request": "PUT /_autoscaling/policy/my_autoscaling_policy", + "description": "The API method and path for this request: `PUT /_autoscaling/policy/my_autoscaling_policy`", + "type": "request", + "value": "{\n \"roles\" : [ \"data_hot\" ],\n \"deciders\": {\n \"fixed\": {\n }\n }\n}" +} \ No newline at end of file diff --git a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.json b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.json new file mode 100644 index 0000000000..20c915cbe3 --- /dev/null +++ b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response when creating an autoscaling policy.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\": true\n}" +} \ No newline at end of file diff --git a/specification/ccr/follow/ccrApisFollowPutFollowRequestExample1.json b/specification/ccr/follow/ccrApisFollowPutFollowRequestExample1.json new file mode 100644 index 0000000000..7a76148282 --- /dev/null +++ b/specification/ccr/follow/ccrApisFollowPutFollowRequestExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "Creates a follower index.", + "method_request": "PUT //_ccr/follow?wait_for_active_shards=1", + "description": "The API method and path for this request: `PUT //_ccr/follow?wait_for_active_shards=1`.", + "type": "request", + "value": "{\n \"remote_cluster\" : \"\",\n \"leader_index\" : \"\"\n}" +} \ No newline at end of file diff --git a/specification/ccr/follow/ccrApisFollowPutFollowRequestExample3.json b/specification/ccr/follow/ccrApisFollowPutFollowRequestExample3.json new file mode 100644 index 0000000000..97d574f268 --- /dev/null +++ b/specification/ccr/follow/ccrApisFollowPutFollowRequestExample3.json @@ -0,0 +1,7 @@ +{ + "summary": "Creates a follower index named `follower_index`.", + "method_request": "PUT /follower_index/_ccr/follow?wait_for_active_shards=1", + "description": "The API method and path for this reqest: `PUT /follower_index/_ccr/follow?wait_for_active_shards=1`.", + "type": "request", + "value": "{\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"settings\": {\n \"index.number_of_replicas\": 0\n },\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" +} \ No newline at end of file diff --git a/specification/ccr/follow/ccrApisFollowPutFollowResponseExample1.json b/specification/ccr/follow/ccrApisFollowPutFollowResponseExample1.json new file mode 100644 index 0000000000..6ebcaef54f --- /dev/null +++ b/specification/ccr/follow/ccrApisFollowPutFollowResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response for creating a follower index.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"follow_index_created\" : true,\n \"follow_index_shards_acked\" : true,\n \"index_following_started\" : true\n}" +} \ No newline at end of file diff --git a/specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerRequestExample1.json b/specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerRequestExample1.json new file mode 100644 index 0000000000..d470724e91 --- /dev/null +++ b/specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerRequestExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "Removes the follower retention leases from the leader index.", + "method_request": "POST //_ccr/forget_follower", + "description": "The API method and path for this request: `POST //_ccr/forget_follower`.", + "type": "request", + "value": "{\n \"follower_cluster\" : \"\",\n \"follower_index\" : \"\",\n \"follower_index_uuid\" : \"\",\n \"leader_remote_cluster\" : \"\"\n}" +} \ No newline at end of file diff --git a/specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerResponseExample1.json b/specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerResponseExample1.json new file mode 100644 index 0000000000..8ad84424d1 --- /dev/null +++ b/specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response for removing the follower retention leases from the leader index.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"_shards\" : {\n \"total\" : 1,\n \"successful\" : 1,\n \"failed\" : 0,\n \"failures\" : [ ]\n }\n}" +} \ No newline at end of file diff --git a/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample1.json b/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample1.json new file mode 100644 index 0000000000..79ed357025 --- /dev/null +++ b/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "Creates an auto-follow pattern.", + "method_request": "PUT /_ccr/auto_follow/", + "description": "The API method and path for this request: `PUT /_ccr/auto_follow/`", + "type": "request", + "value": "{\n \"remote_cluster\" : \"\",\n \"leader_index_patterns\" :\n [\n \"\"\n ],\n \"leader_index_exclusion_patterns\":\n [\n \"\"\n ],\n \"follow_index_pattern\" : \"\"\n}" +} \ No newline at end of file diff --git a/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample2.json b/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample2.json new file mode 100644 index 0000000000..ce4550e243 --- /dev/null +++ b/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample2.json @@ -0,0 +1,7 @@ +{ + "summary": "Creates an auto-follow pattern named `my_auto_follow_pattern`.", + "method_request": "PUT /_ccr/auto_follow/my_auto_follow_pattern", + "description": "The API method and path for this request: `PUT /_ccr/auto_follow/my_auto_follow_pattern`.", + "type": "request", + "value": "{\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index_patterns\" :\n [\n \"leader_index*\"\n ],\n \"follow_index_pattern\" : \"{{leader_index}}-follower\",\n \"settings\": {\n \"index.number_of_replicas\": 0\n },\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" +} \ No newline at end of file diff --git a/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternResponseExample1.json b/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternResponseExample1.json new file mode 100644 index 0000000000..6ac19f22ca --- /dev/null +++ b/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response for creating an auto-follow pattern.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\" : true\n}" +} \ No newline at end of file diff --git a/specification/ccr/resume_follow/ccrApisFollowPostResumeFollowRequestExample2.json b/specification/ccr/resume_follow/ccrApisFollowPostResumeFollowRequestExample2.json new file mode 100644 index 0000000000..35ed782020 --- /dev/null +++ b/specification/ccr/resume_follow/ccrApisFollowPostResumeFollowRequestExample2.json @@ -0,0 +1,7 @@ +{ + "summary": "Resumes a follower index.", + "method_request": "POST /follower_index/_ccr/resume_follow", + "description": "The API method and path for this request: `POST /follower_index/_ccr/resume_follow`.", + "type": "request", + "value": "{\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" +} \ No newline at end of file diff --git a/specification/ccr/resume_follow/ccrApisFollowPostResumeFollowResponseExample1.json b/specification/ccr/resume_follow/ccrApisFollowPostResumeFollowResponseExample1.json new file mode 100644 index 0000000000..219724b346 --- /dev/null +++ b/specification/ccr/resume_follow/ccrApisFollowPostResumeFollowResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response for resuming a folower index.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\" : true\n}" +} \ No newline at end of file From 166b285ae7894bccad55937c96d60b437429d7fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Thu, 15 Aug 2024 14:34:35 +0200 Subject: [PATCH 2/5] Adds second batch of CCR examples. --- ...sAutoFollowDeleteAutoFollowPatternResponseExample1.json | 7 +++++++ .../ccrApisFollowGetFollowInfoResponseExample1.json | 7 +++++++ .../ccrApisFollowGetFollowInfoResponseExample2.json | 7 +++++++ .../ccrApisFollowGetFollowStatsResponseExample1.json | 7 +++++++ ...ApisAutoFollowGetAutoFollowPatternResponseExample1.json | 7 +++++++ ...isAutoFollowPauseAutoFollowPatternResponseExample1.json | 7 +++++++ .../ccrApisFollowPostPauseFollowResponseExample1.json | 7 +++++++ ...sAutoFollowResumeAutoFollowPatternResponseExample1.json | 7 +++++++ .../ccr/stats/ccrApisGetCcrStatsResponseExample1.json | 7 +++++++ .../ccrApisFollowPostUnfollowResponseExample1.json | 7 +++++++ 10 files changed, 70 insertions(+) create mode 100644 specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json create mode 100644 specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample1.json create mode 100644 specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample2.json create mode 100644 specification/ccr/follow_stats/ccrApisFollowGetFollowStatsResponseExample1.json create mode 100644 specification/ccr/get_auto_follow_pattern/ccrApisAutoFollowGetAutoFollowPatternResponseExample1.json create mode 100644 specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json create mode 100644 specification/ccr/pause_follow/ccrApisFollowPostPauseFollowResponseExample1.json create mode 100644 specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json create mode 100644 specification/ccr/stats/ccrApisGetCcrStatsResponseExample1.json create mode 100644 specification/ccr/unfollow/ccrApisFollowPostUnfollowResponseExample1.json diff --git a/specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json b/specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json new file mode 100644 index 0000000000..870fd6d3e7 --- /dev/null +++ b/specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful respons for deleting an auto-follow pattern.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\" : true\n}" +} \ No newline at end of file diff --git a/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample1.json b/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample1.json new file mode 100644 index 0000000000..2cb3a15ea5 --- /dev/null +++ b/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response for retrieving information about all follower indices", + "description": "This may be a response to `GET /follower_index/_ccr/info`.", + "type": "response", + "response_code": 200, + "value": "{\n \"follower_indices\": [\n {\n \"follower_index\": \"follower_index\",\n \"remote_cluster\": \"remote_cluster\",\n \"leader_index\": \"leader_index\",\n \"status\": \"active\",\n \"parameters\": {\n \"max_read_request_operation_count\": 5120,\n \"max_read_request_size\": \"32mb\",\n \"max_outstanding_read_requests\": 12,\n \"max_write_request_operation_count\": 5120,\n \"max_write_request_size\": \"9223372036854775807b\",\n \"max_outstanding_write_requests\": 9,\n \"max_write_buffer_count\": 2147483647,\n \"max_write_buffer_size\": \"512mb\",\n \"max_retry_delay\": \"500ms\",\n \"read_poll_timeout\": \"1m\"\n }\n }\n ]\n}" +} \ No newline at end of file diff --git a/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample2.json b/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample2.json new file mode 100644 index 0000000000..3881977ee2 --- /dev/null +++ b/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample2.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response for retrieving information about a paused follower index.", + "description": "", + "type": "response", + "response_code": "200", + "value": "{\n \"follower_indices\": [\n {\n \"follower_index\": \"follower_index\",\n \"remote_cluster\": \"remote_cluster\",\n \"leader_index\": \"leader_index\",\n \"status\": \"paused\"\n }\n ]\n}" +} \ No newline at end of file diff --git a/specification/ccr/follow_stats/ccrApisFollowGetFollowStatsResponseExample1.json b/specification/ccr/follow_stats/ccrApisFollowGetFollowStatsResponseExample1.json new file mode 100644 index 0000000000..b13efc6de6 --- /dev/null +++ b/specification/ccr/follow_stats/ccrApisFollowGetFollowStatsResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response for retrieving follower stats.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"indices\" : [\n {\n \"index\" : \"follower_index\",\n \"total_global_checkpoint_lag\" : 256,\n \"shards\" : [\n {\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"follower_index\" : \"follower_index\",\n \"shard_id\" : 0,\n \"leader_global_checkpoint\" : 1024,\n \"leader_max_seq_no\" : 1536,\n \"follower_global_checkpoint\" : 768,\n \"follower_max_seq_no\" : 896,\n \"last_requested_seq_no\" : 897,\n \"outstanding_read_requests\" : 8,\n \"outstanding_write_requests\" : 2,\n \"write_buffer_operation_count\" : 64,\n \"follower_mapping_version\" : 4,\n \"follower_settings_version\" : 2,\n \"follower_aliases_version\" : 8,\n \"total_read_time_millis\" : 32768,\n \"total_read_remote_exec_time_millis\" : 16384,\n \"successful_read_requests\" : 32,\n \"failed_read_requests\" : 0,\n \"operations_read\" : 896,\n \"bytes_read\" : 32768,\n \"total_write_time_millis\" : 16384,\n \"write_buffer_size_in_bytes\" : 1536,\n \"successful_write_requests\" : 16,\n \"failed_write_requests\" : 0,\n \"operations_written\" : 832,\n \"read_exceptions\" : [ ],\n \"time_since_last_read_millis\" : 8\n }\n ]\n }\n ]\n}" +} \ No newline at end of file diff --git a/specification/ccr/get_auto_follow_pattern/ccrApisAutoFollowGetAutoFollowPatternResponseExample1.json b/specification/ccr/get_auto_follow_pattern/ccrApisAutoFollowGetAutoFollowPatternResponseExample1.json new file mode 100644 index 0000000000..f17cf2afba --- /dev/null +++ b/specification/ccr/get_auto_follow_pattern/ccrApisAutoFollowGetAutoFollowPatternResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response for retrieving an auto-follow pattern.", + "description": "This may be a respons to `GET /_ccr/auto_follow/my_auto_follow_pattern`. ", + "type": "response", + "response_code": 200, + "value": "{\n \"patterns\": [\n {\n \"name\": \"my_auto_follow_pattern\",\n \"pattern\": {\n \"active\": true,\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index_patterns\" :\n [\n \"leader_index*\"\n ],\n \"leader_index_exclusion_patterns\":\n [\n \"leader_index_001\"\n ],\n \"follow_index_pattern\" : \"{{leader_index}}-follower\"\n }\n }\n ]\n}" +} \ No newline at end of file diff --git a/specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json b/specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json new file mode 100644 index 0000000000..11fe4ae380 --- /dev/null +++ b/specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful respons for pausing an auto-follow pattern.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\" : true\n}" +} \ No newline at end of file diff --git a/specification/ccr/pause_follow/ccrApisFollowPostPauseFollowResponseExample1.json b/specification/ccr/pause_follow/ccrApisFollowPostPauseFollowResponseExample1.json new file mode 100644 index 0000000000..5133828c16 --- /dev/null +++ b/specification/ccr/pause_follow/ccrApisFollowPostPauseFollowResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response for pausing a follower index.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\" : true\n}" +} \ No newline at end of file diff --git a/specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json b/specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json new file mode 100644 index 0000000000..8edc1894d4 --- /dev/null +++ b/specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful respons for resuming an auto-follow pattern.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\" : true\n}" +} \ No newline at end of file diff --git a/specification/ccr/stats/ccrApisGetCcrStatsResponseExample1.json b/specification/ccr/stats/ccrApisGetCcrStatsResponseExample1.json new file mode 100644 index 0000000000..6a42ecc0ee --- /dev/null +++ b/specification/ccr/stats/ccrApisGetCcrStatsResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response for retrieving cross-cluster replication stats.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"auto_follow_stats\" : {\n \"number_of_failed_follow_indices\" : 0,\n \"number_of_failed_remote_cluster_state_requests\" : 0,\n \"number_of_successful_follow_indices\" : 1,\n \"recent_auto_follow_errors\" : [],\n \"auto_followed_clusters\" : []\n },\n \"follow_stats\" : {\n \"indices\" : [\n {\n \"index\" : \"follower_index\",\n \"total_global_checkpoint_lag\" : 256,\n \"shards\" : [\n {\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"follower_index\" : \"follower_index\",\n \"shard_id\" : 0,\n \"leader_global_checkpoint\" : 1024,\n \"leader_max_seq_no\" : 1536,\n \"follower_global_checkpoint\" : 768,\n \"follower_max_seq_no\" : 896,\n \"last_requested_seq_no\" : 897,\n \"outstanding_read_requests\" : 8,\n \"outstanding_write_requests\" : 2,\n \"write_buffer_operation_count\" : 64,\n \"follower_mapping_version\" : 4,\n \"follower_settings_version\" : 2,\n \"follower_aliases_version\" : 8,\n \"total_read_time_millis\" : 32768,\n \"total_read_remote_exec_time_millis\" : 16384,\n \"successful_read_requests\" : 32,\n \"failed_read_requests\" : 0,\n \"operations_read\" : 896,\n \"bytes_read\" : 32768,\n \"total_write_time_millis\" : 16384,\n \"write_buffer_size_in_bytes\" : 1536,\n \"successful_write_requests\" : 16,\n \"failed_write_requests\" : 0,\n \"operations_written\" : 832,\n \"read_exceptions\" : [ ],\n \"time_since_last_read_millis\" : 8\n }\n ]\n }\n ]\n }\n}" +} \ No newline at end of file diff --git a/specification/ccr/unfollow/ccrApisFollowPostUnfollowResponseExample1.json b/specification/ccr/unfollow/ccrApisFollowPostUnfollowResponseExample1.json new file mode 100644 index 0000000000..b9d424a000 --- /dev/null +++ b/specification/ccr/unfollow/ccrApisFollowPostUnfollowResponseExample1.json @@ -0,0 +1,7 @@ +{ + "summary": "A successful response for converting a follower index to a regular index.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\" : true\n}" +} \ No newline at end of file From 29cdfc1ec71d2026bb55926b24838587ee09a972 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Thu, 15 Aug 2024 14:35:40 +0200 Subject: [PATCH 3/5] Fixes format. --- ...gApisDeleteAutoscalingPolicyResponseExample1.json | 12 ++++++------ ...ngApisGetAutoscalingCapacityResponseExample1.json | 12 ++++++------ ...lingApisGetAutoscalingPolicyResponseExample1.json | 12 ++++++------ ...alingApisPutAutoscalingPolicyRequestExample1.json | 12 ++++++------ ...alingApisPutAutoscalingPolicyRequestExample2.json | 12 ++++++------ ...lingApisPutAutoscalingPolicyResponseExample1.json | 12 ++++++------ ...ollowDeleteAutoFollowPatternResponseExample1.json | 12 ++++++------ .../ccrApisFollowPutFollowRequestExample1.json | 12 ++++++------ .../ccrApisFollowPutFollowRequestExample3.json | 12 ++++++------ .../ccrApisFollowPutFollowResponseExample1.json | 12 ++++++------ .../ccrApisFollowGetFollowInfoResponseExample1.json | 12 ++++++------ .../ccrApisFollowGetFollowInfoResponseExample2.json | 12 ++++++------ .../ccrApisFollowGetFollowStatsResponseExample1.json | 12 ++++++------ ...rApisFollowPostForgetFollowerRequestExample1.json | 12 ++++++------ ...ApisFollowPostForgetFollowerResponseExample1.json | 12 ++++++------ ...toFollowGetAutoFollowPatternResponseExample1.json | 12 ++++++------ ...FollowPauseAutoFollowPatternResponseExample1.json | 12 ++++++------ ...ccrApisFollowPostPauseFollowResponseExample1.json | 12 ++++++------ ...utoFollowPutAutoFollowPatternRequestExample1.json | 12 ++++++------ ...utoFollowPutAutoFollowPatternRequestExample2.json | 12 ++++++------ ...toFollowPutAutoFollowPatternResponseExample1.json | 12 ++++++------ ...ollowResumeAutoFollowPatternResponseExample1.json | 12 ++++++------ ...ccrApisFollowPostResumeFollowRequestExample2.json | 12 ++++++------ ...crApisFollowPostResumeFollowResponseExample1.json | 12 ++++++------ .../stats/ccrApisGetCcrStatsResponseExample1.json | 12 ++++++------ .../ccrApisFollowPostUnfollowResponseExample1.json | 12 ++++++------ 26 files changed, 156 insertions(+), 156 deletions(-) diff --git a/specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.json b/specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.json index 53c20289d8..38e84a9444 100644 --- a/specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.json +++ b/specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.json @@ -1,7 +1,7 @@ { - "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}" -} \ No newline at end of file + "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/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json b/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json index 0385208b87..a5b521af24 100644 --- a/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json +++ b/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful respons 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}" -} \ No newline at end of file + "summary": "A successful respons 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/autoscalingApisGetAutoscalingPolicyResponseExample1.json b/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json index 5e7ed20e26..36958fc8e6 100644 --- a/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json +++ b/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful respons 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}" -} \ No newline at end of file + "summary": "A successful respons 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/autoscalingApisPutAutoscalingPolicyRequestExample1.json b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.json index 9acbb7c837..64bd4cb34c 100644 --- a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.json +++ b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.json @@ -1,7 +1,7 @@ { - "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}" -} \ No newline at end of file + "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 index 2b0768aa5b..d2e5fdd403 100644 --- a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json +++ b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json @@ -1,7 +1,7 @@ { - "summary": "Creates an autoscaling policy named `my_autoscaling_policy` using the fixed autoscaling decider, applying to the set of nodes having (only) the `data_hot` role", - "method_request": "PUT /_autoscaling/policy/my_autoscaling_policy", - "description": "The API method and path for this request: `PUT /_autoscaling/policy/my_autoscaling_policy`", - "type": "request", - "value": "{\n \"roles\" : [ \"data_hot\" ],\n \"deciders\": {\n \"fixed\": {\n }\n }\n}" -} \ No newline at end of file + "summary": "Creates an autoscaling policy named `my_autoscaling_policy` using the fixed autoscaling decider, applying to the set of nodes having (only) the `data_hot` role", + "method_request": "PUT /_autoscaling/policy/my_autoscaling_policy", + "description": "The API method and path for this request: `PUT /_autoscaling/policy/my_autoscaling_policy`", + "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 index 20c915cbe3..5bcdde84b9 100644 --- a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.json +++ b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful response when creating an autoscaling policy.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\": true\n}" -} \ No newline at end of file + "summary": "A successful response when creating an autoscaling policy.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\": true\n}" +} diff --git a/specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json b/specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json index 870fd6d3e7..dec4a4bccd 100644 --- a/specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json +++ b/specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful respons for deleting an auto-follow pattern.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\" : true\n}" -} \ No newline at end of file + "summary": "A successful respons for deleting an auto-follow pattern.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\" : true\n}" +} diff --git a/specification/ccr/follow/ccrApisFollowPutFollowRequestExample1.json b/specification/ccr/follow/ccrApisFollowPutFollowRequestExample1.json index 7a76148282..7613b9f28d 100644 --- a/specification/ccr/follow/ccrApisFollowPutFollowRequestExample1.json +++ b/specification/ccr/follow/ccrApisFollowPutFollowRequestExample1.json @@ -1,7 +1,7 @@ { - "summary": "Creates a follower index.", - "method_request": "PUT //_ccr/follow?wait_for_active_shards=1", - "description": "The API method and path for this request: `PUT //_ccr/follow?wait_for_active_shards=1`.", - "type": "request", - "value": "{\n \"remote_cluster\" : \"\",\n \"leader_index\" : \"\"\n}" -} \ No newline at end of file + "summary": "Creates a follower index.", + "method_request": "PUT //_ccr/follow?wait_for_active_shards=1", + "description": "The API method and path for this request: `PUT //_ccr/follow?wait_for_active_shards=1`.", + "type": "request", + "value": "{\n \"remote_cluster\" : \"\",\n \"leader_index\" : \"\"\n}" +} diff --git a/specification/ccr/follow/ccrApisFollowPutFollowRequestExample3.json b/specification/ccr/follow/ccrApisFollowPutFollowRequestExample3.json index 97d574f268..8cac34f924 100644 --- a/specification/ccr/follow/ccrApisFollowPutFollowRequestExample3.json +++ b/specification/ccr/follow/ccrApisFollowPutFollowRequestExample3.json @@ -1,7 +1,7 @@ { - "summary": "Creates a follower index named `follower_index`.", - "method_request": "PUT /follower_index/_ccr/follow?wait_for_active_shards=1", - "description": "The API method and path for this reqest: `PUT /follower_index/_ccr/follow?wait_for_active_shards=1`.", - "type": "request", - "value": "{\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"settings\": {\n \"index.number_of_replicas\": 0\n },\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" -} \ No newline at end of file + "summary": "Creates a follower index named `follower_index`.", + "method_request": "PUT /follower_index/_ccr/follow?wait_for_active_shards=1", + "description": "The API method and path for this reqest: `PUT /follower_index/_ccr/follow?wait_for_active_shards=1`.", + "type": "request", + "value": "{\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"settings\": {\n \"index.number_of_replicas\": 0\n },\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" +} diff --git a/specification/ccr/follow/ccrApisFollowPutFollowResponseExample1.json b/specification/ccr/follow/ccrApisFollowPutFollowResponseExample1.json index 6ebcaef54f..06baeb34f4 100644 --- a/specification/ccr/follow/ccrApisFollowPutFollowResponseExample1.json +++ b/specification/ccr/follow/ccrApisFollowPutFollowResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful response for creating a follower index.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"follow_index_created\" : true,\n \"follow_index_shards_acked\" : true,\n \"index_following_started\" : true\n}" -} \ No newline at end of file + "summary": "A successful response for creating a follower index.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"follow_index_created\" : true,\n \"follow_index_shards_acked\" : true,\n \"index_following_started\" : true\n}" +} diff --git a/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample1.json b/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample1.json index 2cb3a15ea5..c7c4eb89d4 100644 --- a/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample1.json +++ b/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful response for retrieving information about all follower indices", - "description": "This may be a response to `GET /follower_index/_ccr/info`.", - "type": "response", - "response_code": 200, - "value": "{\n \"follower_indices\": [\n {\n \"follower_index\": \"follower_index\",\n \"remote_cluster\": \"remote_cluster\",\n \"leader_index\": \"leader_index\",\n \"status\": \"active\",\n \"parameters\": {\n \"max_read_request_operation_count\": 5120,\n \"max_read_request_size\": \"32mb\",\n \"max_outstanding_read_requests\": 12,\n \"max_write_request_operation_count\": 5120,\n \"max_write_request_size\": \"9223372036854775807b\",\n \"max_outstanding_write_requests\": 9,\n \"max_write_buffer_count\": 2147483647,\n \"max_write_buffer_size\": \"512mb\",\n \"max_retry_delay\": \"500ms\",\n \"read_poll_timeout\": \"1m\"\n }\n }\n ]\n}" -} \ No newline at end of file + "summary": "A successful response for retrieving information about all follower indices", + "description": "This may be a response to `GET /follower_index/_ccr/info`.", + "type": "response", + "response_code": 200, + "value": "{\n \"follower_indices\": [\n {\n \"follower_index\": \"follower_index\",\n \"remote_cluster\": \"remote_cluster\",\n \"leader_index\": \"leader_index\",\n \"status\": \"active\",\n \"parameters\": {\n \"max_read_request_operation_count\": 5120,\n \"max_read_request_size\": \"32mb\",\n \"max_outstanding_read_requests\": 12,\n \"max_write_request_operation_count\": 5120,\n \"max_write_request_size\": \"9223372036854775807b\",\n \"max_outstanding_write_requests\": 9,\n \"max_write_buffer_count\": 2147483647,\n \"max_write_buffer_size\": \"512mb\",\n \"max_retry_delay\": \"500ms\",\n \"read_poll_timeout\": \"1m\"\n }\n }\n ]\n}" +} diff --git a/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample2.json b/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample2.json index 3881977ee2..2be83319d2 100644 --- a/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample2.json +++ b/specification/ccr/follow_info/ccrApisFollowGetFollowInfoResponseExample2.json @@ -1,7 +1,7 @@ { - "summary": "A successful response for retrieving information about a paused follower index.", - "description": "", - "type": "response", - "response_code": "200", - "value": "{\n \"follower_indices\": [\n {\n \"follower_index\": \"follower_index\",\n \"remote_cluster\": \"remote_cluster\",\n \"leader_index\": \"leader_index\",\n \"status\": \"paused\"\n }\n ]\n}" -} \ No newline at end of file + "summary": "A successful response for retrieving information about a paused follower index.", + "description": "", + "type": "response", + "response_code": "200", + "value": "{\n \"follower_indices\": [\n {\n \"follower_index\": \"follower_index\",\n \"remote_cluster\": \"remote_cluster\",\n \"leader_index\": \"leader_index\",\n \"status\": \"paused\"\n }\n ]\n}" +} diff --git a/specification/ccr/follow_stats/ccrApisFollowGetFollowStatsResponseExample1.json b/specification/ccr/follow_stats/ccrApisFollowGetFollowStatsResponseExample1.json index b13efc6de6..84c2f738fe 100644 --- a/specification/ccr/follow_stats/ccrApisFollowGetFollowStatsResponseExample1.json +++ b/specification/ccr/follow_stats/ccrApisFollowGetFollowStatsResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful response for retrieving follower stats.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"indices\" : [\n {\n \"index\" : \"follower_index\",\n \"total_global_checkpoint_lag\" : 256,\n \"shards\" : [\n {\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"follower_index\" : \"follower_index\",\n \"shard_id\" : 0,\n \"leader_global_checkpoint\" : 1024,\n \"leader_max_seq_no\" : 1536,\n \"follower_global_checkpoint\" : 768,\n \"follower_max_seq_no\" : 896,\n \"last_requested_seq_no\" : 897,\n \"outstanding_read_requests\" : 8,\n \"outstanding_write_requests\" : 2,\n \"write_buffer_operation_count\" : 64,\n \"follower_mapping_version\" : 4,\n \"follower_settings_version\" : 2,\n \"follower_aliases_version\" : 8,\n \"total_read_time_millis\" : 32768,\n \"total_read_remote_exec_time_millis\" : 16384,\n \"successful_read_requests\" : 32,\n \"failed_read_requests\" : 0,\n \"operations_read\" : 896,\n \"bytes_read\" : 32768,\n \"total_write_time_millis\" : 16384,\n \"write_buffer_size_in_bytes\" : 1536,\n \"successful_write_requests\" : 16,\n \"failed_write_requests\" : 0,\n \"operations_written\" : 832,\n \"read_exceptions\" : [ ],\n \"time_since_last_read_millis\" : 8\n }\n ]\n }\n ]\n}" -} \ No newline at end of file + "summary": "A successful response for retrieving follower stats.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"indices\" : [\n {\n \"index\" : \"follower_index\",\n \"total_global_checkpoint_lag\" : 256,\n \"shards\" : [\n {\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"follower_index\" : \"follower_index\",\n \"shard_id\" : 0,\n \"leader_global_checkpoint\" : 1024,\n \"leader_max_seq_no\" : 1536,\n \"follower_global_checkpoint\" : 768,\n \"follower_max_seq_no\" : 896,\n \"last_requested_seq_no\" : 897,\n \"outstanding_read_requests\" : 8,\n \"outstanding_write_requests\" : 2,\n \"write_buffer_operation_count\" : 64,\n \"follower_mapping_version\" : 4,\n \"follower_settings_version\" : 2,\n \"follower_aliases_version\" : 8,\n \"total_read_time_millis\" : 32768,\n \"total_read_remote_exec_time_millis\" : 16384,\n \"successful_read_requests\" : 32,\n \"failed_read_requests\" : 0,\n \"operations_read\" : 896,\n \"bytes_read\" : 32768,\n \"total_write_time_millis\" : 16384,\n \"write_buffer_size_in_bytes\" : 1536,\n \"successful_write_requests\" : 16,\n \"failed_write_requests\" : 0,\n \"operations_written\" : 832,\n \"read_exceptions\" : [ ],\n \"time_since_last_read_millis\" : 8\n }\n ]\n }\n ]\n}" +} diff --git a/specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerRequestExample1.json b/specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerRequestExample1.json index d470724e91..cb0b853ff3 100644 --- a/specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerRequestExample1.json +++ b/specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerRequestExample1.json @@ -1,7 +1,7 @@ { - "summary": "Removes the follower retention leases from the leader index.", - "method_request": "POST //_ccr/forget_follower", - "description": "The API method and path for this request: `POST //_ccr/forget_follower`.", - "type": "request", - "value": "{\n \"follower_cluster\" : \"\",\n \"follower_index\" : \"\",\n \"follower_index_uuid\" : \"\",\n \"leader_remote_cluster\" : \"\"\n}" -} \ No newline at end of file + "summary": "Removes the follower retention leases from the leader index.", + "method_request": "POST //_ccr/forget_follower", + "description": "The API method and path for this request: `POST //_ccr/forget_follower`.", + "type": "request", + "value": "{\n \"follower_cluster\" : \"\",\n \"follower_index\" : \"\",\n \"follower_index_uuid\" : \"\",\n \"leader_remote_cluster\" : \"\"\n}" +} diff --git a/specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerResponseExample1.json b/specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerResponseExample1.json index 8ad84424d1..4c89f6b8f4 100644 --- a/specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerResponseExample1.json +++ b/specification/ccr/forget_follower/ccrApisFollowPostForgetFollowerResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful response for removing the follower retention leases from the leader index.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"_shards\" : {\n \"total\" : 1,\n \"successful\" : 1,\n \"failed\" : 0,\n \"failures\" : [ ]\n }\n}" -} \ No newline at end of file + "summary": "A successful response for removing the follower retention leases from the leader index.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"_shards\" : {\n \"total\" : 1,\n \"successful\" : 1,\n \"failed\" : 0,\n \"failures\" : [ ]\n }\n}" +} diff --git a/specification/ccr/get_auto_follow_pattern/ccrApisAutoFollowGetAutoFollowPatternResponseExample1.json b/specification/ccr/get_auto_follow_pattern/ccrApisAutoFollowGetAutoFollowPatternResponseExample1.json index f17cf2afba..a5c328bc55 100644 --- a/specification/ccr/get_auto_follow_pattern/ccrApisAutoFollowGetAutoFollowPatternResponseExample1.json +++ b/specification/ccr/get_auto_follow_pattern/ccrApisAutoFollowGetAutoFollowPatternResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful response for retrieving an auto-follow pattern.", - "description": "This may be a respons to `GET /_ccr/auto_follow/my_auto_follow_pattern`. ", - "type": "response", - "response_code": 200, - "value": "{\n \"patterns\": [\n {\n \"name\": \"my_auto_follow_pattern\",\n \"pattern\": {\n \"active\": true,\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index_patterns\" :\n [\n \"leader_index*\"\n ],\n \"leader_index_exclusion_patterns\":\n [\n \"leader_index_001\"\n ],\n \"follow_index_pattern\" : \"{{leader_index}}-follower\"\n }\n }\n ]\n}" -} \ No newline at end of file + "summary": "A successful response for retrieving an auto-follow pattern.", + "description": "This may be a respons to `GET /_ccr/auto_follow/my_auto_follow_pattern`. ", + "type": "response", + "response_code": 200, + "value": "{\n \"patterns\": [\n {\n \"name\": \"my_auto_follow_pattern\",\n \"pattern\": {\n \"active\": true,\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index_patterns\" :\n [\n \"leader_index*\"\n ],\n \"leader_index_exclusion_patterns\":\n [\n \"leader_index_001\"\n ],\n \"follow_index_pattern\" : \"{{leader_index}}-follower\"\n }\n }\n ]\n}" +} diff --git a/specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json b/specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json index 11fe4ae380..de02a404b5 100644 --- a/specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json +++ b/specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful respons for pausing an auto-follow pattern.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\" : true\n}" -} \ No newline at end of file + "summary": "A successful respons for pausing an auto-follow pattern.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\" : true\n}" +} diff --git a/specification/ccr/pause_follow/ccrApisFollowPostPauseFollowResponseExample1.json b/specification/ccr/pause_follow/ccrApisFollowPostPauseFollowResponseExample1.json index 5133828c16..7084ad5783 100644 --- a/specification/ccr/pause_follow/ccrApisFollowPostPauseFollowResponseExample1.json +++ b/specification/ccr/pause_follow/ccrApisFollowPostPauseFollowResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful response for pausing a follower index.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\" : true\n}" -} \ No newline at end of file + "summary": "A successful response for pausing a follower index.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\" : true\n}" +} diff --git a/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample1.json b/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample1.json index 79ed357025..80d58fa70e 100644 --- a/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample1.json +++ b/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample1.json @@ -1,7 +1,7 @@ { - "summary": "Creates an auto-follow pattern.", - "method_request": "PUT /_ccr/auto_follow/", - "description": "The API method and path for this request: `PUT /_ccr/auto_follow/`", - "type": "request", - "value": "{\n \"remote_cluster\" : \"\",\n \"leader_index_patterns\" :\n [\n \"\"\n ],\n \"leader_index_exclusion_patterns\":\n [\n \"\"\n ],\n \"follow_index_pattern\" : \"\"\n}" -} \ No newline at end of file + "summary": "Creates an auto-follow pattern.", + "method_request": "PUT /_ccr/auto_follow/", + "description": "The API method and path for this request: `PUT /_ccr/auto_follow/`", + "type": "request", + "value": "{\n \"remote_cluster\" : \"\",\n \"leader_index_patterns\" :\n [\n \"\"\n ],\n \"leader_index_exclusion_patterns\":\n [\n \"\"\n ],\n \"follow_index_pattern\" : \"\"\n}" +} diff --git a/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample2.json b/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample2.json index ce4550e243..68fb1674e0 100644 --- a/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample2.json +++ b/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternRequestExample2.json @@ -1,7 +1,7 @@ { - "summary": "Creates an auto-follow pattern named `my_auto_follow_pattern`.", - "method_request": "PUT /_ccr/auto_follow/my_auto_follow_pattern", - "description": "The API method and path for this request: `PUT /_ccr/auto_follow/my_auto_follow_pattern`.", - "type": "request", - "value": "{\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index_patterns\" :\n [\n \"leader_index*\"\n ],\n \"follow_index_pattern\" : \"{{leader_index}}-follower\",\n \"settings\": {\n \"index.number_of_replicas\": 0\n },\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" -} \ No newline at end of file + "summary": "Creates an auto-follow pattern named `my_auto_follow_pattern`.", + "method_request": "PUT /_ccr/auto_follow/my_auto_follow_pattern", + "description": "The API method and path for this request: `PUT /_ccr/auto_follow/my_auto_follow_pattern`.", + "type": "request", + "value": "{\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index_patterns\" :\n [\n \"leader_index*\"\n ],\n \"follow_index_pattern\" : \"{{leader_index}}-follower\",\n \"settings\": {\n \"index.number_of_replicas\": 0\n },\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" +} diff --git a/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternResponseExample1.json b/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternResponseExample1.json index 6ac19f22ca..f0acf3ed26 100644 --- a/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternResponseExample1.json +++ b/specification/ccr/put_auto_follow_pattern/ccrApisAutoFollowPutAutoFollowPatternResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful response for creating an auto-follow pattern.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\" : true\n}" -} \ No newline at end of file + "summary": "A successful response for creating an auto-follow pattern.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\" : true\n}" +} diff --git a/specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json b/specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json index 8edc1894d4..23da67cb8a 100644 --- a/specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json +++ b/specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful respons for resuming an auto-follow pattern.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\" : true\n}" -} \ No newline at end of file + "summary": "A successful respons for resuming an auto-follow pattern.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\" : true\n}" +} diff --git a/specification/ccr/resume_follow/ccrApisFollowPostResumeFollowRequestExample2.json b/specification/ccr/resume_follow/ccrApisFollowPostResumeFollowRequestExample2.json index 35ed782020..c883b4a27d 100644 --- a/specification/ccr/resume_follow/ccrApisFollowPostResumeFollowRequestExample2.json +++ b/specification/ccr/resume_follow/ccrApisFollowPostResumeFollowRequestExample2.json @@ -1,7 +1,7 @@ { - "summary": "Resumes a follower index.", - "method_request": "POST /follower_index/_ccr/resume_follow", - "description": "The API method and path for this request: `POST /follower_index/_ccr/resume_follow`.", - "type": "request", - "value": "{\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" -} \ No newline at end of file + "summary": "Resumes a follower index.", + "method_request": "POST /follower_index/_ccr/resume_follow", + "description": "The API method and path for this request: `POST /follower_index/_ccr/resume_follow`.", + "type": "request", + "value": "{\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" +} diff --git a/specification/ccr/resume_follow/ccrApisFollowPostResumeFollowResponseExample1.json b/specification/ccr/resume_follow/ccrApisFollowPostResumeFollowResponseExample1.json index 219724b346..b882c531b4 100644 --- a/specification/ccr/resume_follow/ccrApisFollowPostResumeFollowResponseExample1.json +++ b/specification/ccr/resume_follow/ccrApisFollowPostResumeFollowResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful response for resuming a folower index.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\" : true\n}" -} \ No newline at end of file + "summary": "A successful response for resuming a folower index.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\" : true\n}" +} diff --git a/specification/ccr/stats/ccrApisGetCcrStatsResponseExample1.json b/specification/ccr/stats/ccrApisGetCcrStatsResponseExample1.json index 6a42ecc0ee..92c423b739 100644 --- a/specification/ccr/stats/ccrApisGetCcrStatsResponseExample1.json +++ b/specification/ccr/stats/ccrApisGetCcrStatsResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful response for retrieving cross-cluster replication stats.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"auto_follow_stats\" : {\n \"number_of_failed_follow_indices\" : 0,\n \"number_of_failed_remote_cluster_state_requests\" : 0,\n \"number_of_successful_follow_indices\" : 1,\n \"recent_auto_follow_errors\" : [],\n \"auto_followed_clusters\" : []\n },\n \"follow_stats\" : {\n \"indices\" : [\n {\n \"index\" : \"follower_index\",\n \"total_global_checkpoint_lag\" : 256,\n \"shards\" : [\n {\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"follower_index\" : \"follower_index\",\n \"shard_id\" : 0,\n \"leader_global_checkpoint\" : 1024,\n \"leader_max_seq_no\" : 1536,\n \"follower_global_checkpoint\" : 768,\n \"follower_max_seq_no\" : 896,\n \"last_requested_seq_no\" : 897,\n \"outstanding_read_requests\" : 8,\n \"outstanding_write_requests\" : 2,\n \"write_buffer_operation_count\" : 64,\n \"follower_mapping_version\" : 4,\n \"follower_settings_version\" : 2,\n \"follower_aliases_version\" : 8,\n \"total_read_time_millis\" : 32768,\n \"total_read_remote_exec_time_millis\" : 16384,\n \"successful_read_requests\" : 32,\n \"failed_read_requests\" : 0,\n \"operations_read\" : 896,\n \"bytes_read\" : 32768,\n \"total_write_time_millis\" : 16384,\n \"write_buffer_size_in_bytes\" : 1536,\n \"successful_write_requests\" : 16,\n \"failed_write_requests\" : 0,\n \"operations_written\" : 832,\n \"read_exceptions\" : [ ],\n \"time_since_last_read_millis\" : 8\n }\n ]\n }\n ]\n }\n}" -} \ No newline at end of file + "summary": "A successful response for retrieving cross-cluster replication stats.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"auto_follow_stats\" : {\n \"number_of_failed_follow_indices\" : 0,\n \"number_of_failed_remote_cluster_state_requests\" : 0,\n \"number_of_successful_follow_indices\" : 1,\n \"recent_auto_follow_errors\" : [],\n \"auto_followed_clusters\" : []\n },\n \"follow_stats\" : {\n \"indices\" : [\n {\n \"index\" : \"follower_index\",\n \"total_global_checkpoint_lag\" : 256,\n \"shards\" : [\n {\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"follower_index\" : \"follower_index\",\n \"shard_id\" : 0,\n \"leader_global_checkpoint\" : 1024,\n \"leader_max_seq_no\" : 1536,\n \"follower_global_checkpoint\" : 768,\n \"follower_max_seq_no\" : 896,\n \"last_requested_seq_no\" : 897,\n \"outstanding_read_requests\" : 8,\n \"outstanding_write_requests\" : 2,\n \"write_buffer_operation_count\" : 64,\n \"follower_mapping_version\" : 4,\n \"follower_settings_version\" : 2,\n \"follower_aliases_version\" : 8,\n \"total_read_time_millis\" : 32768,\n \"total_read_remote_exec_time_millis\" : 16384,\n \"successful_read_requests\" : 32,\n \"failed_read_requests\" : 0,\n \"operations_read\" : 896,\n \"bytes_read\" : 32768,\n \"total_write_time_millis\" : 16384,\n \"write_buffer_size_in_bytes\" : 1536,\n \"successful_write_requests\" : 16,\n \"failed_write_requests\" : 0,\n \"operations_written\" : 832,\n \"read_exceptions\" : [ ],\n \"time_since_last_read_millis\" : 8\n }\n ]\n }\n ]\n }\n}" +} diff --git a/specification/ccr/unfollow/ccrApisFollowPostUnfollowResponseExample1.json b/specification/ccr/unfollow/ccrApisFollowPostUnfollowResponseExample1.json index b9d424a000..8fa74c6ccb 100644 --- a/specification/ccr/unfollow/ccrApisFollowPostUnfollowResponseExample1.json +++ b/specification/ccr/unfollow/ccrApisFollowPostUnfollowResponseExample1.json @@ -1,7 +1,7 @@ { - "summary": "A successful response for converting a follower index to a regular index.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"acknowledged\" : true\n}" -} \ No newline at end of file + "summary": "A successful response for converting a follower index to a regular index.", + "description": "", + "type": "response", + "response_code": 200, + "value": "{\n \"acknowledged\" : true\n}" +} From d8c8c11e75097737f42bb656bc2d9bd3013c0003 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Thu, 22 Aug 2024 11:56:37 +0200 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Lisa Cawley --- .../autoscalingApisGetAutoscalingCapacityResponseExample1.json | 2 +- .../autoscalingApisGetAutoscalingPolicyResponseExample1.json | 2 +- ...crApisAutoFollowDeleteAutoFollowPatternResponseExample1.json | 2 +- ...ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json | 2 +- ...crApisAutoFollowResumeAutoFollowPatternResponseExample1.json | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json b/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json index a5b521af24..04a9e9098f 100644 --- a/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json +++ b/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json @@ -1,5 +1,5 @@ { - "summary": "A successful respons for retrieving the current autoscaling capacity.", + "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, diff --git a/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json b/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json index 36958fc8e6..418325e902 100644 --- a/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json +++ b/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json @@ -1,5 +1,5 @@ { - "summary": "A successful respons for retrieving an autoscaling policy.", + "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, diff --git a/specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json b/specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json index dec4a4bccd..0a8bdfe88d 100644 --- a/specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json +++ b/specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json @@ -1,5 +1,5 @@ { - "summary": "A successful respons for deleting an auto-follow pattern.", + "summary": "A successful response for deleting an auto-follow pattern.", "description": "", "type": "response", "response_code": 200, diff --git a/specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json b/specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json index de02a404b5..05d29b79e8 100644 --- a/specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json +++ b/specification/ccr/pause_auto_follow_pattern/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json @@ -1,5 +1,5 @@ { - "summary": "A successful respons for pausing an auto-follow pattern.", + "summary": "A successful response for pausing an auto-follow pattern.", "description": "", "type": "response", "response_code": 200, diff --git a/specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json b/specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json index 23da67cb8a..118c48137c 100644 --- a/specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json +++ b/specification/ccr/resume_auto_follow_pattern/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json @@ -1,5 +1,5 @@ { - "summary": "A successful respons for resuming an auto-follow pattern.", + "summary": "A successful response for resuming an auto-follow pattern.", "description": "", "type": "response", "response_code": 200, From 26ea25070b7da9c44ce4122464027567762d26c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Thu, 22 Aug 2024 13:30:02 +0200 Subject: [PATCH 5/5] Update specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json --- .../autoscalingApisPutAutoscalingPolicyRequestExample2.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json index d2e5fdd403..3e64f1618d 100644 --- a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json +++ b/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json @@ -1,7 +1,7 @@ { - "summary": "Creates an autoscaling policy named `my_autoscaling_policy` using the fixed autoscaling decider, applying to the set of nodes having (only) the `data_hot` role", + "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`", + "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}" }