docs(robot-server): Correct and unify the definition of "current" #15223
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.
Overview
This tries to resolve some confusion around the
cursor
query parameter andlinks.current
field in theGET /runs/{id}/commands
andGET /maintenance_runs/{id}/commands
endpoints.Test plan
None needed.
Changelog
links.current
is a bit confusing:Compare with the
cursor
query param ofGET /runs/{id}/commands
, which appears consistent about returning the currently running or most recently completed command.This PR changes the OpenAPI spec of
links.current
to say it's the currently running or most recently completed command. This unifies everything. I'm working under the premise that this reflects what we have now, and it's working fine, and we have no reason to change it.Review requests
Am I misreading the
StateView.get_slice()
andStateView.get_current()
implementation logic and misunderstanding the current behavior?If this is the current behavior, is my premise correct that it's fine and we have no reason to change it?
Risk assessment
No risk.