Adds missing doc details for ML get calendar APIs#852
Merged
sethmlarson merged 5 commits intoelastic:mainfrom Nov 4, 2021
lcawl:docs-get-calendars
Merged
Adds missing doc details for ML get calendar APIs#852sethmlarson merged 5 commits intoelastic:mainfrom lcawl:docs-get-calendars
sethmlarson merged 5 commits intoelastic:mainfrom
lcawl:docs-get-calendars
Conversation
This was referenced Oct 7, 2021
Contributor
droberts195
added a commit
to droberts195/elasticsearch
that referenced
this pull request
Oct 11, 2021
The docs for the get scheduled events endpoint stated that the arguments could be sent in a request body instead of in URL arguments. The spec was inconsistent with this. Additionally, GET endpoints that allow a request body need to support POST too, for the benefit of clients that do not support GETs with bodies. This change adds the option to POST a get scheduled events request and adjusts the spec to permit this. Relates to elastic/elasticsearch-specification#852
Contributor
|
This is blocked on elastic/elasticsearch#79271 |
Contributor
Author
|
@sethmlarson per your discussion in elastic/elasticsearch#78923, it seems like we'll need to add an exception ( re #831) for these APIs. Is that feasible? |
sethmlarson
reviewed
Nov 3, 2021
sethmlarson
reviewed
Nov 3, 2021
sethmlarson
suggested changes
Nov 3, 2021
Contributor
sethmlarson
left a comment
There was a problem hiding this comment.
Left two comments about the request body of ml.get_calendars
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR updates get_calendar_events and get_calendars with info from the documentation (https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-get-calendar-event.html, https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-get-calendar.html).
NOTE: The request body is omitted from the get calendar events API, per elastic/elasticsearch#79271