Skip to content

Commit 5fbb80f

Browse files
authored
Add summaries for machine learning APIs (#2453)
1 parent d555c1a commit 5fbb80f

File tree

7 files changed

+25
-25
lines changed

7 files changed

+25
-25
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 10 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/ml/close_job/MlCloseJobRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import { Id } from '@_types/common'
2222
import { Duration } from '@_types/Time'
2323

2424
/**
25-
* Close anomaly detection jobs
25+
* Close anomaly detection jobs.
2626
* A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
2727
* When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
2828
* If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.

specification/ml/delete_job/MlDeleteJobRequest.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ import { RequestBase } from '@_types/Base'
2121
import { Id } from '@_types/common'
2222

2323
/**
24-
* Deletes an anomaly detection job.
25-
*
24+
* Delete an anomaly detection job.
2625
* All job configuration, model state and results are deleted.
2726
* It is not currently possible to delete multiple jobs using wildcards or a
2827
* comma separated list. If you delete a job that has a datafeed, the request

0 commit comments

Comments
 (0)