Skip to content

Commit fe02053

Browse files
committed
Add indices API request and response examples - add block to close.
1 parent 0f02e16 commit fe02053

File tree

4 files changed

+23
-0
lines changed

4 files changed

+23
-0
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
summary: A successful response for adding an index block to an index.
2+
description: ''
3+
type: response
4+
response_code: 200
5+
value: "{\n \"acknowledged\" : true,\n \"shards_acknowledged\" : true,\n \"indices\"\
6+
\ : [ {\n \"name\" : \"my-index-000001\",\n \"blocked\" : true\n } ]\n}"
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
summary: Perform analysis on a text string and returns the resulting tokens.
2+
method_request: GET /_analyze
3+
description: ''
4+
type: request
5+
value: "{\n \"analyzer\" : \"standard\",\n \"text\" : \"Quick Brown Foxes!\"\n}"
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
summary: Clone an existing index.
2+
method_request: POST /my_source_index/_clone/my_target_index
3+
description: 'The API accepts `settings` and `aliases` parameters for the target index.'
4+
type: request
5+
value: "{\n \"settings\": {\n \"index.number_of_shards\": 5\n },\n \"aliases\"\
6+
: {\n \"my_search_indices\": {}\n }\n}"
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
summary: A successful response for closing an index.
2+
description: ''
3+
type: response
4+
response_code: 200
5+
value: "{\n \"acknowledged\": true,\n \"shards_acknowledged\": true,\n \"indices\"\
6+
: {\n \"my-index-000001\": {\n \"closed\": true\n }\n }\n}"

0 commit comments

Comments
 (0)