[Console] Update Console spec for ML APIs (#148433)

Update the autocomplete suggestions for the ML APIs in dev console.
This commit is contained in:
David Kyle 2023-01-10 19:58:35 +00:00 committed by GitHub
parent bd095f545b
commit ff406a55d1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
20 changed files with 108 additions and 17 deletions

View file

@ -0,0 +1,11 @@
{
"ml.clear_trained_model_deployment_cache": {
"methods": [
"POST"
],
"patterns": [
"_ml/trained_models/{model_id}/deployment/cache/_clear"
],
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/clear-trained-model-deployment-cache.html"
}
}

View file

@ -2,7 +2,6 @@
"ml.close_job": {
"url_params": {
"allow_no_match": "__flag__",
"allow_no_jobs": "__flag__",
"force": "__flag__",
"timeout": ""
},

View file

@ -2,7 +2,8 @@
"ml.delete_job": {
"url_params": {
"force": "__flag__",
"wait_for_completion": "__flag__"
"wait_for_completion": "__flag__",
"delete_user_annotations": "__flag__"
},
"methods": [
"DELETE"

View file

@ -1,5 +1,9 @@
{
"ml.delete_trained_model": {
"url_params": {
"timeout": "",
"force": "__flag__"
},
"methods": [
"DELETE"
],

View file

@ -1,8 +1,7 @@
{
"ml.get_datafeed_stats": {
"url_params": {
"allow_no_match": "__flag__",
"allow_no_datafeeds": "__flag__"
"allow_no_match": "__flag__"
},
"methods": [
"GET"

View file

@ -2,7 +2,6 @@
"ml.get_datafeeds": {
"url_params": {
"allow_no_match": "__flag__",
"allow_no_datafeeds": "__flag__",
"exclude_generated": "__flag__"
},
"methods": [

View file

@ -1,8 +1,7 @@
{
"ml.get_job_stats": {
"url_params": {
"allow_no_match": "__flag__",
"allow_no_jobs": "__flag__"
"allow_no_match": "__flag__"
},
"methods": [
"GET"

View file

@ -2,7 +2,6 @@
"ml.get_jobs": {
"url_params": {
"allow_no_match": "__flag__",
"allow_no_jobs": "__flag__",
"exclude_generated": "__flag__"
},
"methods": [

View file

@ -0,0 +1,16 @@
{
"ml.get_memory_stats": {
"url_params": {
"master_timeout": "",
"timeout": ""
},
"methods": [
"GET"
],
"patterns": [
"_ml/memory/_stats",
"_ml/memory/{nodes}/_stats"
],
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html"
}
}

View file

@ -0,0 +1,14 @@
{
"ml.get_model_snapshot_upgrade_stats": {
"url_params": {
"allow_no_match": "__flag__"
},
"methods": [
"GET"
],
"patterns": [
"_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade/_stats"
],
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html"
}
}

View file

@ -7,8 +7,7 @@
"exclude_interim": "__flag__",
"start": "",
"end": "",
"allow_no_match": "__flag__",
"allow_no_jobs": "__flag__"
"allow_no_match": "__flag__"
},
"methods": [
"GET",

View file

@ -1,5 +1,5 @@
{
"ml.infer_trained_model_deployment": {
"ml.infer_trained_model": {
"url_params": {
"timeout": ""
},
@ -7,8 +7,8 @@
"POST"
],
"patterns": [
"_ml/trained_models/{model_id}/deployment/_infer"
"_ml/trained_models/{model_id}/_infer"
],
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-infer-trained-model-deployment.html"
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html"
}
}

View file

@ -1,5 +1,9 @@
{
"ml.preview_datafeed": {
"url_params": {
"start": "",
"end": ""
},
"methods": [
"GET",
"POST"

View file

@ -1,5 +1,8 @@
{
"ml.put_trained_model": {
"url_params": {
"defer_definition_decompression": "__flag__"
},
"methods": [
"PUT"
],

View file

@ -0,0 +1,11 @@
{
"ml.put_trained_model_definition_part": {
"methods": [
"PUT"
],
"patterns": [
"_ml/trained_models/{model_id}/definition/{part}"
],
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html"
}
}

View file

@ -0,0 +1,11 @@
{
"ml.put_trained_model_vocabulary": {
"methods": [
"PUT"
],
"patterns": [
"_ml/trained_models/{model_id}/vocabulary"
],
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html"
}
}

View file

@ -1,7 +1,8 @@
{
"ml.reset_job": {
"url_params": {
"wait_for_completion": "__flag__"
"wait_for_completion": "__flag__",
"delete_user_annotations": "__flag__"
},
"methods": [
"POST"

View file

@ -1,7 +1,13 @@
{
"ml.start_trained_model_deployment": {
"url_params": {
"timeout": ""
"cache_size": "",
"number_of_allocations": 0,
"threads_per_allocation": 0,
"priority": "",
"queue_capacity": 0,
"timeout": "",
"wait_for": ""
},
"methods": [
"POST"
@ -9,6 +15,6 @@
"patterns": [
"_ml/trained_models/{model_id}/deployment/_start"
],
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-trained-model-deployment.html"
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trained-model-deployment.html"
}
}

View file

@ -1,11 +1,15 @@
{
"ml.stop_trained_model_deployment": {
"url_params": {
"allow_no_match": "__flag__",
"force": "__flag__"
},
"methods": [
"POST"
],
"patterns": [
"_ml/trained_models/{model_id}/deployment/_stop"
],
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-trained-model-deployment.html"
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/stop-trained-model-deployment.html"
}
}

View file

@ -0,0 +1,11 @@
{
"ml.update_trained_model_deployment": {
"methods": [
"POST"
],
"patterns": [
"_ml/trained_models/{model_id}/deployment/_update"
],
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-trained-model-deployment.html"
}
}