Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HTTP protocol: command status of engine-backed protocol session #7871

Closed
2 tasks
mcous opened this issue Jun 3, 2021 · 0 comments · Fixed by #8006
Closed
2 tasks

HTTP protocol: command status of engine-backed protocol session #7871

mcous opened this issue Jun 3, 2021 · 0 comments · Fixed by #8006
Assignees
Labels
protocol-engine Ticket related to the Protocol Engine project and associated HTTP APIs robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience).
Milestone

Comments

@mcous
Copy link
Contributor

mcous commented Jun 3, 2021

Overview

As an HTTP API user, I would like to know the status of the individual commands in my protocol session so that I can monitor the run.

Acceptance Criteria

  • Endpoints
    • GET /sessions - update Session response to include commands
    • GET /sessions/{session_id} - update Session response to include commands
    • GET /sessions/{session_id}/commands - new endpoint
    • GET /sessions/{session_id}/commands/{command_id} - new endpoint
  • Command information includes:
    • Unique ID
    • Type
    • Status (ready to run, running, finished, failed)
    • Payload data
    • Result data
    • Lifecycle timestamps

Implementation Notes

  • For /sessions and /sessions/commands, we may want limit the response to simply command IDs; otherwise it could become a huge response
  • This story will be easier if we refactor and simplify the Protocol Engine command model so that they can be dropped into responses more-or-less verbatim
  • Likewise, this story might be easier if we refactor Protocol Engine state to be more directly usable by protocol engine callers
    • e.g. if the backing state dataclass is usable by a caller, then the internal protocol engine selectors don't necessarily need to grow every time we need a new piece of functionality
@mcous mcous added the robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). label Jun 3, 2021
@mcous mcous changed the title HTTP protocol: run status of engine-backed protocol session HTTP protocol: command status of engine-backed protocol session Jun 3, 2021
@mattwelch mattwelch added the protocol-engine Ticket related to the Protocol Engine project and associated HTTP APIs label Jun 10, 2021
@mattwelch mattwelch added this to the CPX Sprint 35 milestone Jun 15, 2021
@mcous mcous self-assigned this Jun 24, 2021
mcous added a commit that referenced this issue Jun 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
protocol-engine Ticket related to the Protocol Engine project and associated HTTP APIs robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience).
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants