[ML] Add documentation to rest spec (elastic/x-pack-elasticsearch#1756)

Original commit: elastic/x-pack-elasticsearch@7d7de84a5a
This commit is contained in:
Dimitris Athanasiou 2017-06-19 10:37:17 +01:00 committed by GitHub
parent 03652e7497
commit ae70a657dd
27 changed files with 27 additions and 0 deletions

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.close_job": { "xpack.ml.close_job": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-close-job.html",
"methods": [ "POST" ], "methods": [ "POST" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}/_close", "path": "/_xpack/ml/anomaly_detectors/{job_id}/_close",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.delete_datafeed": { "xpack.ml.delete_datafeed": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-delete-datafeed.html",
"methods": [ "DELETE" ], "methods": [ "DELETE" ],
"url": { "url": {
"path": "/_xpack/ml/datafeeds/{datafeed_id}", "path": "/_xpack/ml/datafeeds/{datafeed_id}",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.delete_job": { "xpack.ml.delete_job": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-delete-job.html",
"methods": [ "DELETE" ], "methods": [ "DELETE" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}", "path": "/_xpack/ml/anomaly_detectors/{job_id}",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.delete_model_snapshot": { "xpack.ml.delete_model_snapshot": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-delete-snapshot.html",
"methods": [ "DELETE" ], "methods": [ "DELETE" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", "path": "/_xpack/ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.flush_job": { "xpack.ml.flush_job": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-flush-job.html",
"methods": [ "methods": [
"POST" "POST"
], ],

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.get_buckets": { "xpack.ml.get_buckets": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-get-bucket.html",
"methods": [ "GET", "POST" ], "methods": [ "GET", "POST" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}", "path": "/_xpack/ml/anomaly_detectors/{job_id}/results/buckets/{timestamp}",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.get_categories": { "xpack.ml.get_categories": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-get-category.html",
"methods": [ "GET", "POST" ], "methods": [ "GET", "POST" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}/results/categories/{category_id}", "path": "/_xpack/ml/anomaly_detectors/{job_id}/results/categories/{category_id}",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.get_datafeed_stats": { "xpack.ml.get_datafeed_stats": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-get-datafeed-stats.html",
"methods": [ "GET"], "methods": [ "GET"],
"url": { "url": {
"path": "/_xpack/ml/datafeeds/{datafeed_id}/_stats", "path": "/_xpack/ml/datafeeds/{datafeed_id}/_stats",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.get_datafeeds": { "xpack.ml.get_datafeeds": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-get-datafeed.html",
"methods": [ "GET"], "methods": [ "GET"],
"url": { "url": {
"path": "/_xpack/ml/datafeeds/{datafeed_id}", "path": "/_xpack/ml/datafeeds/{datafeed_id}",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.get_influencers": { "xpack.ml.get_influencers": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-get-influencer.html",
"methods": [ "GET", "POST" ], "methods": [ "GET", "POST" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}/results/influencers", "path": "/_xpack/ml/anomaly_detectors/{job_id}/results/influencers",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.get_job_stats": { "xpack.ml.get_job_stats": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-get-job-stats.html",
"methods": [ "GET"], "methods": [ "GET"],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}/_stats", "path": "/_xpack/ml/anomaly_detectors/{job_id}/_stats",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.get_jobs": { "xpack.ml.get_jobs": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-get-job.html",
"methods": [ "GET"], "methods": [ "GET"],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}", "path": "/_xpack/ml/anomaly_detectors/{job_id}",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.get_model_snapshots": { "xpack.ml.get_model_snapshots": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-get-snapshot.html",
"methods": [ "GET", "POST" ], "methods": [ "GET", "POST" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}", "path": "/_xpack/ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.get_records": { "xpack.ml.get_records": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-get-record.html",
"methods": ["GET", "POST"], "methods": ["GET", "POST"],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}/results/records", "path": "/_xpack/ml/anomaly_detectors/{job_id}/results/records",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.open_job": { "xpack.ml.open_job": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-open-job.html",
"methods": [ "POST" ], "methods": [ "POST" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}/_open", "path": "/_xpack/ml/anomaly_detectors/{job_id}/_open",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.post_data": { "xpack.ml.post_data": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-post-data.html",
"methods": [ "POST" ], "methods": [ "POST" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}/_data", "path": "/_xpack/ml/anomaly_detectors/{job_id}/_data",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.preview_datafeed": { "xpack.ml.preview_datafeed": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-preview-datafeed.html",
"methods": [ "GET" ], "methods": [ "GET" ],
"url": { "url": {
"path": "/_xpack/ml/datafeeds/{datafeed_id}/_preview", "path": "/_xpack/ml/datafeeds/{datafeed_id}/_preview",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.put_datafeed": { "xpack.ml.put_datafeed": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-put-datafeed.html",
"methods": [ "PUT" ], "methods": [ "PUT" ],
"url": { "url": {
"path": "/_xpack/ml/datafeeds/{datafeed_id}", "path": "/_xpack/ml/datafeeds/{datafeed_id}",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.put_job": { "xpack.ml.put_job": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-put-job.html",
"methods": [ "PUT" ], "methods": [ "PUT" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}", "path": "/_xpack/ml/anomaly_detectors/{job_id}",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.revert_model_snapshot": { "xpack.ml.revert_model_snapshot": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-revert-snapshot.html",
"methods": [ "POST" ], "methods": [ "POST" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert", "path": "/_xpack/ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_revert",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.start_datafeed": { "xpack.ml.start_datafeed": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-start-datafeed.html",
"methods": [ "POST" ], "methods": [ "POST" ],
"url": { "url": {
"path": "/_xpack/ml/datafeeds/{datafeed_id}/_start", "path": "/_xpack/ml/datafeeds/{datafeed_id}/_start",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.stop_datafeed": { "xpack.ml.stop_datafeed": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-stop-datafeed.html",
"methods": [ "methods": [
"POST" "POST"
], ],

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.update_datafeed": { "xpack.ml.update_datafeed": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-update-datafeed.html",
"methods": [ "POST" ], "methods": [ "POST" ],
"url": { "url": {
"path": "/_xpack/ml/datafeeds/{datafeed_id}/_update", "path": "/_xpack/ml/datafeeds/{datafeed_id}/_update",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.update_job": { "xpack.ml.update_job": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-update-job.html",
"methods": [ "POST" ], "methods": [ "POST" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}/_update", "path": "/_xpack/ml/anomaly_detectors/{job_id}/_update",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.update_model_snapshot": { "xpack.ml.update_model_snapshot": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-update-snapshot.html",
"methods": [ "POST" ], "methods": [ "POST" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update", "path": "/_xpack/ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.validate": { "xpack.ml.validate": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-valid-job.html",
"methods": [ "POST" ], "methods": [ "POST" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/_validate", "path": "/_xpack/ml/anomaly_detectors/_validate",

View File

@ -1,5 +1,6 @@
{ {
"xpack.ml.validate_detector": { "xpack.ml.validate_detector": {
"documentation": "http://www.elastic.co/guide/en/x-pack/current/ml-valid-detector.html",
"methods": [ "POST" ], "methods": [ "POST" ],
"url": { "url": {
"path": "/_xpack/ml/anomaly_detectors/_validate/detector", "path": "/_xpack/ml/anomaly_detectors/_validate/detector",