feat(api,robot-server): export notes on commands #14616
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## edge #14616 +/- ##
=======================================
Coverage 67.47% 67.47%
=======================================
Files 2484 2484
Lines 71316 71316
Branches 9085 9085
=======================================
Hits 48120 48120
Misses 21040 21040
Partials 2156 2156
Flags with carried forward coverage won't be shown. Click here to find out more.
|
sfoster1
force-pushed
the
exec-288-add-notes-to-runs
branch
from
85917ea
to
3a2f22a
Compare
| @@ -176,6 +176,13 @@ class BaseCommand(GenericModel, Generic[CommandParamsT, CommandResultT]): | |||
| " a command that is part of a calibration procedure." | |||
| ), | |||
| ) | |||
| notes: Optional[List[CommandNote]] = Field( | |||
There was a problem hiding this comment.
Will the ordering of the notes end up being important?
DerekMaggio
dismissed
their stale review
Removing review. There is a requirement in the ticket about being able to send 0 or more notes over the wire for this to be done.
I am not familiar enough with the Protocol Engine to confirm that this is happening.
Going to look into it more Monday, will re-review then
There was a problem hiding this comment.
Did some digging to ensure that the requirements of the ticket are being met. Commands are sent via HTTP, with a note attached, the note is validated by querying for said command, and then checking its value.
Approval, on the condition that all tests and stuff end up passing
Commands in runs can have notes attached to them. Each command can have zero or more notes, and zero notes can be expressed as any of (notes=None, notes is-not-present, notes is empty-list). This is to make the public models a little more robust across versions. Closes EXEC-288
sfoster1
force-pushed
the
exec-288-add-notes-to-runs
branch
from
3a2f22a
to
8631990
Compare
We do not, because the commands schema actually contains the |
Commands in runs can have notes attached to them. Each command can have zero or more notes, and zero notes can be expressed as any of (notes=None, notes is-not-present, notes is empty-list). This is to make the public models a little more robust across versions. Closes EXEC-288
Commands in runs can have notes attached to them. Each command can have zero or more notes, and zero notes can be expressed as any of (notes=None, notes is-not-present, notes is empty-list). This is to make the public models a little more robust across versions.
Closes EXEC-288