[YUNIKORN-2217] Add Missing REST Endpoint description for batch event in documentation #379
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
… in documentation
pbacsko
requested changes
Jan 25, 2024
There was a problem hiding this comment.
Also document the URL query parameters:
count: maximum number of events in the responsestart: the start ID of the events
eg. localhost:9080/ws/v1/events/batch?start=200&count=1000
If the ID is not in the ring buffer (too low or too high), then the response contains the current lowest and highest ID in the response with EventRecords being empty.
github-actions bot
pushed a commit
that referenced
this pull request
Jan 26, 2024
…or batch event in documentation (#379)
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.
What is this PR for?
Adds documentation for the /ws/v1/events/batch API endpoint.
What type of PR is it?
What is the Jira issue?
https://issues.apache.org/jira/browse/YUNIKORN-2217