From aa88cee10bfd34585bb0acb92361c4f070bba1e8 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 5 Jun 2018 14:34:32 -0700 Subject: [PATCH 1/7] [DOCS] Moves machine learning APIs to docs --- docs/build.gradle | 221 ++++++++++++++++++ .../ml/apis}/calendarresource.asciidoc | 1 + .../reference/ml/apis}/close-job.asciidoc | 1 + .../ml/apis}/datafeedresource.asciidoc | 1 + .../ml/apis}/delete-calendar-event.asciidoc | 1 + .../ml/apis}/delete-calendar-job.asciidoc | 1 + .../ml/apis}/delete-calendar.asciidoc | 1 + .../ml/apis}/delete-datafeed.asciidoc | 1 + .../reference/ml/apis}/delete-filter.asciidoc | 1 + .../reference/ml/apis}/delete-job.asciidoc | 1 + .../ml/apis}/delete-snapshot.asciidoc | 1 + .../reference/ml/apis}/eventresource.asciidoc | 1 + .../ml/apis}/filterresource.asciidoc | 1 + .../reference/ml/apis}/flush-job.asciidoc | 1 + .../reference/ml/apis}/forecast.asciidoc | 1 + .../reference/ml/apis}/get-bucket.asciidoc | 1 + .../ml/apis}/get-calendar-event.asciidoc | 1 + .../reference/ml/apis}/get-calendar.asciidoc | 1 + .../reference/ml/apis}/get-category.asciidoc | 1 + .../ml/apis}/get-datafeed-stats.asciidoc | 1 + .../reference/ml/apis}/get-datafeed.asciidoc | 1 + .../reference/ml/apis}/get-filter.asciidoc | 1 + .../ml/apis}/get-influencer.asciidoc | 1 + .../reference/ml/apis}/get-job-stats.asciidoc | 1 + .../reference/ml/apis}/get-job.asciidoc | 1 + .../ml/apis}/get-overall-buckets.asciidoc | 1 + .../reference/ml/apis}/get-record.asciidoc | 1 + .../reference/ml/apis}/get-snapshot.asciidoc | 1 + .../reference/ml/apis}/jobcounts.asciidoc | 1 + .../reference/ml/apis}/jobresource.asciidoc | 1 + .../reference/ml/apis}/ml-api.asciidoc | 82 +++---- .../reference/ml/apis}/open-job.asciidoc | 1 + .../ml/apis}/post-calendar-event.asciidoc | 1 + .../reference/ml/apis}/post-data.asciidoc | 1 + .../ml/apis}/preview-datafeed.asciidoc | 1 + .../ml/apis}/put-calendar-job.asciidoc | 1 + .../reference/ml/apis}/put-calendar.asciidoc | 1 + .../reference/ml/apis}/put-datafeed.asciidoc | 1 + .../reference/ml/apis}/put-filter.asciidoc | 1 + .../reference/ml/apis}/put-job.asciidoc | 1 + .../ml/apis}/resultsresource.asciidoc | 1 + .../ml/apis}/revert-snapshot.asciidoc | 1 + .../ml/apis}/snapshotresource.asciidoc | 1 + .../ml/apis}/start-datafeed.asciidoc | 1 + .../reference/ml/apis}/stop-datafeed.asciidoc | 1 + .../ml/apis}/update-datafeed.asciidoc | 1 + .../reference/ml/apis}/update-filter.asciidoc | 1 + .../reference/ml/apis}/update-job.asciidoc | 1 + .../ml/apis}/update-snapshot.asciidoc | 1 + .../ml/apis}/validate-detector.asciidoc | 1 + .../reference/ml/apis}/validate-job.asciidoc | 1 + docs/reference/redirects.asciidoc | 6 + .../reference}/rest-api/defs.asciidoc | 20 +- docs/reference/rest-api/index.asciidoc | 4 +- 54 files changed, 329 insertions(+), 53 deletions(-) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/calendarresource.asciidoc (94%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/close-job.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/datafeedresource.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/delete-calendar-event.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/delete-calendar-job.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/delete-calendar.asciidoc (97%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/delete-datafeed.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/delete-filter.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/delete-job.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/delete-snapshot.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/eventresource.asciidoc (97%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/filterresource.asciidoc (95%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/flush-job.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/forecast.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/get-bucket.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/get-calendar-event.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/get-calendar.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/get-category.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/get-datafeed-stats.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/get-datafeed.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/get-filter.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/get-influencer.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/get-job-stats.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/get-job.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/get-overall-buckets.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/get-record.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/get-snapshot.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/jobcounts.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/jobresource.asciidoc (99%) rename {x-pack/docs/en/rest-api => docs/reference/ml/apis}/ml-api.asciidoc (61%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/open-job.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/post-calendar-event.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/post-data.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/preview-datafeed.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/put-calendar-job.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/put-calendar.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/put-datafeed.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/put-filter.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/put-job.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/resultsresource.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/revert-snapshot.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/snapshotresource.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/start-datafeed.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/stop-datafeed.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/update-datafeed.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/update-filter.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/update-job.asciidoc (99%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/update-snapshot.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/validate-detector.asciidoc (98%) rename {x-pack/docs/en/rest-api/ml => docs/reference/ml/apis}/validate-job.asciidoc (98%) rename {x-pack/docs/en => docs/reference}/rest-api/defs.asciidoc (54%) diff --git a/docs/build.gradle b/docs/build.gradle index 88bccfef4a3e7..6a1f91ad2f65a 100644 --- a/docs/build.gradle +++ b/docs/build.gradle @@ -867,3 +867,224 @@ buildRestTests.setups['sensor_prefab_data'] = ''' {"node.terms.value":"c","temperature.sum.value":202.0,"temperature.max.value":202.0,"timestamp.date_histogram.time_zone":"UTC","temperature.min.value":202.0,"timestamp.date_histogram._count":1,"timestamp.date_histogram.interval":"1h","_rollup.computed":["temperature.sum","temperature.min","voltage.avg","temperature.max","node.terms","timestamp.date_histogram"],"voltage.avg.value":4.0,"node.terms._count":1,"_rollup.version":1,"timestamp.date_histogram.timestamp":1516294800000,"voltage.avg._count":1.0,"_rollup.id":"sensor"} ''' +buildRestTests.setups['sample_job'] = ''' + - do: + xpack.ml.put_job: + job_id: "sample_job" + body: > + { + "description" : "Very basic job", + "analysis_config" : { + "bucket_span":"10m", + "detectors" :[ + { + "function": "count" + } + ]}, + "data_description" : { + "time_field":"timestamp", + "time_format": "epoch_ms" + } + } +''' +buildRestTests.setups['farequote_index'] = ''' + - do: + indices.create: + index: farequote + body: + settings: + number_of_shards: 1 + number_of_replicas: 0 + mappings: + metric: + properties: + time: + type: date + responsetime: + type: float + airline: + type: keyword + doc_count: + type: integer +''' +buildRestTests.setups['farequote_data'] = buildRestTests.setups['farequote_index'] + ''' + - do: + bulk: + index: farequote + type: metric + refresh: true + body: | + {"index": {"_id":"1"}} + {"airline":"JZA","responsetime":990.4628,"time":"2016-02-07T00:00:00+0000", "doc_count": 5} + {"index": {"_id":"2"}} + {"airline":"JBU","responsetime":877.5927,"time":"2016-02-07T00:00:00+0000", "doc_count": 23} + {"index": {"_id":"3"}} + {"airline":"KLM","responsetime":1355.4812,"time":"2016-02-07T00:00:00+0000", "doc_count": 42} +''' +buildRestTests.setups['farequote_job'] = buildRestTests.setups['farequote_data'] + ''' + - do: + xpack.ml.put_job: + job_id: "farequote" + body: > + { + "analysis_config": { + "bucket_span": "60m", + "detectors": [{ + "function": "mean", + "field_name": "responsetime", + "by_field_name": "airline" + }], + "summary_count_field_name": "doc_count" + }, + "data_description": { + "time_field": "time" + } + } +''' +buildRestTests.setups['farequote_datafeed'] = buildRestTests.setups['farequote_job'] + ''' + - do: + xpack.ml.put_datafeed: + datafeed_id: "datafeed-farequote" + body: > + { + "job_id":"farequote", + "indexes":"farequote" + } +''' +buildRestTests.setups['server_metrics_index'] = ''' + - do: + indices.create: + index: server-metrics + body: + settings: + number_of_shards: 1 + number_of_replicas: 0 + mappings: + metric: + properties: + timestamp: + type: date + total: + type: long +''' +buildRestTests.setups['server_metrics_data'] = buildRestTests.setups['server_metrics_index'] + ''' + - do: + bulk: + index: server-metrics + type: metric + refresh: true + body: | + {"index": {"_id":"1177"}} + {"timestamp":"2017-03-23T13:00:00","total":40476} + {"index": {"_id":"1178"}} + {"timestamp":"2017-03-23T13:00:00","total":15287} + {"index": {"_id":"1179"}} + {"timestamp":"2017-03-23T13:00:00","total":-776} + {"index": {"_id":"1180"}} + {"timestamp":"2017-03-23T13:00:00","total":11366} + {"index": {"_id":"1181"}} + {"timestamp":"2017-03-23T13:00:00","total":3606} + {"index": {"_id":"1182"}} + {"timestamp":"2017-03-23T13:00:00","total":19006} + {"index": {"_id":"1183"}} + {"timestamp":"2017-03-23T13:00:00","total":38613} + {"index": {"_id":"1184"}} + {"timestamp":"2017-03-23T13:00:00","total":19516} + {"index": {"_id":"1185"}} + {"timestamp":"2017-03-23T13:00:00","total":-258} + {"index": {"_id":"1186"}} + {"timestamp":"2017-03-23T13:00:00","total":9551} + {"index": {"_id":"1187"}} + {"timestamp":"2017-03-23T13:00:00","total":11217} + {"index": {"_id":"1188"}} + {"timestamp":"2017-03-23T13:00:00","total":22557} + {"index": {"_id":"1189"}} + {"timestamp":"2017-03-23T13:00:00","total":40508} + {"index": {"_id":"1190"}} + {"timestamp":"2017-03-23T13:00:00","total":11887} + {"index": {"_id":"1191"}} + {"timestamp":"2017-03-23T13:00:00","total":31659} +''' +buildRestTests.setups['server_metrics_job'] = buildRestTests.setups['server_metrics_data'] + ''' + - do: + xpack.ml.put_job: + job_id: "total-requests" + body: > + { + "description" : "Total sum of requests", + "analysis_config" : { + "bucket_span":"10m", + "detectors" :[ + { + "detector_description": "Sum of total", + "function": "sum", + "field_name": "total" + } + ]}, + "data_description" : { + "time_field":"timestamp", + "time_format": "epoch_ms" + } + } +''' +buildRestTests.setups['server_metrics_datafeed'] = buildRestTests.setups['server_metrics_job'] + ''' + - do: + xpack.ml.put_datafeed: + datafeed_id: "datafeed-total-requests" + body: > + { + "job_id":"total-requests", + "indexes":"server-metrics" + } +''' +buildRestTests.setups['server_metrics_openjob'] = buildRestTests.setups['server_metrics_datafeed'] + ''' + - do: + xpack.ml.open_job: + job_id: "total-requests" +''' +buildRestTests.setups['server_metrics_startdf'] = buildRestTests.setups['server_metrics_openjob'] + ''' + - do: + xpack.ml.start_datafeed: + datafeed_id: "datafeed-total-requests" +''' +buildRestTests.setups['calendar_outages'] = ''' + - do: + xpack.ml.put_calendar: + calendar_id: "planned-outages" +''' +buildRestTests.setups['calendar_outages_addevent'] = buildRestTests.setups['calendar_outages'] + ''' + - do: + xpack.ml.post_calendar_events: + calendar_id: "planned-outages" + body: > + { "description": "event 1", "start_time": "2017-12-01T00:00:00Z", "end_time": "2017-12-02T00:00:00Z", "calendar_id": "planned-outages" } + + +''' +buildRestTests.setups['calendar_outages_openjob'] = buildRestTests.setups['server_metrics_openjob'] + ''' + - do: + xpack.ml.put_calendar: + calendar_id: "planned-outages" +''' +buildRestTests.setups['calendar_outages_addjob'] = buildRestTests.setups['server_metrics_openjob'] + ''' + - do: + xpack.ml.put_calendar: + calendar_id: "planned-outages" + body: > + { + "job_ids": ["total-requests"] + } +''' +buildRestTests.setups['calendar_outages_addevent'] = buildRestTests.setups['calendar_outages_addjob'] + ''' + - do: + xpack.ml.post_calendar_events: + calendar_id: "planned-outages" + body: > + { "events" : [ + { "description": "event 1", "start_time": "1513641600000", "end_time": "1513728000000"}, + { "description": "event 2", "start_time": "1513814400000", "end_time": "1513900800000"}, + { "description": "event 3", "start_time": "1514160000000", "end_time": "1514246400000"} + ]} +''' + + diff --git a/x-pack/docs/en/rest-api/ml/calendarresource.asciidoc b/docs/reference/ml/apis/calendarresource.asciidoc similarity index 94% rename from x-pack/docs/en/rest-api/ml/calendarresource.asciidoc rename to docs/reference/ml/apis/calendarresource.asciidoc index 8edb43ed7a393..4279102cd35fc 100644 --- a/x-pack/docs/en/rest-api/ml/calendarresource.asciidoc +++ b/docs/reference/ml/apis/calendarresource.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-calendar-resource]] === Calendar Resources diff --git a/x-pack/docs/en/rest-api/ml/close-job.asciidoc b/docs/reference/ml/apis/close-job.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/close-job.asciidoc rename to docs/reference/ml/apis/close-job.asciidoc index 8e7e8eb0ce850..25c6804364c32 100644 --- a/x-pack/docs/en/rest-api/ml/close-job.asciidoc +++ b/docs/reference/ml/apis/close-job.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-close-job]] === Close Jobs API ++++ diff --git a/x-pack/docs/en/rest-api/ml/datafeedresource.asciidoc b/docs/reference/ml/apis/datafeedresource.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/datafeedresource.asciidoc rename to docs/reference/ml/apis/datafeedresource.asciidoc index 0ffeb6bc89d72..6fe0b35d95185 100644 --- a/x-pack/docs/en/rest-api/ml/datafeedresource.asciidoc +++ b/docs/reference/ml/apis/datafeedresource.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-datafeed-resource]] === {dfeed-cap} Resources diff --git a/x-pack/docs/en/rest-api/ml/delete-calendar-event.asciidoc b/docs/reference/ml/apis/delete-calendar-event.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/delete-calendar-event.asciidoc rename to docs/reference/ml/apis/delete-calendar-event.asciidoc index ef8dad39dba70..b583a08d4d4b9 100644 --- a/x-pack/docs/en/rest-api/ml/delete-calendar-event.asciidoc +++ b/docs/reference/ml/apis/delete-calendar-event.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-delete-calendar-event]] === Delete Events from Calendar API ++++ diff --git a/x-pack/docs/en/rest-api/ml/delete-calendar-job.asciidoc b/docs/reference/ml/apis/delete-calendar-job.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/delete-calendar-job.asciidoc rename to docs/reference/ml/apis/delete-calendar-job.asciidoc index 94388c0c4b680..b2dbb77fd88e6 100644 --- a/x-pack/docs/en/rest-api/ml/delete-calendar-job.asciidoc +++ b/docs/reference/ml/apis/delete-calendar-job.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-delete-calendar-job]] === Delete Jobs from Calendar API ++++ diff --git a/x-pack/docs/en/rest-api/ml/delete-calendar.asciidoc b/docs/reference/ml/apis/delete-calendar.asciidoc similarity index 97% rename from x-pack/docs/en/rest-api/ml/delete-calendar.asciidoc rename to docs/reference/ml/apis/delete-calendar.asciidoc index f7673b545748b..e0cfeb7eebb6f 100644 --- a/x-pack/docs/en/rest-api/ml/delete-calendar.asciidoc +++ b/docs/reference/ml/apis/delete-calendar.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-delete-calendar]] === Delete Calendar API ++++ diff --git a/x-pack/docs/en/rest-api/ml/delete-datafeed.asciidoc b/docs/reference/ml/apis/delete-datafeed.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/delete-datafeed.asciidoc rename to docs/reference/ml/apis/delete-datafeed.asciidoc index db4fd5c177aed..e38060430e90e 100644 --- a/x-pack/docs/en/rest-api/ml/delete-datafeed.asciidoc +++ b/docs/reference/ml/apis/delete-datafeed.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-delete-datafeed]] === Delete {dfeeds-cap} API ++++ diff --git a/x-pack/docs/en/rest-api/ml/delete-filter.asciidoc b/docs/reference/ml/apis/delete-filter.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/delete-filter.asciidoc rename to docs/reference/ml/apis/delete-filter.asciidoc index b58d2980b888a..55638e42ef8f8 100644 --- a/x-pack/docs/en/rest-api/ml/delete-filter.asciidoc +++ b/docs/reference/ml/apis/delete-filter.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-delete-filter]] === Delete Filter API ++++ diff --git a/x-pack/docs/en/rest-api/ml/delete-job.asciidoc b/docs/reference/ml/apis/delete-job.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/delete-job.asciidoc rename to docs/reference/ml/apis/delete-job.asciidoc index c01b08545b638..98e224dfd5889 100644 --- a/x-pack/docs/en/rest-api/ml/delete-job.asciidoc +++ b/docs/reference/ml/apis/delete-job.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-delete-job]] === Delete Jobs API ++++ diff --git a/x-pack/docs/en/rest-api/ml/delete-snapshot.asciidoc b/docs/reference/ml/apis/delete-snapshot.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/delete-snapshot.asciidoc rename to docs/reference/ml/apis/delete-snapshot.asciidoc index 2ab0116fe74d9..399db26b3fe5e 100644 --- a/x-pack/docs/en/rest-api/ml/delete-snapshot.asciidoc +++ b/docs/reference/ml/apis/delete-snapshot.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-delete-snapshot]] === Delete Model Snapshots API ++++ diff --git a/x-pack/docs/en/rest-api/ml/eventresource.asciidoc b/docs/reference/ml/apis/eventresource.asciidoc similarity index 97% rename from x-pack/docs/en/rest-api/ml/eventresource.asciidoc rename to docs/reference/ml/apis/eventresource.asciidoc index c9ab78964213e..a1e96f5c25a0a 100644 --- a/x-pack/docs/en/rest-api/ml/eventresource.asciidoc +++ b/docs/reference/ml/apis/eventresource.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-event-resource]] === Scheduled Event Resources diff --git a/x-pack/docs/en/rest-api/ml/filterresource.asciidoc b/docs/reference/ml/apis/filterresource.asciidoc similarity index 95% rename from x-pack/docs/en/rest-api/ml/filterresource.asciidoc rename to docs/reference/ml/apis/filterresource.asciidoc index e942447c1ee60..e67c92dc8d096 100644 --- a/x-pack/docs/en/rest-api/ml/filterresource.asciidoc +++ b/docs/reference/ml/apis/filterresource.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-filter-resource]] === Filter Resources diff --git a/x-pack/docs/en/rest-api/ml/flush-job.asciidoc b/docs/reference/ml/apis/flush-job.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/flush-job.asciidoc rename to docs/reference/ml/apis/flush-job.asciidoc index 934a2d81b1778..0e16601f13f24 100644 --- a/x-pack/docs/en/rest-api/ml/flush-job.asciidoc +++ b/docs/reference/ml/apis/flush-job.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-flush-job]] === Flush Jobs API ++++ diff --git a/x-pack/docs/en/rest-api/ml/forecast.asciidoc b/docs/reference/ml/apis/forecast.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/forecast.asciidoc rename to docs/reference/ml/apis/forecast.asciidoc index 99647ecae1b25..197876f3f04a7 100644 --- a/x-pack/docs/en/rest-api/ml/forecast.asciidoc +++ b/docs/reference/ml/apis/forecast.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-forecast]] === Forecast Jobs API ++++ diff --git a/x-pack/docs/en/rest-api/ml/get-bucket.asciidoc b/docs/reference/ml/apis/get-bucket.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/get-bucket.asciidoc rename to docs/reference/ml/apis/get-bucket.asciidoc index 95b05ff7f5dd2..758dcd3b87ba5 100644 --- a/x-pack/docs/en/rest-api/ml/get-bucket.asciidoc +++ b/docs/reference/ml/apis/get-bucket.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-get-bucket]] === Get Buckets API ++++ diff --git a/x-pack/docs/en/rest-api/ml/get-calendar-event.asciidoc b/docs/reference/ml/apis/get-calendar-event.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/get-calendar-event.asciidoc rename to docs/reference/ml/apis/get-calendar-event.asciidoc index e89173c3382d9..51bc69637d983 100644 --- a/x-pack/docs/en/rest-api/ml/get-calendar-event.asciidoc +++ b/docs/reference/ml/apis/get-calendar-event.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-get-calendar-event]] === Get Scheduled Events API ++++ diff --git a/x-pack/docs/en/rest-api/ml/get-calendar.asciidoc b/docs/reference/ml/apis/get-calendar.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/get-calendar.asciidoc rename to docs/reference/ml/apis/get-calendar.asciidoc index ae95fd9968893..0bf37b4ed1af6 100644 --- a/x-pack/docs/en/rest-api/ml/get-calendar.asciidoc +++ b/docs/reference/ml/apis/get-calendar.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-get-calendar]] === Get Calendars API ++++ diff --git a/x-pack/docs/en/rest-api/ml/get-category.asciidoc b/docs/reference/ml/apis/get-category.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/get-category.asciidoc rename to docs/reference/ml/apis/get-category.asciidoc index 13f274133c0d1..6edbac856a58f 100644 --- a/x-pack/docs/en/rest-api/ml/get-category.asciidoc +++ b/docs/reference/ml/apis/get-category.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-get-category]] === Get Categories API ++++ diff --git a/x-pack/docs/en/rest-api/ml/get-datafeed-stats.asciidoc b/docs/reference/ml/apis/get-datafeed-stats.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/get-datafeed-stats.asciidoc rename to docs/reference/ml/apis/get-datafeed-stats.asciidoc index 2869e8222f86f..2f3d9aeeea70a 100644 --- a/x-pack/docs/en/rest-api/ml/get-datafeed-stats.asciidoc +++ b/docs/reference/ml/apis/get-datafeed-stats.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-get-datafeed-stats]] === Get {dfeed-cap} Statistics API ++++ diff --git a/x-pack/docs/en/rest-api/ml/get-datafeed.asciidoc b/docs/reference/ml/apis/get-datafeed.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/get-datafeed.asciidoc rename to docs/reference/ml/apis/get-datafeed.asciidoc index 0fa51773fd162..cc6b9fe7fdb63 100644 --- a/x-pack/docs/en/rest-api/ml/get-datafeed.asciidoc +++ b/docs/reference/ml/apis/get-datafeed.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-get-datafeed]] === Get {dfeeds-cap} API ++++ diff --git a/x-pack/docs/en/rest-api/ml/get-filter.asciidoc b/docs/reference/ml/apis/get-filter.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/get-filter.asciidoc rename to docs/reference/ml/apis/get-filter.asciidoc index b4699e9d622cf..94c27245bb86b 100644 --- a/x-pack/docs/en/rest-api/ml/get-filter.asciidoc +++ b/docs/reference/ml/apis/get-filter.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-get-filter]] === Get Filters API ++++ diff --git a/x-pack/docs/en/rest-api/ml/get-influencer.asciidoc b/docs/reference/ml/apis/get-influencer.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/get-influencer.asciidoc rename to docs/reference/ml/apis/get-influencer.asciidoc index bffd2b8e09633..182cca7aa9917 100644 --- a/x-pack/docs/en/rest-api/ml/get-influencer.asciidoc +++ b/docs/reference/ml/apis/get-influencer.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-get-influencer]] === Get Influencers API ++++ diff --git a/x-pack/docs/en/rest-api/ml/get-job-stats.asciidoc b/docs/reference/ml/apis/get-job-stats.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/get-job-stats.asciidoc rename to docs/reference/ml/apis/get-job-stats.asciidoc index bd59ee8b258fa..509d9448a693e 100644 --- a/x-pack/docs/en/rest-api/ml/get-job-stats.asciidoc +++ b/docs/reference/ml/apis/get-job-stats.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-get-job-stats]] === Get Job Statistics API ++++ diff --git a/x-pack/docs/en/rest-api/ml/get-job.asciidoc b/docs/reference/ml/apis/get-job.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/get-job.asciidoc rename to docs/reference/ml/apis/get-job.asciidoc index 2e95d8e01bbb7..9b695bc802b3c 100644 --- a/x-pack/docs/en/rest-api/ml/get-job.asciidoc +++ b/docs/reference/ml/apis/get-job.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-get-job]] === Get Jobs API ++++ diff --git a/x-pack/docs/en/rest-api/ml/get-overall-buckets.asciidoc b/docs/reference/ml/apis/get-overall-buckets.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/get-overall-buckets.asciidoc rename to docs/reference/ml/apis/get-overall-buckets.asciidoc index f2581f4904e37..1a767ea3eef36 100644 --- a/x-pack/docs/en/rest-api/ml/get-overall-buckets.asciidoc +++ b/docs/reference/ml/apis/get-overall-buckets.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-get-overall-buckets]] === Get Overall Buckets API ++++ diff --git a/x-pack/docs/en/rest-api/ml/get-record.asciidoc b/docs/reference/ml/apis/get-record.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/get-record.asciidoc rename to docs/reference/ml/apis/get-record.asciidoc index 1870b44159760..199cce1548427 100644 --- a/x-pack/docs/en/rest-api/ml/get-record.asciidoc +++ b/docs/reference/ml/apis/get-record.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-get-record]] === Get Records API ++++ diff --git a/x-pack/docs/en/rest-api/ml/get-snapshot.asciidoc b/docs/reference/ml/apis/get-snapshot.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/get-snapshot.asciidoc rename to docs/reference/ml/apis/get-snapshot.asciidoc index 24e82af1f199f..e194d944b636c 100644 --- a/x-pack/docs/en/rest-api/ml/get-snapshot.asciidoc +++ b/docs/reference/ml/apis/get-snapshot.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-get-snapshot]] === Get Model Snapshots API ++++ diff --git a/x-pack/docs/en/rest-api/ml/jobcounts.asciidoc b/docs/reference/ml/apis/jobcounts.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/jobcounts.asciidoc rename to docs/reference/ml/apis/jobcounts.asciidoc index d343cc23ae0ad..d0169e228d549 100644 --- a/x-pack/docs/en/rest-api/ml/jobcounts.asciidoc +++ b/docs/reference/ml/apis/jobcounts.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-jobstats]] === Job Statistics diff --git a/x-pack/docs/en/rest-api/ml/jobresource.asciidoc b/docs/reference/ml/apis/jobresource.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/jobresource.asciidoc rename to docs/reference/ml/apis/jobresource.asciidoc index 5b109b1c21d78..e0c314724e762 100644 --- a/x-pack/docs/en/rest-api/ml/jobresource.asciidoc +++ b/docs/reference/ml/apis/jobresource.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-job-resource]] === Job Resources diff --git a/x-pack/docs/en/rest-api/ml-api.asciidoc b/docs/reference/ml/apis/ml-api.asciidoc similarity index 61% rename from x-pack/docs/en/rest-api/ml-api.asciidoc rename to docs/reference/ml/apis/ml-api.asciidoc index b48e9f934042d..5a5f0a0bc0795 100644 --- a/x-pack/docs/en/rest-api/ml-api.asciidoc +++ b/docs/reference/ml/apis/ml-api.asciidoc @@ -70,57 +70,57 @@ machine learning APIs and in advanced job configuration options in Kibana. * <> //ADD -include::ml/post-calendar-event.asciidoc[] -include::ml/put-calendar-job.asciidoc[] +include::post-calendar-event.asciidoc[] +include::put-calendar-job.asciidoc[] //CLOSE -include::ml/close-job.asciidoc[] +include::close-job.asciidoc[] //CREATE -include::ml/put-calendar.asciidoc[] -include::ml/put-datafeed.asciidoc[] -include::ml/put-filter.asciidoc[] -include::ml/put-job.asciidoc[] +include::put-calendar.asciidoc[] +include::put-datafeed.asciidoc[] +include::put-filter.asciidoc[] +include::put-job.asciidoc[] //DELETE -include::ml/delete-calendar.asciidoc[] -include::ml/delete-datafeed.asciidoc[] -include::ml/delete-calendar-event.asciidoc[] -include::ml/delete-filter.asciidoc[] -include::ml/delete-job.asciidoc[] -include::ml/delete-calendar-job.asciidoc[] -include::ml/delete-snapshot.asciidoc[] +include::delete-calendar.asciidoc[] +include::delete-datafeed.asciidoc[] +include::delete-calendar-event.asciidoc[] +include::delete-filter.asciidoc[] +include::delete-job.asciidoc[] +include::delete-calendar-job.asciidoc[] +include::delete-snapshot.asciidoc[] //FLUSH -include::ml/flush-job.asciidoc[] +include::flush-job.asciidoc[] //FORECAST -include::ml/forecast.asciidoc[] +include::forecast.asciidoc[] //GET -include::ml/get-calendar.asciidoc[] -include::ml/get-bucket.asciidoc[] -include::ml/get-overall-buckets.asciidoc[] -include::ml/get-category.asciidoc[] -include::ml/get-datafeed.asciidoc[] -include::ml/get-datafeed-stats.asciidoc[] -include::ml/get-influencer.asciidoc[] -include::ml/get-job.asciidoc[] -include::ml/get-job-stats.asciidoc[] -include::ml/get-snapshot.asciidoc[] -include::ml/get-calendar-event.asciidoc[] -include::ml/get-filter.asciidoc[] -include::ml/get-record.asciidoc[] +include::get-calendar.asciidoc[] +include::get-bucket.asciidoc[] +include::get-overall-buckets.asciidoc[] +include::get-category.asciidoc[] +include::get-datafeed.asciidoc[] +include::get-datafeed-stats.asciidoc[] +include::get-influencer.asciidoc[] +include::get-job.asciidoc[] +include::get-job-stats.asciidoc[] +include::get-snapshot.asciidoc[] +include::get-calendar-event.asciidoc[] +include::get-filter.asciidoc[] +include::get-record.asciidoc[] //OPEN -include::ml/open-job.asciidoc[] +include::open-job.asciidoc[] //POST -include::ml/post-data.asciidoc[] +include::post-data.asciidoc[] //PREVIEW -include::ml/preview-datafeed.asciidoc[] +include::preview-datafeed.asciidoc[] //REVERT -include::ml/revert-snapshot.asciidoc[] +include::revert-snapshot.asciidoc[] //START/STOP -include::ml/start-datafeed.asciidoc[] -include::ml/stop-datafeed.asciidoc[] +include::start-datafeed.asciidoc[] +include::stop-datafeed.asciidoc[] //UPDATE -include::ml/update-datafeed.asciidoc[] -include::ml/update-filter.asciidoc[] -include::ml/update-job.asciidoc[] -include::ml/update-snapshot.asciidoc[] +include::update-datafeed.asciidoc[] +include::update-filter.asciidoc[] +include::update-job.asciidoc[] +include::update-snapshot.asciidoc[] //VALIDATE -//include::ml/validate-detector.asciidoc[] -//include::ml/validate-job.asciidoc[] +//include::validate-detector.asciidoc[] +//include::validate-job.asciidoc[] diff --git a/x-pack/docs/en/rest-api/ml/open-job.asciidoc b/docs/reference/ml/apis/open-job.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/open-job.asciidoc rename to docs/reference/ml/apis/open-job.asciidoc index 59d5568ac775a..4126914dfad09 100644 --- a/x-pack/docs/en/rest-api/ml/open-job.asciidoc +++ b/docs/reference/ml/apis/open-job.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-open-job]] === Open Jobs API ++++ diff --git a/x-pack/docs/en/rest-api/ml/post-calendar-event.asciidoc b/docs/reference/ml/apis/post-calendar-event.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/post-calendar-event.asciidoc rename to docs/reference/ml/apis/post-calendar-event.asciidoc index 41af0841d2e83..22a78a1bdb569 100644 --- a/x-pack/docs/en/rest-api/ml/post-calendar-event.asciidoc +++ b/docs/reference/ml/apis/post-calendar-event.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-post-calendar-event]] === Add Events to Calendar API ++++ diff --git a/x-pack/docs/en/rest-api/ml/post-data.asciidoc b/docs/reference/ml/apis/post-data.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/post-data.asciidoc rename to docs/reference/ml/apis/post-data.asciidoc index 40354d7f6f760..6a5a3d3d6cb5e 100644 --- a/x-pack/docs/en/rest-api/ml/post-data.asciidoc +++ b/docs/reference/ml/apis/post-data.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-post-data]] === Post Data to Jobs API ++++ diff --git a/x-pack/docs/en/rest-api/ml/preview-datafeed.asciidoc b/docs/reference/ml/apis/preview-datafeed.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/preview-datafeed.asciidoc rename to docs/reference/ml/apis/preview-datafeed.asciidoc index 637b506cb9af7..302a84b48bf49 100644 --- a/x-pack/docs/en/rest-api/ml/preview-datafeed.asciidoc +++ b/docs/reference/ml/apis/preview-datafeed.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-preview-datafeed]] === Preview {dfeeds-cap} API ++++ diff --git a/x-pack/docs/en/rest-api/ml/put-calendar-job.asciidoc b/docs/reference/ml/apis/put-calendar-job.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/put-calendar-job.asciidoc rename to docs/reference/ml/apis/put-calendar-job.asciidoc index 6940957b15926..3d14ad0a03531 100644 --- a/x-pack/docs/en/rest-api/ml/put-calendar-job.asciidoc +++ b/docs/reference/ml/apis/put-calendar-job.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-put-calendar-job]] === Add Jobs to Calendar API ++++ diff --git a/x-pack/docs/en/rest-api/ml/put-calendar.asciidoc b/docs/reference/ml/apis/put-calendar.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/put-calendar.asciidoc rename to docs/reference/ml/apis/put-calendar.asciidoc index a82da5a2c0c0a..77ca451386340 100644 --- a/x-pack/docs/en/rest-api/ml/put-calendar.asciidoc +++ b/docs/reference/ml/apis/put-calendar.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-put-calendar]] === Create Calendar API ++++ diff --git a/x-pack/docs/en/rest-api/ml/put-datafeed.asciidoc b/docs/reference/ml/apis/put-datafeed.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/put-datafeed.asciidoc rename to docs/reference/ml/apis/put-datafeed.asciidoc index 6b8ad932a1d42..fed99cbab299a 100644 --- a/x-pack/docs/en/rest-api/ml/put-datafeed.asciidoc +++ b/docs/reference/ml/apis/put-datafeed.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-put-datafeed]] === Create {dfeeds-cap} API ++++ diff --git a/x-pack/docs/en/rest-api/ml/put-filter.asciidoc b/docs/reference/ml/apis/put-filter.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/put-filter.asciidoc rename to docs/reference/ml/apis/put-filter.asciidoc index d2982a56f612e..0bd36b92b8819 100644 --- a/x-pack/docs/en/rest-api/ml/put-filter.asciidoc +++ b/docs/reference/ml/apis/put-filter.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-put-filter]] === Create Filter API ++++ diff --git a/x-pack/docs/en/rest-api/ml/put-job.asciidoc b/docs/reference/ml/apis/put-job.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/put-job.asciidoc rename to docs/reference/ml/apis/put-job.asciidoc index 1c436f53d32e7..cc42bbc95c84b 100644 --- a/x-pack/docs/en/rest-api/ml/put-job.asciidoc +++ b/docs/reference/ml/apis/put-job.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-put-job]] === Create Jobs API ++++ diff --git a/x-pack/docs/en/rest-api/ml/resultsresource.asciidoc b/docs/reference/ml/apis/resultsresource.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/resultsresource.asciidoc rename to docs/reference/ml/apis/resultsresource.asciidoc index c28ed72aedb36..d3abd094be79c 100644 --- a/x-pack/docs/en/rest-api/ml/resultsresource.asciidoc +++ b/docs/reference/ml/apis/resultsresource.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-results-resource]] === Results Resources diff --git a/x-pack/docs/en/rest-api/ml/revert-snapshot.asciidoc b/docs/reference/ml/apis/revert-snapshot.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/revert-snapshot.asciidoc rename to docs/reference/ml/apis/revert-snapshot.asciidoc index 1dc3046ac4f22..3fbf210a0ad16 100644 --- a/x-pack/docs/en/rest-api/ml/revert-snapshot.asciidoc +++ b/docs/reference/ml/apis/revert-snapshot.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-revert-snapshot]] === Revert Model Snapshots API ++++ diff --git a/x-pack/docs/en/rest-api/ml/snapshotresource.asciidoc b/docs/reference/ml/apis/snapshotresource.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/snapshotresource.asciidoc rename to docs/reference/ml/apis/snapshotresource.asciidoc index fb2e3d83de6d1..f068f6d94ed0f 100644 --- a/x-pack/docs/en/rest-api/ml/snapshotresource.asciidoc +++ b/docs/reference/ml/apis/snapshotresource.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-snapshot-resource]] === Model Snapshot Resources diff --git a/x-pack/docs/en/rest-api/ml/start-datafeed.asciidoc b/docs/reference/ml/apis/start-datafeed.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/start-datafeed.asciidoc rename to docs/reference/ml/apis/start-datafeed.asciidoc index fa3ea35a751f7..e8fca9170c037 100644 --- a/x-pack/docs/en/rest-api/ml/start-datafeed.asciidoc +++ b/docs/reference/ml/apis/start-datafeed.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-start-datafeed]] === Start {dfeeds-cap} API ++++ diff --git a/x-pack/docs/en/rest-api/ml/stop-datafeed.asciidoc b/docs/reference/ml/apis/stop-datafeed.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/stop-datafeed.asciidoc rename to docs/reference/ml/apis/stop-datafeed.asciidoc index 27872ff5a2080..1f77dfdbc0c3f 100644 --- a/x-pack/docs/en/rest-api/ml/stop-datafeed.asciidoc +++ b/docs/reference/ml/apis/stop-datafeed.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-stop-datafeed]] === Stop {dfeeds-cap} API ++++ diff --git a/x-pack/docs/en/rest-api/ml/update-datafeed.asciidoc b/docs/reference/ml/apis/update-datafeed.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/update-datafeed.asciidoc rename to docs/reference/ml/apis/update-datafeed.asciidoc index bc9462347c1c0..7389c240681f1 100644 --- a/x-pack/docs/en/rest-api/ml/update-datafeed.asciidoc +++ b/docs/reference/ml/apis/update-datafeed.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-update-datafeed]] === Update {dfeeds-cap} API ++++ diff --git a/x-pack/docs/en/rest-api/ml/update-filter.asciidoc b/docs/reference/ml/apis/update-filter.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/update-filter.asciidoc rename to docs/reference/ml/apis/update-filter.asciidoc index 1b6760dfed654..c7695611169a4 100644 --- a/x-pack/docs/en/rest-api/ml/update-filter.asciidoc +++ b/docs/reference/ml/apis/update-filter.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-update-filter]] === Update Filter API ++++ diff --git a/x-pack/docs/en/rest-api/ml/update-job.asciidoc b/docs/reference/ml/apis/update-job.asciidoc similarity index 99% rename from x-pack/docs/en/rest-api/ml/update-job.asciidoc rename to docs/reference/ml/apis/update-job.asciidoc index 852745e9dd907..f308441756674 100644 --- a/x-pack/docs/en/rest-api/ml/update-job.asciidoc +++ b/docs/reference/ml/apis/update-job.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-update-job]] === Update Jobs API ++++ diff --git a/x-pack/docs/en/rest-api/ml/update-snapshot.asciidoc b/docs/reference/ml/apis/update-snapshot.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/update-snapshot.asciidoc rename to docs/reference/ml/apis/update-snapshot.asciidoc index 8c98a7b732186..b58eebe810fa1 100644 --- a/x-pack/docs/en/rest-api/ml/update-snapshot.asciidoc +++ b/docs/reference/ml/apis/update-snapshot.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-update-snapshot]] === Update Model Snapshots API ++++ diff --git a/x-pack/docs/en/rest-api/ml/validate-detector.asciidoc b/docs/reference/ml/apis/validate-detector.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/validate-detector.asciidoc rename to docs/reference/ml/apis/validate-detector.asciidoc index ab8a0de442cf8..671f0528fd359 100644 --- a/x-pack/docs/en/rest-api/ml/validate-detector.asciidoc +++ b/docs/reference/ml/apis/validate-detector.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-valid-detector]] === Validate Detectors API ++++ diff --git a/x-pack/docs/en/rest-api/ml/validate-job.asciidoc b/docs/reference/ml/apis/validate-job.asciidoc similarity index 98% rename from x-pack/docs/en/rest-api/ml/validate-job.asciidoc rename to docs/reference/ml/apis/validate-job.asciidoc index 0ccc5bc04e1d1..accf49e0d1a8a 100644 --- a/x-pack/docs/en/rest-api/ml/validate-job.asciidoc +++ b/docs/reference/ml/apis/validate-job.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-valid-job]] === Validate Jobs API ++++ diff --git a/docs/reference/redirects.asciidoc b/docs/reference/redirects.asciidoc index f0e0553805379..1a932fdd41400 100644 --- a/docs/reference/redirects.asciidoc +++ b/docs/reference/redirects.asciidoc @@ -549,3 +549,9 @@ See <>. === X-Pack commands See <>. + +[role="exclude",id="ml-api-definitions"] +=== Machine learning API definitions + +See <>. + diff --git a/x-pack/docs/en/rest-api/defs.asciidoc b/docs/reference/rest-api/defs.asciidoc similarity index 54% rename from x-pack/docs/en/rest-api/defs.asciidoc rename to docs/reference/rest-api/defs.asciidoc index ed53929391bfe..3d24bac9ae34c 100644 --- a/x-pack/docs/en/rest-api/defs.asciidoc +++ b/docs/reference/rest-api/defs.asciidoc @@ -1,5 +1,5 @@ [role="xpack"] -[[ml-api-definitions]] +[[api-definitions]] == Definitions These resource definitions are used in {ml} and {security} APIs and in {kib} @@ -17,20 +17,20 @@ advanced {ml} job configuration options. * <> [role="xpack"] -include::ml/calendarresource.asciidoc[] +include::{es-repo-dir}/ml/apis/calendarresource.asciidoc[] [role="xpack"] -include::ml/datafeedresource.asciidoc[] +include::{es-repo-dir}/ml/apis/datafeedresource.asciidoc[] [role="xpack"] -include::ml/filterresource.asciidoc[] +include::{es-repo-dir}/ml/apis/filterresource.asciidoc[] [role="xpack"] -include::ml/jobresource.asciidoc[] +include::{es-repo-dir}/ml/apis/jobresource.asciidoc[] [role="xpack"] -include::ml/jobcounts.asciidoc[] +include::{es-repo-dir}/ml/apis/jobcounts.asciidoc[] [role="xpack"] -include::security/role-mapping-resources.asciidoc[] +include::{xes-repo-dir}/rest-api/security/role-mapping-resources.asciidoc[] [role="xpack"] -include::ml/snapshotresource.asciidoc[] +include::{es-repo-dir}/ml/apis/snapshotresource.asciidoc[] [role="xpack"] -include::ml/resultsresource.asciidoc[] +include::{es-repo-dir}/ml/apis/resultsresource.asciidoc[] [role="xpack"] -include::ml/eventresource.asciidoc[] +include::{es-repo-dir}/ml/apis/eventresource.asciidoc[] diff --git a/docs/reference/rest-api/index.asciidoc b/docs/reference/rest-api/index.asciidoc index e1d607948e1e3..b80e8badf5bb3 100644 --- a/docs/reference/rest-api/index.asciidoc +++ b/docs/reference/rest-api/index.asciidoc @@ -22,8 +22,8 @@ include::info.asciidoc[] include::{xes-repo-dir}/rest-api/graph/explore.asciidoc[] include::{es-repo-dir}/licensing/index.asciidoc[] include::{es-repo-dir}/migration/migration.asciidoc[] -include::{xes-repo-dir}/rest-api/ml-api.asciidoc[] +include::{es-repo-dir}/ml/apis/ml-api.asciidoc[] include::{es-repo-dir}/rollup/rollup-api.asciidoc[] include::{xes-repo-dir}/rest-api/security.asciidoc[] include::{xes-repo-dir}/rest-api/watcher.asciidoc[] -include::{xes-repo-dir}/rest-api/defs.asciidoc[] +include::defs.asciidoc[] From b858b05c281501fe2125c985a7b1316718f0723d Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 5 Jun 2018 15:06:24 -0700 Subject: [PATCH 2/7] [DOCS] Adds license level info for testing --- docs/reference/ml/apis/ml-api.asciidoc | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/reference/ml/apis/ml-api.asciidoc b/docs/reference/ml/apis/ml-api.asciidoc index 5a5f0a0bc0795..b8509f221524c 100644 --- a/docs/reference/ml/apis/ml-api.asciidoc +++ b/docs/reference/ml/apis/ml-api.asciidoc @@ -1,4 +1,5 @@ [role="xpack"] +[testenv="platinum"] [[ml-apis]] == Machine Learning APIs From 3c6e8b98ff79017ea2db3fbd87ecc9baf521d9cd Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 19 Jun 2018 13:58:23 -0700 Subject: [PATCH 3/7] [DOCS] Moves ML APIs to ml folder --- docs/reference/rest-api/defs.asciidoc | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/docs/reference/rest-api/defs.asciidoc b/docs/reference/rest-api/defs.asciidoc index 3d24bac9ae34c..c6874119dd6cf 100644 --- a/docs/reference/rest-api/defs.asciidoc +++ b/docs/reference/rest-api/defs.asciidoc @@ -16,21 +16,11 @@ advanced {ml} job configuration options. * <> * <> -[role="xpack"] include::{es-repo-dir}/ml/apis/calendarresource.asciidoc[] -[role="xpack"] include::{es-repo-dir}/ml/apis/datafeedresource.asciidoc[] -[role="xpack"] -include::{es-repo-dir}/ml/apis/filterresource.asciidoc[] -[role="xpack"] include::{es-repo-dir}/ml/apis/jobresource.asciidoc[] -[role="xpack"] include::{es-repo-dir}/ml/apis/jobcounts.asciidoc[] -[role="xpack"] -include::{xes-repo-dir}/rest-api/security/role-mapping-resources.asciidoc[] -[role="xpack"] include::{es-repo-dir}/ml/apis/snapshotresource.asciidoc[] -[role="xpack"] +include::{xes-repo-dir}/rest-api/security/role-mapping-resources.asciidoc[] include::{es-repo-dir}/ml/apis/resultsresource.asciidoc[] -[role="xpack"] include::{es-repo-dir}/ml/apis/eventresource.asciidoc[] From 41682248e7b1e905d6e03e06c47d439c0b81d461 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 28 Aug 2018 17:17:48 -0700 Subject: [PATCH 4/7] [DOCS] Updates code snippet tests --- docs/build.gradle | 43 ++++++++++++++++++- docs/reference/ml/apis/close-job.asciidoc | 4 +- .../ml/apis/delete-calendar-event.asciidoc | 3 +- .../ml/apis/delete-calendar-job.asciidoc | 4 +- .../ml/apis/delete-calendar.asciidoc | 4 +- .../ml/apis/delete-datafeed.asciidoc | 4 +- docs/reference/ml/apis/delete-filter.asciidoc | 4 +- docs/reference/ml/apis/delete-job.asciidoc | 3 +- .../ml/apis/delete-snapshot.asciidoc | 1 - docs/reference/ml/apis/flush-job.asciidoc | 11 +++-- docs/reference/ml/apis/get-bucket.asciidoc | 1 - .../ml/apis/get-calendar-event.asciidoc | 5 ++- docs/reference/ml/apis/get-calendar.asciidoc | 4 +- docs/reference/ml/apis/get-category.asciidoc | 2 - .../ml/apis/get-datafeed-stats.asciidoc | 5 ++- docs/reference/ml/apis/get-datafeed.asciidoc | 5 ++- docs/reference/ml/apis/get-filter.asciidoc | 4 +- docs/reference/ml/apis/get-job.asciidoc | 5 ++- .../ml/apis/get-overall-buckets.asciidoc | 1 - docs/reference/ml/apis/open-job.asciidoc | 4 +- .../ml/apis/post-calendar-event.asciidoc | 4 +- .../ml/apis/preview-datafeed.asciidoc | 4 +- .../ml/apis/put-calendar-job.asciidoc | 4 +- docs/reference/ml/apis/put-calendar.asciidoc | 3 +- docs/reference/ml/apis/put-datafeed.asciidoc | 5 ++- docs/reference/ml/apis/put-filter.asciidoc | 3 +- docs/reference/ml/apis/put-job.asciidoc | 4 ++ .../ml/apis/revert-snapshot.asciidoc | 28 ------------ .../reference/ml/apis/start-datafeed.asciidoc | 5 +-- docs/reference/ml/apis/stop-datafeed.asciidoc | 6 +-- .../ml/apis/update-datafeed.asciidoc | 5 ++- docs/reference/ml/apis/update-filter.asciidoc | 4 +- docs/reference/ml/apis/update-job.asciidoc | 5 ++- .../ml/apis/validate-detector.asciidoc | 2 +- docs/reference/ml/apis/validate-job.asciidoc | 2 +- docs/reference/rest-api/defs.asciidoc | 1 + x-pack/docs/build.gradle | 11 ----- 37 files changed, 115 insertions(+), 98 deletions(-) diff --git a/docs/build.gradle b/docs/build.gradle index 6a1f91ad2f65a..827d895eebb39 100644 --- a/docs/build.gradle +++ b/docs/build.gradle @@ -19,10 +19,49 @@ apply plugin: 'elasticsearch.docs-test' -/* List of files that have snippets that require a gold or platinum licence -and therefore cannot be tested yet... */ +/* List of files that have snippets that will not work until platinum tests can occur ... */ buildRestTests.expectedUnconvertedCandidates = [ 'reference/ml/transforms.asciidoc', + 'reference/ml/apis/close-job.asciidoc', + 'reference/ml/apis/delete-calendar-event.asciidoc', + 'reference/ml/apis/delete-calendar-job.asciidoc', + 'reference/ml/apis/delete-calendar.asciidoc', + 'reference/ml/apis/delete-datafeed.asciidoc', + 'reference/ml/apis/delete-filter.asciidoc', + 'reference/ml/apis/delete-job.asciidoc', + 'reference/ml/apis/delete-snapshot.asciidoc', + 'reference/ml/apis/flush-job.asciidoc', + 'reference/ml/apis/get-bucket.asciidoc', + 'reference/ml/apis/get-calendar-event.asciidoc', + 'reference/ml/apis/get-calendar.asciidoc', + 'reference/ml/apis/get-category.asciidoc', + 'reference/ml/apis/get-datafeed-stats.asciidoc', + 'reference/ml/apis/get-datafeed.asciidoc', + 'reference/ml/apis/get-filter.asciidoc', + 'reference/ml/apis/get-influencer.asciidoc', + 'reference/ml/apis/get-job-stats.asciidoc', + 'reference/ml/apis/get-job.asciidoc', + 'reference/ml/apis/get-overall-buckets.asciidoc', + 'reference/ml/apis/get-record.asciidoc', + 'reference/ml/apis/get-snapshot.asciidoc', + 'reference/ml/apis/open-job.asciidoc', + 'reference/ml/apis/post-calendar-event.asciidoc', + 'reference/ml/apis/post-data.asciidoc', + 'reference/ml/apis/preview-datafeed.asciidoc', + 'reference/ml/apis/put-calendar-job.asciidoc', + 'reference/ml/apis/put-calendar.asciidoc', + 'reference/ml/apis/put-datafeed.asciidoc', + 'reference/ml/apis/put-filter.asciidoc', + 'reference/ml/apis/put-job.asciidoc', + 'reference/ml/apis/revert-snapshot.asciidoc', + 'reference/ml/apis/start-datafeed.asciidoc', + 'reference/ml/apis/stop-datafeed.asciidoc', + 'reference/ml/apis/stop-datafeed.asciidoc', + 'reference/ml/apis/update-filter.asciidoc', + 'reference/ml/apis/update-job.asciidoc', + 'reference/ml/apis/update-snapshot.asciidoc', + 'reference/ml/apis/validate-detector.asciidoc', + 'reference/ml/apis/validate-job.asciidoc', ] integTestCluster { diff --git a/docs/reference/ml/apis/close-job.asciidoc b/docs/reference/ml/apis/close-job.asciidoc index 25c6804364c32..a45831400f437 100644 --- a/docs/reference/ml/apis/close-job.asciidoc +++ b/docs/reference/ml/apis/close-job.asciidoc @@ -81,7 +81,7 @@ The following example closes the `total-requests` job: POST _xpack/ml/anomaly_detectors/total-requests/_close -------------------------------------------------- // CONSOLE -// TEST[setup:server_metrics_openjob] +// TEST[skip:setup:server_metrics_openjob] When the job is closed, you receive the following results: [source,js] @@ -90,4 +90,4 @@ When the job is closed, you receive the following results: "closed": true } ---- -// TESTRESPONSE + diff --git a/docs/reference/ml/apis/delete-calendar-event.asciidoc b/docs/reference/ml/apis/delete-calendar-event.asciidoc index b583a08d4d4b9..8961726f57322 100644 --- a/docs/reference/ml/apis/delete-calendar-event.asciidoc +++ b/docs/reference/ml/apis/delete-calendar-event.asciidoc @@ -45,7 +45,7 @@ calendar: DELETE _xpack/ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st -------------------------------------------------- // CONSOLE -// TEST[catch:missing] +// TEST[skip:catch:missing] When the event is removed, you receive the following results: [source,js] @@ -54,4 +54,3 @@ When the event is removed, you receive the following results: "acknowledged": true } ---- -// NOTCONSOLE \ No newline at end of file diff --git a/docs/reference/ml/apis/delete-calendar-job.asciidoc b/docs/reference/ml/apis/delete-calendar-job.asciidoc index b2dbb77fd88e6..6be4a25c54850 100644 --- a/docs/reference/ml/apis/delete-calendar-job.asciidoc +++ b/docs/reference/ml/apis/delete-calendar-job.asciidoc @@ -39,7 +39,7 @@ calendar and `total-requests` job: DELETE _xpack/ml/calendars/planned-outages/jobs/total-requests -------------------------------------------------- // CONSOLE -// TEST[setup:calendar_outages_addjob] +// TEST[skip:setup:calendar_outages_addjob] When the job is removed from the calendar, you receive the following results: @@ -51,4 +51,4 @@ results: "job_ids": [] } ---- -//TESTRESPONSE + diff --git a/docs/reference/ml/apis/delete-calendar.asciidoc b/docs/reference/ml/apis/delete-calendar.asciidoc index e0cfeb7eebb6f..03cc93cfe7ec1 100644 --- a/docs/reference/ml/apis/delete-calendar.asciidoc +++ b/docs/reference/ml/apis/delete-calendar.asciidoc @@ -41,7 +41,7 @@ The following example deletes the `planned-outages` calendar: DELETE _xpack/ml/calendars/planned-outages -------------------------------------------------- // CONSOLE -// TEST[setup:calendar_outages] +// TEST[skip:setup:calendar_outages] When the calendar is deleted, you receive the following results: [source,js] @@ -50,4 +50,4 @@ When the calendar is deleted, you receive the following results: "acknowledged": true } ---- -//TESTRESPONSE + diff --git a/docs/reference/ml/apis/delete-datafeed.asciidoc b/docs/reference/ml/apis/delete-datafeed.asciidoc index e38060430e90e..bf18273772698 100644 --- a/docs/reference/ml/apis/delete-datafeed.asciidoc +++ b/docs/reference/ml/apis/delete-datafeed.asciidoc @@ -48,7 +48,7 @@ The following example deletes the `datafeed-total-requests` {dfeed}: DELETE _xpack/ml/datafeeds/datafeed-total-requests -------------------------------------------------- // CONSOLE -// TEST[setup:server_metrics_datafeed] +// TEST[skip:setup:server_metrics_datafeed] When the {dfeed} is deleted, you receive the following results: [source,js] @@ -57,4 +57,4 @@ When the {dfeed} is deleted, you receive the following results: "acknowledged": true } ---- -// TESTRESPONSE + diff --git a/docs/reference/ml/apis/delete-filter.asciidoc b/docs/reference/ml/apis/delete-filter.asciidoc index 55638e42ef8f8..2a60cb7751e4e 100644 --- a/docs/reference/ml/apis/delete-filter.asciidoc +++ b/docs/reference/ml/apis/delete-filter.asciidoc @@ -42,7 +42,7 @@ The following example deletes the `safe_domains` filter: DELETE _xpack/ml/filters/safe_domains -------------------------------------------------- // CONSOLE -// TEST[setup:ml_filter_safe_domains] +// TEST[skip:setup:ml_filter_safe_domains] When the filter is deleted, you receive the following results: [source,js] @@ -51,4 +51,4 @@ When the filter is deleted, you receive the following results: "acknowledged": true } ---- -//TESTRESPONSE + diff --git a/docs/reference/ml/apis/delete-job.asciidoc b/docs/reference/ml/apis/delete-job.asciidoc index 98e224dfd5889..f84f5c06d1910 100644 --- a/docs/reference/ml/apis/delete-job.asciidoc +++ b/docs/reference/ml/apis/delete-job.asciidoc @@ -57,7 +57,7 @@ The following example deletes the `total-requests` job: DELETE _xpack/ml/anomaly_detectors/total-requests -------------------------------------------------- // CONSOLE -// TEST[setup:server_metrics_job] +// TEST[skip:setup:server_metrics_job] When the job is deleted, you receive the following results: [source,js] @@ -66,4 +66,3 @@ When the job is deleted, you receive the following results: "acknowledged": true } ---- -// TESTRESPONSE diff --git a/docs/reference/ml/apis/delete-snapshot.asciidoc b/docs/reference/ml/apis/delete-snapshot.asciidoc index 399db26b3fe5e..725c85b4ba149 100644 --- a/docs/reference/ml/apis/delete-snapshot.asciidoc +++ b/docs/reference/ml/apis/delete-snapshot.asciidoc @@ -33,7 +33,6 @@ the `model_snapshot_id` in the results from the get jobs API. You must have `manage_ml`, or `manage` cluster privileges to use this API. For more information, see {xpack-ref}/security-privileges.html[Security Privileges]. -//<>. ==== Examples diff --git a/docs/reference/ml/apis/flush-job.asciidoc b/docs/reference/ml/apis/flush-job.asciidoc index 0e16601f13f24..d590eae4d732d 100644 --- a/docs/reference/ml/apis/flush-job.asciidoc +++ b/docs/reference/ml/apis/flush-job.asciidoc @@ -75,7 +75,7 @@ POST _xpack/ml/anomaly_detectors/total-requests/_flush } -------------------------------------------------- // CONSOLE -// TEST[setup:server_metrics_openjob] +// TEST[skip:setup:server_metrics_openjob] When the operation succeeds, you receive the following results: [source,js] @@ -85,7 +85,10 @@ When the operation succeeds, you receive the following results: "last_finalized_bucket_end": 1455234900000 } ---- -// TESTRESPONSE[s/"last_finalized_bucket_end": 1455234900000/"last_finalized_bucket_end": $body.last_finalized_bucket_end/] + +//// +TESTRESPONSE[s/"last_finalized_bucket_end": 1455234900000/"last_finalized_bucket_end": $body.last_finalized_bucket_end/] +//// The `last_finalized_bucket_end` provides the timestamp (in milliseconds-since-the-epoch) of the end of the last bucket that was processed. @@ -102,7 +105,7 @@ POST _xpack/ml/anomaly_detectors/total-requests/_flush } -------------------------------------------------- // CONSOLE -// TEST[setup:server_metrics_openjob] +// TEST[skip:setup:server_metrics_openjob] When the operation succeeds, you receive the following results: [source,js] @@ -112,4 +115,4 @@ When the operation succeeds, you receive the following results: "last_finalized_bucket_end": 1514804400000 } ---- -// TESTRESPONSE + diff --git a/docs/reference/ml/apis/get-bucket.asciidoc b/docs/reference/ml/apis/get-bucket.asciidoc index 758dcd3b87ba5..3a276c13e895b 100644 --- a/docs/reference/ml/apis/get-bucket.asciidoc +++ b/docs/reference/ml/apis/get-bucket.asciidoc @@ -82,7 +82,6 @@ that stores the results. The `machine_learning_admin` and `machine_learning_user roles provide these privileges. For more information, see {xpack-ref}/security-privileges.html[Security Privileges] and {xpack-ref}/built-in-roles.html[Built-in Roles]. -//<> and <>. ==== Examples diff --git a/docs/reference/ml/apis/get-calendar-event.asciidoc b/docs/reference/ml/apis/get-calendar-event.asciidoc index 51bc69637d983..b2798b620287d 100644 --- a/docs/reference/ml/apis/get-calendar-event.asciidoc +++ b/docs/reference/ml/apis/get-calendar-event.asciidoc @@ -67,7 +67,7 @@ The following example gets information about the scheduled events in the GET _xpack/ml/calendars/planned-outages/events -------------------------------------------------- // CONSOLE -// TEST[setup:calendar_outages_addevent] +// TEST[skip:setup:calendar_outages_addevent] The API returns the following results: @@ -100,8 +100,11 @@ The API returns the following results: ] } ---- + +//// // TESTRESPONSE[s/LS8LJGEBMTCMA-qz49st/$body.$_path/] // TESTRESPONSE[s/Li8LJGEBMTCMA-qz49st/$body.$_path/] // TESTRESPONSE[s/Ly8LJGEBMTCMA-qz49st/$body.$_path/] +//// For more information about these properties, see <>. diff --git a/docs/reference/ml/apis/get-calendar.asciidoc b/docs/reference/ml/apis/get-calendar.asciidoc index 0bf37b4ed1af6..0fb60f89ccb3a 100644 --- a/docs/reference/ml/apis/get-calendar.asciidoc +++ b/docs/reference/ml/apis/get-calendar.asciidoc @@ -63,7 +63,7 @@ calendar: GET _xpack/ml/calendars/planned-outages -------------------------------------------------- // CONSOLE -// TEST[setup:calendar_outages_addjob] +// TEST[skip:setup:calendar_outages_addjob] The API returns the following results: [source,js] @@ -80,4 +80,4 @@ The API returns the following results: ] } ---- -//TESTRESPONSE + diff --git a/docs/reference/ml/apis/get-category.asciidoc b/docs/reference/ml/apis/get-category.asciidoc index 6edbac856a58f..e5d6fe16802a1 100644 --- a/docs/reference/ml/apis/get-category.asciidoc +++ b/docs/reference/ml/apis/get-category.asciidoc @@ -19,7 +19,6 @@ Retrieves job results for one or more categories. For more information about categories, see {xpack-ref}/ml-configuring-categories.html[Categorizing Log Messages]. -//<>. ==== Path Parameters @@ -57,7 +56,6 @@ that stores the results. The `machine_learning_admin` and `machine_learning_user roles provide these privileges. For more information, see {xpack-ref}/security-privileges.html[Security Privileges] and {xpack-ref}/built-in-roles.html[Built-in Roles]. -//<> and <>. ==== Examples diff --git a/docs/reference/ml/apis/get-datafeed-stats.asciidoc b/docs/reference/ml/apis/get-datafeed-stats.asciidoc index 2f3d9aeeea70a..37ad22d311fd7 100644 --- a/docs/reference/ml/apis/get-datafeed-stats.asciidoc +++ b/docs/reference/ml/apis/get-datafeed-stats.asciidoc @@ -67,7 +67,7 @@ The following example gets usage information for the GET _xpack/ml/datafeeds/datafeed-total-requests/_stats -------------------------------------------------- // CONSOLE -// TEST[setup:server_metrics_startdf] +// TEST[skip:setup:server_metrics_startdf] The API returns the following results: [source,js] @@ -94,8 +94,11 @@ The API returns the following results: ] } ---- + +//// // TESTRESPONSE[s/"2spCyo1pRi2Ajo-j-_dnPX"/$body.$_path/] // TESTRESPONSE[s/"node-0"/$body.$_path/] // TESTRESPONSE[s/"hoXMLZB0RWKfR9UPPUCxXX"/$body.$_path/] // TESTRESPONSE[s/"127.0.0.1:9300"/$body.$_path/] // TESTRESPONSE[s/"17179869184"/$body.datafeeds.0.node.attributes.ml\\.machine_memory/] +//// \ No newline at end of file diff --git a/docs/reference/ml/apis/get-datafeed.asciidoc b/docs/reference/ml/apis/get-datafeed.asciidoc index cc6b9fe7fdb63..89796114d7496 100644 --- a/docs/reference/ml/apis/get-datafeed.asciidoc +++ b/docs/reference/ml/apis/get-datafeed.asciidoc @@ -61,7 +61,7 @@ The following example gets configuration information for the GET _xpack/ml/datafeeds/datafeed-total-requests -------------------------------------------------- // CONSOLE -// TEST[setup:server_metrics_datafeed] +// TEST[skip:setup:server_metrics_datafeed] The API returns the following results: [source,js] @@ -90,4 +90,7 @@ The API returns the following results: ] } ---- + +//// // TESTRESPONSE[s/"query.boost": "1.0"/"query.boost": $body.query.boost/] +//// \ No newline at end of file diff --git a/docs/reference/ml/apis/get-filter.asciidoc b/docs/reference/ml/apis/get-filter.asciidoc index 94c27245bb86b..0ce9caf9d1d0f 100644 --- a/docs/reference/ml/apis/get-filter.asciidoc +++ b/docs/reference/ml/apis/get-filter.asciidoc @@ -63,7 +63,7 @@ filter: GET _xpack/ml/filters/safe_domains -------------------------------------------------- // CONSOLE -// TEST[setup:ml_filter_safe_domains] +// TEST[skip:setup:ml_filter_safe_domains] The API returns the following results: [source,js] @@ -82,4 +82,4 @@ The API returns the following results: ] } ---- -//TESTRESPONSE + diff --git a/docs/reference/ml/apis/get-job.asciidoc b/docs/reference/ml/apis/get-job.asciidoc index 9b695bc802b3c..4db4e058c58d1 100644 --- a/docs/reference/ml/apis/get-job.asciidoc +++ b/docs/reference/ml/apis/get-job.asciidoc @@ -60,7 +60,7 @@ The following example gets configuration information for the `total-requests` jo GET _xpack/ml/anomaly_detectors/total-requests -------------------------------------------------- // CONSOLE -// TEST[setup:server_metrics_job] +// TEST[skip:setup:server_metrics_job] The API returns the following results: [source,js] @@ -100,5 +100,8 @@ The API returns the following results: ] } ---- + +//// // TESTRESPONSE[s/"7.0.0-alpha1"/$body.$_path/] // TESTRESPONSE[s/1517011406091/$body.$_path/] +//// \ No newline at end of file diff --git a/docs/reference/ml/apis/get-overall-buckets.asciidoc b/docs/reference/ml/apis/get-overall-buckets.asciidoc index 1a767ea3eef36..f4818f3bbbe44 100644 --- a/docs/reference/ml/apis/get-overall-buckets.asciidoc +++ b/docs/reference/ml/apis/get-overall-buckets.asciidoc @@ -94,7 +94,6 @@ that stores the results. The `machine_learning_admin` and `machine_learning_user roles provide these privileges. For more information, see {xpack-ref}/security-privileges.html[Security Privileges] and {xpack-ref}/built-in-roles.html[Built-in Roles]. -//<> and <>. ==== Examples diff --git a/docs/reference/ml/apis/open-job.asciidoc b/docs/reference/ml/apis/open-job.asciidoc index 4126914dfad09..6799acc80b6a2 100644 --- a/docs/reference/ml/apis/open-job.asciidoc +++ b/docs/reference/ml/apis/open-job.asciidoc @@ -57,7 +57,7 @@ POST _xpack/ml/anomaly_detectors/total-requests/_open } -------------------------------------------------- // CONSOLE -// TEST[setup:server_metrics_job] +// TEST[skip:setup:server_metrics_job] When the job opens, you receive the following results: [source,js] @@ -66,5 +66,3 @@ When the job opens, you receive the following results: "opened": true } ---- -//CONSOLE -// TESTRESPONSE diff --git a/docs/reference/ml/apis/post-calendar-event.asciidoc b/docs/reference/ml/apis/post-calendar-event.asciidoc index 22a78a1bdb569..d4c0493c5c562 100644 --- a/docs/reference/ml/apis/post-calendar-event.asciidoc +++ b/docs/reference/ml/apis/post-calendar-event.asciidoc @@ -53,7 +53,7 @@ POST _xpack/ml/calendars/planned-outages/events } -------------------------------------------------- // CONSOLE -// TEST[setup:calendar_outages_addjob] +// TEST[skip:setup:calendar_outages_addjob] The API returns the following results: @@ -82,7 +82,7 @@ The API returns the following results: ] } ---- -//TESTRESPONSE + For more information about these properties, see <>. diff --git a/docs/reference/ml/apis/preview-datafeed.asciidoc b/docs/reference/ml/apis/preview-datafeed.asciidoc index 302a84b48bf49..646b796504f87 100644 --- a/docs/reference/ml/apis/preview-datafeed.asciidoc +++ b/docs/reference/ml/apis/preview-datafeed.asciidoc @@ -54,7 +54,7 @@ The following example obtains a preview of the `datafeed-farequote` {dfeed}: GET _xpack/ml/datafeeds/datafeed-farequote/_preview -------------------------------------------------- // CONSOLE -// TEST[setup:farequote_datafeed] +// TEST[skip:setup:farequote_datafeed] The data that is returned for this example is as follows: [source,js] @@ -80,4 +80,4 @@ The data that is returned for this example is as follows: } ] ---- -// TESTRESPONSE + diff --git a/docs/reference/ml/apis/put-calendar-job.asciidoc b/docs/reference/ml/apis/put-calendar-job.asciidoc index 3d14ad0a03531..2ff096b376ab4 100644 --- a/docs/reference/ml/apis/put-calendar-job.asciidoc +++ b/docs/reference/ml/apis/put-calendar-job.asciidoc @@ -39,7 +39,7 @@ The following example associates the `planned-outages` calendar with the PUT _xpack/ml/calendars/planned-outages/jobs/total-requests -------------------------------------------------- // CONSOLE -// TEST[setup:calendar_outages_openjob] +// TEST[skip:setup:calendar_outages_openjob] The API returns the following results: @@ -52,4 +52,4 @@ The API returns the following results: ] } ---- -//TESTRESPONSE + diff --git a/docs/reference/ml/apis/put-calendar.asciidoc b/docs/reference/ml/apis/put-calendar.asciidoc index 77ca451386340..c4d11434446c2 100644 --- a/docs/reference/ml/apis/put-calendar.asciidoc +++ b/docs/reference/ml/apis/put-calendar.asciidoc @@ -45,6 +45,7 @@ The following example creates the `planned-outages` calendar: PUT _xpack/ml/calendars/planned-outages -------------------------------------------------- // CONSOLE +// TEST[skip:need-license] When the calendar is created, you receive the following results: [source,js] @@ -54,4 +55,4 @@ When the calendar is created, you receive the following results: "job_ids": [] } ---- -//TESTRESPONSE + diff --git a/docs/reference/ml/apis/put-datafeed.asciidoc b/docs/reference/ml/apis/put-datafeed.asciidoc index fed99cbab299a..40616346a8087 100644 --- a/docs/reference/ml/apis/put-datafeed.asciidoc +++ b/docs/reference/ml/apis/put-datafeed.asciidoc @@ -108,7 +108,7 @@ PUT _xpack/ml/datafeeds/datafeed-total-requests } -------------------------------------------------- // CONSOLE -// TEST[setup:server_metrics_job] +// TEST[skip:setup:server_metrics_job] When the {dfeed} is created, you receive the following results: [source,js] @@ -132,5 +132,8 @@ When the {dfeed} is created, you receive the following results: } } ---- + +//// // TESTRESPONSE[s/"query_delay": "83474ms"/"query_delay": $body.query_delay/] // TESTRESPONSE[s/"query.boost": "1.0"/"query.boost": $body.query.boost/] +//// \ No newline at end of file diff --git a/docs/reference/ml/apis/put-filter.asciidoc b/docs/reference/ml/apis/put-filter.asciidoc index 0bd36b92b8819..510c1b3d69378 100644 --- a/docs/reference/ml/apis/put-filter.asciidoc +++ b/docs/reference/ml/apis/put-filter.asciidoc @@ -56,6 +56,7 @@ PUT _xpack/ml/filters/safe_domains } -------------------------------------------------- // CONSOLE +// TEST[skip:need-licence] When the filter is created, you receive the following response: [source,js] @@ -66,4 +67,4 @@ When the filter is created, you receive the following response: "items": ["*.google.com", "wikipedia.org"] } ---- -//TESTRESPONSE + diff --git a/docs/reference/ml/apis/put-job.asciidoc b/docs/reference/ml/apis/put-job.asciidoc index cc42bbc95c84b..d4fbd2f3122ce 100644 --- a/docs/reference/ml/apis/put-job.asciidoc +++ b/docs/reference/ml/apis/put-job.asciidoc @@ -105,6 +105,7 @@ PUT _xpack/ml/anomaly_detectors/total-requests } -------------------------------------------------- // CONSOLE +// TEST[skip:need-licence] When the job is created, you receive the following results: [source,js] @@ -139,5 +140,8 @@ When the job is created, you receive the following results: "results_index_name": "shared" } ---- + +//// // TESTRESPONSE[s/"job_version": "7.0.0-alpha1"/"job_version": $body.job_version/] // TESTRESPONSE[s/"create_time": 1517011406091/"create_time": $body.create_time/] +//// \ No newline at end of file diff --git a/docs/reference/ml/apis/revert-snapshot.asciidoc b/docs/reference/ml/apis/revert-snapshot.asciidoc index 3fbf210a0ad16..48fc65edf90fa 100644 --- a/docs/reference/ml/apis/revert-snapshot.asciidoc +++ b/docs/reference/ml/apis/revert-snapshot.asciidoc @@ -23,33 +23,6 @@ then it might be appropriate to reset the model state to a time before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure. -//// -To revert to a saved snapshot, you must follow this sequence: -. Close the job -. Revert to a snapshot -. Open the job -. Send new data to the job - -When reverting to a snapshot, there is a choice to make about whether or not -you want to keep the results that were created between the time of the snapshot -and the current time. In the case of Black Friday for instance, you might want -to keep the results and carry on processing data from the current time, -though without the models learning the one-off behavior and compensating for it. -However, say in the event of a critical system failure and you decide to reset -and models to a previous known good state and process data from that time, -it makes sense to delete the intervening results for the known bad period and -resend data from that earlier time. - -Any gaps in data since the snapshot time will be treated as nulls and not modeled. -If there is a partial bucket at the end of the snapshot and/or at the beginning -of the new input data, then this will be ignored and treated as a gap. - -For jobs with many entities, the model state may be very large. -If a model state is several GB, this could take 10-20 mins to revert depending -upon machine spec and resources. If this is the case, please ensure this time -is planned for. -Model size (in bytes) is available as part of the Job Resource Model Size Stats. -//// IMPORTANT: Before you revert to a saved snapshot, you must close the job. @@ -78,7 +51,6 @@ If you want to resend data, then delete the intervening results. You must have `manage_ml`, or `manage` cluster privileges to use this API. For more information, see {xpack-ref}/security-privileges.html[Security Privileges]. -//<>. ==== Examples diff --git a/docs/reference/ml/apis/start-datafeed.asciidoc b/docs/reference/ml/apis/start-datafeed.asciidoc index e8fca9170c037..aa446a69f35c9 100644 --- a/docs/reference/ml/apis/start-datafeed.asciidoc +++ b/docs/reference/ml/apis/start-datafeed.asciidoc @@ -80,7 +80,6 @@ of the latest processed record. You must have `manage_ml`, or `manage` cluster privileges to use this API. For more information, see {xpack-ref}/security-privileges.html[Security Privileges]. -//<>. ==== Security Integration @@ -102,7 +101,7 @@ POST _xpack/ml/datafeeds/datafeed-total-requests/_start } -------------------------------------------------- // CONSOLE -// TEST[setup:server_metrics_openjob] +// TEST[skip:setup:server_metrics_openjob] When the {dfeed} starts, you receive the following results: [source,js] @@ -111,5 +110,3 @@ When the {dfeed} starts, you receive the following results: "started": true } ---- -// CONSOLE -// TESTRESPONSE diff --git a/docs/reference/ml/apis/stop-datafeed.asciidoc b/docs/reference/ml/apis/stop-datafeed.asciidoc index 1f77dfdbc0c3f..365e3cbb12873 100644 --- a/docs/reference/ml/apis/stop-datafeed.asciidoc +++ b/docs/reference/ml/apis/stop-datafeed.asciidoc @@ -19,7 +19,6 @@ A {dfeed} can be started and stopped multiple times throughout its lifecycle. `POST _xpack/ml/datafeeds/_all/_stop` -//TBD: Can there be spaces between the items in the list? ===== Description @@ -64,7 +63,7 @@ POST _xpack/ml/datafeeds/datafeed-total-requests/_stop } -------------------------------------------------- // CONSOLE -// TEST[setup:server_metrics_startdf] +// TEST[skip:setup:server_metrics_startdf] When the {dfeed} stops, you receive the following results: [source,js] @@ -73,5 +72,4 @@ When the {dfeed} stops, you receive the following results: "stopped": true } ---- -// CONSOLE -// TESTRESPONSE + diff --git a/docs/reference/ml/apis/update-datafeed.asciidoc b/docs/reference/ml/apis/update-datafeed.asciidoc index 7389c240681f1..127a82cec978f 100644 --- a/docs/reference/ml/apis/update-datafeed.asciidoc +++ b/docs/reference/ml/apis/update-datafeed.asciidoc @@ -107,7 +107,7 @@ POST _xpack/ml/datafeeds/datafeed-total-requests/_update } -------------------------------------------------- // CONSOLE -// TEST[setup:server_metrics_datafeed] +// TEST[skip:setup:server_metrics_datafeed] When the {dfeed} is updated, you receive the full {dfeed} configuration with with the updated values: @@ -134,4 +134,7 @@ with the updated values: } } ---- + +//// // TESTRESPONSE[s/"query.boost": "1.0"/"query.boost": $body.query.boost/] +//// \ No newline at end of file diff --git a/docs/reference/ml/apis/update-filter.asciidoc b/docs/reference/ml/apis/update-filter.asciidoc index c7695611169a4..abeb8aa7bf63e 100644 --- a/docs/reference/ml/apis/update-filter.asciidoc +++ b/docs/reference/ml/apis/update-filter.asciidoc @@ -53,7 +53,7 @@ POST _xpack/ml/filters/safe_domains/_update } -------------------------------------------------- // CONSOLE -// TEST[setup:ml_filter_safe_domains] +// TEST[skip:setup:ml_filter_safe_domains] The API returns the following results: @@ -65,4 +65,4 @@ The API returns the following results: "items": ["*.google.com", "*.myorg.com"] } ---- -//TESTRESPONSE + diff --git a/docs/reference/ml/apis/update-job.asciidoc b/docs/reference/ml/apis/update-job.asciidoc index f308441756674..ae37fdfebcf8c 100644 --- a/docs/reference/ml/apis/update-job.asciidoc +++ b/docs/reference/ml/apis/update-job.asciidoc @@ -122,7 +122,7 @@ POST _xpack/ml/anomaly_detectors/total-requests/_update } -------------------------------------------------- // CONSOLE -// TEST[setup:server_metrics_job] +// TEST[skip:setup:server_metrics_job] When the job is updated, you receive a summary of the job configuration information, including the updated property values. For example: @@ -177,5 +177,8 @@ information, including the updated property values. For example: "results_index_name": "shared" } ---- + +//// // TESTRESPONSE[s/"job_version": "7.0.0-alpha1"/"job_version": $body.job_version/] // TESTRESPONSE[s/"create_time": 1518808660505/"create_time": $body.create_time/] +//// \ No newline at end of file diff --git a/docs/reference/ml/apis/validate-detector.asciidoc b/docs/reference/ml/apis/validate-detector.asciidoc index 671f0528fd359..69f5de8800f55 100644 --- a/docs/reference/ml/apis/validate-detector.asciidoc +++ b/docs/reference/ml/apis/validate-detector.asciidoc @@ -45,6 +45,7 @@ POST _xpack/ml/anomaly_detectors/_validate/detector } -------------------------------------------------- // CONSOLE +// TEST[skip:needs-licence] When the validation completes, you receive the following results: [source,js] @@ -53,4 +54,3 @@ When the validation completes, you receive the following results: "acknowledged": true } ---- -// TESTRESPONSE \ No newline at end of file diff --git a/docs/reference/ml/apis/validate-job.asciidoc b/docs/reference/ml/apis/validate-job.asciidoc index accf49e0d1a8a..877db9ae3d86b 100644 --- a/docs/reference/ml/apis/validate-job.asciidoc +++ b/docs/reference/ml/apis/validate-job.asciidoc @@ -56,6 +56,7 @@ POST _xpack/ml/anomaly_detectors/_validate } -------------------------------------------------- // CONSOLE +// TEST[skip:needs-licence] When the validation is complete, you receive the following results: [source,js] @@ -64,4 +65,3 @@ When the validation is complete, you receive the following results: "acknowledged": true } ---- -// TESTRESPONSE \ No newline at end of file diff --git a/docs/reference/rest-api/defs.asciidoc b/docs/reference/rest-api/defs.asciidoc index c6874119dd6cf..4eeedc5539992 100644 --- a/docs/reference/rest-api/defs.asciidoc +++ b/docs/reference/rest-api/defs.asciidoc @@ -18,6 +18,7 @@ advanced {ml} job configuration options. include::{es-repo-dir}/ml/apis/calendarresource.asciidoc[] include::{es-repo-dir}/ml/apis/datafeedresource.asciidoc[] +include::{es-repo-dir}/ml/apis/filterresource.asciidoc[] include::{es-repo-dir}/ml/apis/jobresource.asciidoc[] include::{es-repo-dir}/ml/apis/jobcounts.asciidoc[] include::{es-repo-dir}/ml/apis/snapshotresource.asciidoc[] diff --git a/x-pack/docs/build.gradle b/x-pack/docs/build.gradle index 99e62532e2dc4..f027493b0abed 100644 --- a/x-pack/docs/build.gradle +++ b/x-pack/docs/build.gradle @@ -14,17 +14,6 @@ buildRestTests.expectedUnconvertedCandidates = [ 'en/security/authorization/run-as-privilege.asciidoc', 'en/security/ccs-clients-integrations/http.asciidoc', 'en/security/authorization/custom-roles-provider.asciidoc', - 'en/rest-api/ml/delete-snapshot.asciidoc', - 'en/rest-api/ml/get-bucket.asciidoc', - 'en/rest-api/ml/get-job-stats.asciidoc', - 'en/rest-api/ml/get-overall-buckets.asciidoc', - 'en/rest-api/ml/get-category.asciidoc', - 'en/rest-api/ml/get-record.asciidoc', - 'en/rest-api/ml/get-influencer.asciidoc', - 'en/rest-api/ml/get-snapshot.asciidoc', - 'en/rest-api/ml/post-data.asciidoc', - 'en/rest-api/ml/revert-snapshot.asciidoc', - 'en/rest-api/ml/update-snapshot.asciidoc', 'en/rest-api/watcher/stats.asciidoc', 'en/watcher/example-watches/watching-time-series-data.asciidoc', ] From 070f85a34274a4fa87996902ac49452b12f509cc Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 28 Aug 2018 17:41:43 -0700 Subject: [PATCH 5/7] [DOCS] Updates build.gradle for ML APIs --- docs/build.gradle | 2 +- docs/reference/ml/apis/get-calendar-event.asciidoc | 5 ----- docs/reference/ml/apis/get-datafeed-stats.asciidoc | 8 -------- docs/reference/ml/apis/get-datafeed.asciidoc | 4 ---- docs/reference/ml/apis/get-job.asciidoc | 5 ----- docs/reference/ml/apis/put-datafeed.asciidoc | 5 ----- docs/reference/ml/apis/put-job.asciidoc | 5 ----- docs/reference/ml/apis/stop-datafeed.asciidoc | 2 +- docs/reference/ml/apis/update-datafeed.asciidoc | 4 ---- docs/reference/ml/apis/update-job.asciidoc | 5 ----- 10 files changed, 2 insertions(+), 43 deletions(-) diff --git a/docs/build.gradle b/docs/build.gradle index 827d895eebb39..980706e943af2 100644 --- a/docs/build.gradle +++ b/docs/build.gradle @@ -56,7 +56,7 @@ buildRestTests.expectedUnconvertedCandidates = [ 'reference/ml/apis/revert-snapshot.asciidoc', 'reference/ml/apis/start-datafeed.asciidoc', 'reference/ml/apis/stop-datafeed.asciidoc', - 'reference/ml/apis/stop-datafeed.asciidoc', + 'reference/ml/apis/update-datafeed.asciidoc', 'reference/ml/apis/update-filter.asciidoc', 'reference/ml/apis/update-job.asciidoc', 'reference/ml/apis/update-snapshot.asciidoc', diff --git a/docs/reference/ml/apis/get-calendar-event.asciidoc b/docs/reference/ml/apis/get-calendar-event.asciidoc index b2798b620287d..990b66c1ae4f3 100644 --- a/docs/reference/ml/apis/get-calendar-event.asciidoc +++ b/docs/reference/ml/apis/get-calendar-event.asciidoc @@ -101,10 +101,5 @@ The API returns the following results: } ---- -//// -// TESTRESPONSE[s/LS8LJGEBMTCMA-qz49st/$body.$_path/] -// TESTRESPONSE[s/Li8LJGEBMTCMA-qz49st/$body.$_path/] -// TESTRESPONSE[s/Ly8LJGEBMTCMA-qz49st/$body.$_path/] -//// For more information about these properties, see <>. diff --git a/docs/reference/ml/apis/get-datafeed-stats.asciidoc b/docs/reference/ml/apis/get-datafeed-stats.asciidoc index 37ad22d311fd7..ad65fc4615ee4 100644 --- a/docs/reference/ml/apis/get-datafeed-stats.asciidoc +++ b/docs/reference/ml/apis/get-datafeed-stats.asciidoc @@ -94,11 +94,3 @@ The API returns the following results: ] } ---- - -//// -// TESTRESPONSE[s/"2spCyo1pRi2Ajo-j-_dnPX"/$body.$_path/] -// TESTRESPONSE[s/"node-0"/$body.$_path/] -// TESTRESPONSE[s/"hoXMLZB0RWKfR9UPPUCxXX"/$body.$_path/] -// TESTRESPONSE[s/"127.0.0.1:9300"/$body.$_path/] -// TESTRESPONSE[s/"17179869184"/$body.datafeeds.0.node.attributes.ml\\.machine_memory/] -//// \ No newline at end of file diff --git a/docs/reference/ml/apis/get-datafeed.asciidoc b/docs/reference/ml/apis/get-datafeed.asciidoc index 89796114d7496..4afca279a143b 100644 --- a/docs/reference/ml/apis/get-datafeed.asciidoc +++ b/docs/reference/ml/apis/get-datafeed.asciidoc @@ -90,7 +90,3 @@ The API returns the following results: ] } ---- - -//// -// TESTRESPONSE[s/"query.boost": "1.0"/"query.boost": $body.query.boost/] -//// \ No newline at end of file diff --git a/docs/reference/ml/apis/get-job.asciidoc b/docs/reference/ml/apis/get-job.asciidoc index 4db4e058c58d1..d9d137f0717f4 100644 --- a/docs/reference/ml/apis/get-job.asciidoc +++ b/docs/reference/ml/apis/get-job.asciidoc @@ -100,8 +100,3 @@ The API returns the following results: ] } ---- - -//// -// TESTRESPONSE[s/"7.0.0-alpha1"/$body.$_path/] -// TESTRESPONSE[s/1517011406091/$body.$_path/] -//// \ No newline at end of file diff --git a/docs/reference/ml/apis/put-datafeed.asciidoc b/docs/reference/ml/apis/put-datafeed.asciidoc index 40616346a8087..f6e7ac143255a 100644 --- a/docs/reference/ml/apis/put-datafeed.asciidoc +++ b/docs/reference/ml/apis/put-datafeed.asciidoc @@ -132,8 +132,3 @@ When the {dfeed} is created, you receive the following results: } } ---- - -//// -// TESTRESPONSE[s/"query_delay": "83474ms"/"query_delay": $body.query_delay/] -// TESTRESPONSE[s/"query.boost": "1.0"/"query.boost": $body.query.boost/] -//// \ No newline at end of file diff --git a/docs/reference/ml/apis/put-job.asciidoc b/docs/reference/ml/apis/put-job.asciidoc index d4fbd2f3122ce..c415d776c4a6e 100644 --- a/docs/reference/ml/apis/put-job.asciidoc +++ b/docs/reference/ml/apis/put-job.asciidoc @@ -140,8 +140,3 @@ When the job is created, you receive the following results: "results_index_name": "shared" } ---- - -//// -// TESTRESPONSE[s/"job_version": "7.0.0-alpha1"/"job_version": $body.job_version/] -// TESTRESPONSE[s/"create_time": 1517011406091/"create_time": $body.create_time/] -//// \ No newline at end of file diff --git a/docs/reference/ml/apis/stop-datafeed.asciidoc b/docs/reference/ml/apis/stop-datafeed.asciidoc index 365e3cbb12873..2cd9b9e0ce9d2 100644 --- a/docs/reference/ml/apis/stop-datafeed.asciidoc +++ b/docs/reference/ml/apis/stop-datafeed.asciidoc @@ -66,10 +66,10 @@ POST _xpack/ml/datafeeds/datafeed-total-requests/_stop // TEST[skip:setup:server_metrics_startdf] When the {dfeed} stops, you receive the following results: + [source,js] ---- { "stopped": true } ---- - diff --git a/docs/reference/ml/apis/update-datafeed.asciidoc b/docs/reference/ml/apis/update-datafeed.asciidoc index 127a82cec978f..555edfacc4c1e 100644 --- a/docs/reference/ml/apis/update-datafeed.asciidoc +++ b/docs/reference/ml/apis/update-datafeed.asciidoc @@ -134,7 +134,3 @@ with the updated values: } } ---- - -//// -// TESTRESPONSE[s/"query.boost": "1.0"/"query.boost": $body.query.boost/] -//// \ No newline at end of file diff --git a/docs/reference/ml/apis/update-job.asciidoc b/docs/reference/ml/apis/update-job.asciidoc index ae37fdfebcf8c..7fb018a07d481 100644 --- a/docs/reference/ml/apis/update-job.asciidoc +++ b/docs/reference/ml/apis/update-job.asciidoc @@ -177,8 +177,3 @@ information, including the updated property values. For example: "results_index_name": "shared" } ---- - -//// -// TESTRESPONSE[s/"job_version": "7.0.0-alpha1"/"job_version": $body.job_version/] -// TESTRESPONSE[s/"create_time": 1518808660505/"create_time": $body.create_time/] -//// \ No newline at end of file From 53519f6713843ef40a51760cb46c31565d730aa7 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 30 Aug 2018 10:15:48 -0700 Subject: [PATCH 6/7] [DOCS] Re-adds TESTRESPONSE values --- docs/build.gradle | 8 -------- docs/reference/ml/apis/get-calendar-event.asciidoc | 4 +++- docs/reference/ml/apis/get-datafeed-stats.asciidoc | 5 +++++ docs/reference/ml/apis/get-datafeed.asciidoc | 1 + docs/reference/ml/apis/get-job.asciidoc | 2 ++ docs/reference/ml/apis/put-datafeed.asciidoc | 2 ++ docs/reference/ml/apis/put-job.asciidoc | 2 ++ docs/reference/ml/apis/update-datafeed.asciidoc | 1 + docs/reference/ml/apis/update-job.asciidoc | 2 ++ 9 files changed, 18 insertions(+), 9 deletions(-) diff --git a/docs/build.gradle b/docs/build.gradle index 980706e943af2..f38ccc62030b6 100644 --- a/docs/build.gradle +++ b/docs/build.gradle @@ -32,15 +32,11 @@ buildRestTests.expectedUnconvertedCandidates = [ 'reference/ml/apis/delete-snapshot.asciidoc', 'reference/ml/apis/flush-job.asciidoc', 'reference/ml/apis/get-bucket.asciidoc', - 'reference/ml/apis/get-calendar-event.asciidoc', 'reference/ml/apis/get-calendar.asciidoc', 'reference/ml/apis/get-category.asciidoc', - 'reference/ml/apis/get-datafeed-stats.asciidoc', - 'reference/ml/apis/get-datafeed.asciidoc', 'reference/ml/apis/get-filter.asciidoc', 'reference/ml/apis/get-influencer.asciidoc', 'reference/ml/apis/get-job-stats.asciidoc', - 'reference/ml/apis/get-job.asciidoc', 'reference/ml/apis/get-overall-buckets.asciidoc', 'reference/ml/apis/get-record.asciidoc', 'reference/ml/apis/get-snapshot.asciidoc', @@ -50,15 +46,11 @@ buildRestTests.expectedUnconvertedCandidates = [ 'reference/ml/apis/preview-datafeed.asciidoc', 'reference/ml/apis/put-calendar-job.asciidoc', 'reference/ml/apis/put-calendar.asciidoc', - 'reference/ml/apis/put-datafeed.asciidoc', 'reference/ml/apis/put-filter.asciidoc', - 'reference/ml/apis/put-job.asciidoc', 'reference/ml/apis/revert-snapshot.asciidoc', 'reference/ml/apis/start-datafeed.asciidoc', 'reference/ml/apis/stop-datafeed.asciidoc', - 'reference/ml/apis/update-datafeed.asciidoc', 'reference/ml/apis/update-filter.asciidoc', - 'reference/ml/apis/update-job.asciidoc', 'reference/ml/apis/update-snapshot.asciidoc', 'reference/ml/apis/validate-detector.asciidoc', 'reference/ml/apis/validate-job.asciidoc', diff --git a/docs/reference/ml/apis/get-calendar-event.asciidoc b/docs/reference/ml/apis/get-calendar-event.asciidoc index 990b66c1ae4f3..43dd74e47c977 100644 --- a/docs/reference/ml/apis/get-calendar-event.asciidoc +++ b/docs/reference/ml/apis/get-calendar-event.asciidoc @@ -100,6 +100,8 @@ The API returns the following results: ] } ---- - +// TESTRESPONSE[s/LS8LJGEBMTCMA-qz49st/$body.$_path/] +// TESTRESPONSE[s/Li8LJGEBMTCMA-qz49st/$body.$_path/] +// TESTRESPONSE[s/Ly8LJGEBMTCMA-qz49st/$body.$_path/] For more information about these properties, see <>. diff --git a/docs/reference/ml/apis/get-datafeed-stats.asciidoc b/docs/reference/ml/apis/get-datafeed-stats.asciidoc index ad65fc4615ee4..9ca67cc17fb44 100644 --- a/docs/reference/ml/apis/get-datafeed-stats.asciidoc +++ b/docs/reference/ml/apis/get-datafeed-stats.asciidoc @@ -94,3 +94,8 @@ The API returns the following results: ] } ---- +// TESTRESPONSE[s/"2spCyo1pRi2Ajo-j-_dnPX"/$body.$_path/] +// TESTRESPONSE[s/"node-0"/$body.$_path/] +// TESTRESPONSE[s/"hoXMLZB0RWKfR9UPPUCxXX"/$body.$_path/] +// TESTRESPONSE[s/"127.0.0.1:9300"/$body.$_path/] +// TESTRESPONSE[s/"17179869184"/$body.datafeeds.0.node.attributes.ml\\.machine_memory/] \ No newline at end of file diff --git a/docs/reference/ml/apis/get-datafeed.asciidoc b/docs/reference/ml/apis/get-datafeed.asciidoc index 4afca279a143b..db5f4249669bb 100644 --- a/docs/reference/ml/apis/get-datafeed.asciidoc +++ b/docs/reference/ml/apis/get-datafeed.asciidoc @@ -90,3 +90,4 @@ The API returns the following results: ] } ---- +// TESTRESPONSE[s/"query.boost": "1.0"/"query.boost": $body.query.boost/] diff --git a/docs/reference/ml/apis/get-job.asciidoc b/docs/reference/ml/apis/get-job.asciidoc index d9d137f0717f4..c669ac6034eda 100644 --- a/docs/reference/ml/apis/get-job.asciidoc +++ b/docs/reference/ml/apis/get-job.asciidoc @@ -100,3 +100,5 @@ The API returns the following results: ] } ---- +// TESTRESPONSE[s/"7.0.0-alpha1"/$body.$_path/] +// TESTRESPONSE[s/1517011406091/$body.$_path/] diff --git a/docs/reference/ml/apis/put-datafeed.asciidoc b/docs/reference/ml/apis/put-datafeed.asciidoc index f6e7ac143255a..b5c99fc8e36af 100644 --- a/docs/reference/ml/apis/put-datafeed.asciidoc +++ b/docs/reference/ml/apis/put-datafeed.asciidoc @@ -132,3 +132,5 @@ When the {dfeed} is created, you receive the following results: } } ---- +// TESTRESPONSE[s/"query_delay": "83474ms"/"query_delay": $body.query_delay/] +// TESTRESPONSE[s/"query.boost": "1.0"/"query.boost": $body.query.boost/] \ No newline at end of file diff --git a/docs/reference/ml/apis/put-job.asciidoc b/docs/reference/ml/apis/put-job.asciidoc index c415d776c4a6e..ce05348490601 100644 --- a/docs/reference/ml/apis/put-job.asciidoc +++ b/docs/reference/ml/apis/put-job.asciidoc @@ -140,3 +140,5 @@ When the job is created, you receive the following results: "results_index_name": "shared" } ---- +// TESTRESPONSE[s/"job_version": "7.0.0-alpha1"/"job_version": $body.job_version/] +// TESTRESPONSE[s/"create_time": 1517011406091/"create_time": $body.create_time/] diff --git a/docs/reference/ml/apis/update-datafeed.asciidoc b/docs/reference/ml/apis/update-datafeed.asciidoc index 555edfacc4c1e..be55d864c871e 100644 --- a/docs/reference/ml/apis/update-datafeed.asciidoc +++ b/docs/reference/ml/apis/update-datafeed.asciidoc @@ -134,3 +134,4 @@ with the updated values: } } ---- +// TESTRESPONSE[s/"query.boost": "1.0"/"query.boost": $body.query.boost/] diff --git a/docs/reference/ml/apis/update-job.asciidoc b/docs/reference/ml/apis/update-job.asciidoc index 7fb018a07d481..58bfb2679d935 100644 --- a/docs/reference/ml/apis/update-job.asciidoc +++ b/docs/reference/ml/apis/update-job.asciidoc @@ -177,3 +177,5 @@ information, including the updated property values. For example: "results_index_name": "shared" } ---- +// TESTRESPONSE[s/"job_version": "7.0.0-alpha1"/"job_version": $body.job_version/] +// TESTRESPONSE[s/"create_time": 1518808660505/"create_time": $body.create_time/] \ No newline at end of file From 39e9fbdb77aa6d9ff43e7e7a0a92ab8f483fc4c0 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 30 Aug 2018 10:34:15 -0700 Subject: [PATCH 7/7] [DOCS] Re-adds all TESTRESPONSE --- docs/build.gradle | 21 ------------------- docs/reference/ml/apis/close-job.asciidoc | 2 +- .../ml/apis/delete-calendar-job.asciidoc | 2 +- .../ml/apis/delete-calendar.asciidoc | 2 +- .../ml/apis/delete-datafeed.asciidoc | 2 +- docs/reference/ml/apis/delete-filter.asciidoc | 2 +- docs/reference/ml/apis/delete-job.asciidoc | 1 + .../ml/apis/delete-snapshot.asciidoc | 1 + docs/reference/ml/apis/flush-job.asciidoc | 7 ++----- docs/reference/ml/apis/get-calendar.asciidoc | 2 +- docs/reference/ml/apis/get-filter.asciidoc | 2 +- docs/reference/ml/apis/open-job.asciidoc | 1 + .../ml/apis/post-calendar-event.asciidoc | 2 +- .../ml/apis/preview-datafeed.asciidoc | 2 +- .../ml/apis/put-calendar-job.asciidoc | 2 +- docs/reference/ml/apis/put-calendar.asciidoc | 2 +- docs/reference/ml/apis/put-filter.asciidoc | 2 +- .../reference/ml/apis/start-datafeed.asciidoc | 1 + docs/reference/ml/apis/stop-datafeed.asciidoc | 1 + docs/reference/ml/apis/update-filter.asciidoc | 2 +- .../ml/apis/validate-detector.asciidoc | 1 + docs/reference/ml/apis/validate-job.asciidoc | 1 + 22 files changed, 22 insertions(+), 39 deletions(-) diff --git a/docs/build.gradle b/docs/build.gradle index f38ccc62030b6..c6a7a8d48374b 100644 --- a/docs/build.gradle +++ b/docs/build.gradle @@ -22,38 +22,17 @@ apply plugin: 'elasticsearch.docs-test' /* List of files that have snippets that will not work until platinum tests can occur ... */ buildRestTests.expectedUnconvertedCandidates = [ 'reference/ml/transforms.asciidoc', - 'reference/ml/apis/close-job.asciidoc', 'reference/ml/apis/delete-calendar-event.asciidoc', - 'reference/ml/apis/delete-calendar-job.asciidoc', - 'reference/ml/apis/delete-calendar.asciidoc', - 'reference/ml/apis/delete-datafeed.asciidoc', - 'reference/ml/apis/delete-filter.asciidoc', - 'reference/ml/apis/delete-job.asciidoc', - 'reference/ml/apis/delete-snapshot.asciidoc', - 'reference/ml/apis/flush-job.asciidoc', 'reference/ml/apis/get-bucket.asciidoc', - 'reference/ml/apis/get-calendar.asciidoc', 'reference/ml/apis/get-category.asciidoc', - 'reference/ml/apis/get-filter.asciidoc', 'reference/ml/apis/get-influencer.asciidoc', 'reference/ml/apis/get-job-stats.asciidoc', 'reference/ml/apis/get-overall-buckets.asciidoc', 'reference/ml/apis/get-record.asciidoc', 'reference/ml/apis/get-snapshot.asciidoc', - 'reference/ml/apis/open-job.asciidoc', - 'reference/ml/apis/post-calendar-event.asciidoc', 'reference/ml/apis/post-data.asciidoc', - 'reference/ml/apis/preview-datafeed.asciidoc', - 'reference/ml/apis/put-calendar-job.asciidoc', - 'reference/ml/apis/put-calendar.asciidoc', - 'reference/ml/apis/put-filter.asciidoc', 'reference/ml/apis/revert-snapshot.asciidoc', - 'reference/ml/apis/start-datafeed.asciidoc', - 'reference/ml/apis/stop-datafeed.asciidoc', - 'reference/ml/apis/update-filter.asciidoc', 'reference/ml/apis/update-snapshot.asciidoc', - 'reference/ml/apis/validate-detector.asciidoc', - 'reference/ml/apis/validate-job.asciidoc', ] integTestCluster { diff --git a/docs/reference/ml/apis/close-job.asciidoc b/docs/reference/ml/apis/close-job.asciidoc index a45831400f437..6dec6402c8766 100644 --- a/docs/reference/ml/apis/close-job.asciidoc +++ b/docs/reference/ml/apis/close-job.asciidoc @@ -90,4 +90,4 @@ When the job is closed, you receive the following results: "closed": true } ---- - +// TESTRESPONSE diff --git a/docs/reference/ml/apis/delete-calendar-job.asciidoc b/docs/reference/ml/apis/delete-calendar-job.asciidoc index 6be4a25c54850..4362a82b5cb7e 100644 --- a/docs/reference/ml/apis/delete-calendar-job.asciidoc +++ b/docs/reference/ml/apis/delete-calendar-job.asciidoc @@ -51,4 +51,4 @@ results: "job_ids": [] } ---- - +// TESTRESPONSE diff --git a/docs/reference/ml/apis/delete-calendar.asciidoc b/docs/reference/ml/apis/delete-calendar.asciidoc index 03cc93cfe7ec1..9f9f3457f24d2 100644 --- a/docs/reference/ml/apis/delete-calendar.asciidoc +++ b/docs/reference/ml/apis/delete-calendar.asciidoc @@ -50,4 +50,4 @@ When the calendar is deleted, you receive the following results: "acknowledged": true } ---- - +// TESTRESPONSE diff --git a/docs/reference/ml/apis/delete-datafeed.asciidoc b/docs/reference/ml/apis/delete-datafeed.asciidoc index bf18273772698..996d2c7dd2eaf 100644 --- a/docs/reference/ml/apis/delete-datafeed.asciidoc +++ b/docs/reference/ml/apis/delete-datafeed.asciidoc @@ -57,4 +57,4 @@ When the {dfeed} is deleted, you receive the following results: "acknowledged": true } ---- - +// TESTRESPONSE diff --git a/docs/reference/ml/apis/delete-filter.asciidoc b/docs/reference/ml/apis/delete-filter.asciidoc index 2a60cb7751e4e..21e35b66076f6 100644 --- a/docs/reference/ml/apis/delete-filter.asciidoc +++ b/docs/reference/ml/apis/delete-filter.asciidoc @@ -51,4 +51,4 @@ When the filter is deleted, you receive the following results: "acknowledged": true } ---- - +// TESTRESPONSE diff --git a/docs/reference/ml/apis/delete-job.asciidoc b/docs/reference/ml/apis/delete-job.asciidoc index f84f5c06d1910..d5ef120ad040b 100644 --- a/docs/reference/ml/apis/delete-job.asciidoc +++ b/docs/reference/ml/apis/delete-job.asciidoc @@ -66,3 +66,4 @@ When the job is deleted, you receive the following results: "acknowledged": true } ---- +// TESTRESPONSE \ No newline at end of file diff --git a/docs/reference/ml/apis/delete-snapshot.asciidoc b/docs/reference/ml/apis/delete-snapshot.asciidoc index 725c85b4ba149..96a3590054557 100644 --- a/docs/reference/ml/apis/delete-snapshot.asciidoc +++ b/docs/reference/ml/apis/delete-snapshot.asciidoc @@ -53,3 +53,4 @@ When the snapshot is deleted, you receive the following results: "acknowledged": true } ---- +// TESTRESPONSE \ No newline at end of file diff --git a/docs/reference/ml/apis/flush-job.asciidoc b/docs/reference/ml/apis/flush-job.asciidoc index d590eae4d732d..f19d2aa648f68 100644 --- a/docs/reference/ml/apis/flush-job.asciidoc +++ b/docs/reference/ml/apis/flush-job.asciidoc @@ -85,10 +85,7 @@ When the operation succeeds, you receive the following results: "last_finalized_bucket_end": 1455234900000 } ---- - -//// -TESTRESPONSE[s/"last_finalized_bucket_end": 1455234900000/"last_finalized_bucket_end": $body.last_finalized_bucket_end/] -//// +//TESTRESPONSE[s/"last_finalized_bucket_end": 1455234900000/"last_finalized_bucket_end": $body.last_finalized_bucket_end/] The `last_finalized_bucket_end` provides the timestamp (in milliseconds-since-the-epoch) of the end of the last bucket that was processed. @@ -115,4 +112,4 @@ When the operation succeeds, you receive the following results: "last_finalized_bucket_end": 1514804400000 } ---- - +// TESTRESPONSE diff --git a/docs/reference/ml/apis/get-calendar.asciidoc b/docs/reference/ml/apis/get-calendar.asciidoc index 0fb60f89ccb3a..f86875f326cd9 100644 --- a/docs/reference/ml/apis/get-calendar.asciidoc +++ b/docs/reference/ml/apis/get-calendar.asciidoc @@ -80,4 +80,4 @@ The API returns the following results: ] } ---- - +// TESTRESPONSE diff --git a/docs/reference/ml/apis/get-filter.asciidoc b/docs/reference/ml/apis/get-filter.asciidoc index 0ce9caf9d1d0f..2dbb5d16cc5a4 100644 --- a/docs/reference/ml/apis/get-filter.asciidoc +++ b/docs/reference/ml/apis/get-filter.asciidoc @@ -82,4 +82,4 @@ The API returns the following results: ] } ---- - +// TESTRESPONSE diff --git a/docs/reference/ml/apis/open-job.asciidoc b/docs/reference/ml/apis/open-job.asciidoc index 6799acc80b6a2..c1e5977b734fd 100644 --- a/docs/reference/ml/apis/open-job.asciidoc +++ b/docs/reference/ml/apis/open-job.asciidoc @@ -66,3 +66,4 @@ When the job opens, you receive the following results: "opened": true } ---- +// TESTRESPONSE diff --git a/docs/reference/ml/apis/post-calendar-event.asciidoc b/docs/reference/ml/apis/post-calendar-event.asciidoc index d4c0493c5c562..998db409fc7d6 100644 --- a/docs/reference/ml/apis/post-calendar-event.asciidoc +++ b/docs/reference/ml/apis/post-calendar-event.asciidoc @@ -82,7 +82,7 @@ The API returns the following results: ] } ---- - +// TESTRESPONSE For more information about these properties, see <>. diff --git a/docs/reference/ml/apis/preview-datafeed.asciidoc b/docs/reference/ml/apis/preview-datafeed.asciidoc index 646b796504f87..7b9eccd9a5920 100644 --- a/docs/reference/ml/apis/preview-datafeed.asciidoc +++ b/docs/reference/ml/apis/preview-datafeed.asciidoc @@ -80,4 +80,4 @@ The data that is returned for this example is as follows: } ] ---- - +// TESTRESPONSE diff --git a/docs/reference/ml/apis/put-calendar-job.asciidoc b/docs/reference/ml/apis/put-calendar-job.asciidoc index 2ff096b376ab4..0563047043ae4 100644 --- a/docs/reference/ml/apis/put-calendar-job.asciidoc +++ b/docs/reference/ml/apis/put-calendar-job.asciidoc @@ -52,4 +52,4 @@ The API returns the following results: ] } ---- - +// TESTRESPONSE diff --git a/docs/reference/ml/apis/put-calendar.asciidoc b/docs/reference/ml/apis/put-calendar.asciidoc index c4d11434446c2..06b8e55d7747c 100644 --- a/docs/reference/ml/apis/put-calendar.asciidoc +++ b/docs/reference/ml/apis/put-calendar.asciidoc @@ -55,4 +55,4 @@ When the calendar is created, you receive the following results: "job_ids": [] } ---- - +// TESTRESPONSE diff --git a/docs/reference/ml/apis/put-filter.asciidoc b/docs/reference/ml/apis/put-filter.asciidoc index 510c1b3d69378..165fe9697584c 100644 --- a/docs/reference/ml/apis/put-filter.asciidoc +++ b/docs/reference/ml/apis/put-filter.asciidoc @@ -67,4 +67,4 @@ When the filter is created, you receive the following response: "items": ["*.google.com", "wikipedia.org"] } ---- - +// TESTRESPONSE diff --git a/docs/reference/ml/apis/start-datafeed.asciidoc b/docs/reference/ml/apis/start-datafeed.asciidoc index aa446a69f35c9..566e700dd043b 100644 --- a/docs/reference/ml/apis/start-datafeed.asciidoc +++ b/docs/reference/ml/apis/start-datafeed.asciidoc @@ -110,3 +110,4 @@ When the {dfeed} starts, you receive the following results: "started": true } ---- +// TESTRESPONSE \ No newline at end of file diff --git a/docs/reference/ml/apis/stop-datafeed.asciidoc b/docs/reference/ml/apis/stop-datafeed.asciidoc index 2cd9b9e0ce9d2..7ea48974f2df1 100644 --- a/docs/reference/ml/apis/stop-datafeed.asciidoc +++ b/docs/reference/ml/apis/stop-datafeed.asciidoc @@ -73,3 +73,4 @@ When the {dfeed} stops, you receive the following results: "stopped": true } ---- +// TESTRESPONSE \ No newline at end of file diff --git a/docs/reference/ml/apis/update-filter.asciidoc b/docs/reference/ml/apis/update-filter.asciidoc index abeb8aa7bf63e..f551c8e923b89 100644 --- a/docs/reference/ml/apis/update-filter.asciidoc +++ b/docs/reference/ml/apis/update-filter.asciidoc @@ -65,4 +65,4 @@ The API returns the following results: "items": ["*.google.com", "*.myorg.com"] } ---- - +// TESTRESPONSE diff --git a/docs/reference/ml/apis/validate-detector.asciidoc b/docs/reference/ml/apis/validate-detector.asciidoc index 69f5de8800f55..e525b1a1b2008 100644 --- a/docs/reference/ml/apis/validate-detector.asciidoc +++ b/docs/reference/ml/apis/validate-detector.asciidoc @@ -54,3 +54,4 @@ When the validation completes, you receive the following results: "acknowledged": true } ---- +// TESTRESPONSE \ No newline at end of file diff --git a/docs/reference/ml/apis/validate-job.asciidoc b/docs/reference/ml/apis/validate-job.asciidoc index 877db9ae3d86b..b83260582602e 100644 --- a/docs/reference/ml/apis/validate-job.asciidoc +++ b/docs/reference/ml/apis/validate-job.asciidoc @@ -65,3 +65,4 @@ When the validation is complete, you receive the following results: "acknowledged": true } ---- +// TESTRESPONSE \ No newline at end of file