Skip to content

Commit 1a1e565

Browse files
lcawllcawl
committed
Add cat response examples
1 parent 97867a6 commit 1a1e565

File tree

8 files changed

+145
-0
lines changed

8 files changed

+145
-0
lines changed

‎docs/overlays/elasticsearch-shared-overlays.yaml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1351,3 +1351,54 @@ actions:
13511351
examples:
13521352
indicesRolloverResponseExample1:
13531353
$ref: "../../specification/indices/rollover/indicesRolloverResponseExample1.yaml"
1354+
## cat examples
1355+
- target: "$.components['responses']['cat.aliases#200']"
1356+
description: "Add example for cat aliases response"
1357+
update:
1358+
content:
1359+
text/plain:
1360+
schema:
1361+
type: string
1362+
examples:
1363+
catAliasesResponseExample1:
1364+
$ref: "../../specification/cat/aliases/CatAliasesResponseExample1.yaml"
1365+
- target: "$.components['responses']['cat.ml_datafeeds#200']"
1366+
description: "Add example for cat datafeeds response"
1367+
update:
1368+
content:
1369+
text/plain:
1370+
schema:
1371+
type: string
1372+
examples:
1373+
catDatafeedsResponseExample1:
1374+
$ref: "../../specification/cat/ml_datafeeds/CatDatafeedsResponseExample1.yaml"
1375+
- target: "$.components['responses']['cat.ml_data_frame_analytics#200']"
1376+
description: "Add example for cat data frame analytics response"
1377+
update:
1378+
content:
1379+
text/plain:
1380+
schema:
1381+
type: string
1382+
examples:
1383+
catDataFrameAnalyticsResponseExample1:
1384+
$ref: "../../specification/cat/ml_data_frame_analytics/CatDataFrameAnalyticsResponseExample1.yaml"
1385+
- target: "$.components['responses']['cat.ml_jobs#200']"
1386+
description: "Add example for cat anomaly detectors response"
1387+
update:
1388+
content:
1389+
text/plain:
1390+
schema:
1391+
type: string
1392+
examples:
1393+
catAnomalyDetectorsResponseExample1:
1394+
$ref: "../../specification/cat/ml_jobs/CatJobsResponseExample1.yaml"
1395+
- target: "$.components['responses']['cat.ml_trained_models#200']"
1396+
description: "Add example for cat trained models response"
1397+
update:
1398+
content:
1399+
text/plain:
1400+
schema:
1401+
type: string
1402+
examples:
1403+
catTrainedModelsResponseExample1:
1404+
$ref: "../../specification/cat/ml_trained_models/CatTrainedModelsResponseExample1.yaml"

‎specification/cat/aliases/CatAliasesResponseExample1.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# summary:
2+
description: A successful response from `GET _cat/aliases?v=true`. This response shows that `alias2` has configured a filter and `alias3` and `alias4` have routing configurations.
3+
# type: response
4+
# response_code:
5+
value: >
6+
alias index filter routing.index routing.search is_write_index
7+
8+
alias1 test1 - - - -
9+
10+
alias2 test1 * - - -
11+
12+
alias3 test1 - 1 1 -
13+
14+
alias4 test1 - 2 1,2 -

‎specification/cat/ml_data_frame_analytics/CatDataframeanalyticsResponseExample1.yaml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# summary:
2+
description: A successful response from `GET _cat/ml/data_frame/analytics?v=true`
3+
# type: response
4+
# response_code: ''
5+
value: >
6+
id create_time type state
7+
8+
classifier_job_1 2020-02-12T11:49:09.594Z classification stopped
9+
10+
classifier_job_2 2020-02-12T11:49:14.479Z classification stopped
11+
12+
classifier_job_3 2020-02-12T11:49:16.928Z classification stopped
13+
14+
classifier_job_4 2020-02-12T11:49:19.127Z classification stopped
15+
16+
classifier_job_5 2020-02-12T11:49:21.349Z classification stopped

‎specification/cat/ml_datafeeds/CatDatafeedsResponseExample1.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# summary:
2+
description: A successful response from `GET _cat/ml/datafeeds?v=true`.
3+
# type: response
4+
# response_code:
5+
value: >
6+
id state buckets.count search.count
7+
8+
datafeed-high_sum_total_sales stopped 743 7
9+
10+
datafeed-low_request_rate stopped 1457 3
11+
12+
datafeed-response_code_rates stopped 1460 18
13+
14+
datafeed-url_scanning stopped 1460 18

‎specification/cat/ml_jobs/CatJobsResponseExample1.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# summary: cat/anomaly-detectors.asciidoc:287
2+
description: A succesful response from `GET _cat/ml/anomaly_detectors?h=id,s,dpr,mb&v=true`
3+
# type: response
4+
# response_code: ''
5+
value: >
6+
id s dpr mb
7+
8+
high_sum_total_sales closed 14022 1.5mb
9+
10+
low_request_rate closed 1216 40.5kb
11+
12+
response_code_rates closed 28146 132.7kb
13+
14+
url_scanning closed 28146 501.6kb

‎specification/cat/ml_trained_models/CatTrainedModelsResponseExample1.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# summary: cat/trainedmodel.asciidoc:125
2+
description: A successful response from `GET _cat/ml/trained_models?h=c,o,l,ct,v&v=true`
3+
# type: response
4+
# response_code: ''
5+
value: >
6+
id created_by operations license create_time version
7+
8+
ddddd-1580216177138 _xpack 196 PLATINUM 2020-01-28T12:56:17.138Z
9+
8.0.0
10+
11+
flight-regress-1580215685537 _xpack 102 PLATINUM 2020-01-28T12:48:05.537Z
12+
8.0.0
13+
14+
lang_ident_model_1 _xpack 39629 BASIC 2019-12-05T12:28:34.594Z
15+
7.6.0

‎specification/cat/tasks/CatTasksResponseExample1.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
summary: cat/tasks.asciidoc:86
2+
description: ''
3+
type: response
4+
response_code: ''
5+
value:
6+
'action task_id parent_task_id type start_time timestamp
7+
running_time ip node
8+
9+
cluster:monitor/tasks/lists[n] oTUltX4IQMOUUVeiohTt8A:124 oTUltX4IQMOUUVeiohTt8A:123
10+
direct 1458585884904 01:48:24 44.1micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A
11+
12+
cluster:monitor/tasks/lists oTUltX4IQMOUUVeiohTt8A:123 - transport
13+
1458585884904 01:48:24 186.2micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A'

‎specification/cat/transforms/catTransformsResponseExample1.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
summary: cat/transforms.asciidoc:197
2+
description: ''
3+
type: response
4+
response_code: ''
5+
value:
6+
"[\n {\n \"id\" : \"ecommerce_transform\",\n \"state\" : \"started\"\
7+
,\n \"checkpoint\" : \"1\",\n \"documents_processed\" : \"705\",\n \"checkpoint_progress\"\
8+
\ : \"100.00\",\n \"changes_last_detection_time\" : null\n }\n]"

0 commit comments

Comments
 (0)