[DOCS] Adds delete forecast API #33401
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Pinging @elastic/ml-core |
benwtrent
reviewed
Sep 5, 2018
|
|
||
| `forecast_id`:: | ||
| (string) A comma-separated list of forecast identifiers. | ||
| //TBD: Can this ID be retrieved somehow? |
There was a problem hiding this comment.
ID is only available from the initial creation of the forecast.
This API is most likely be utilized from the UI (and they know how to gather and display forecasts from the .ml-shared index, or as an "oops, I created a forecast via API with the wrong settings".
There was a problem hiding this comment.
OK, so there are no immediate plans for a "GET forecasts" API?
benwtrent
reviewed
Sep 5, 2018
| `allow_no_forecasts`:: | ||
| (boolean) Whether to ignore if `_all` matches no forecasts. | ||
| //TBD: This description is unclear. Does this mean that if this parameter is | ||
| //false and there are no forecasts in the job, an error is returned? |
There was a problem hiding this comment.
Correct, if _all finds that there are NO forecasts, then an error is returned when this is false. Rare use case for sure, but is consistent with other APIs that allow this type of interaction.
benwtrent
reviewed
Sep 5, 2018
| `timeout`:: | ||
| (time units) Controls the time to wait until the forecasts are deleted. | ||
| Defaults to 30 seconds. For more information about time units, see <<time-units>>. | ||
| //TBD: This description is unclear. Is it the time to wait until the deletion |
There was a problem hiding this comment.
This is to wait for the deletion to be complete.
lcawl
force-pushed
the
lcawley-delete-forecast
branch
from
b808bf4
to
c8423ae
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to #33218 and #31134