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.

Sign up for GitHub

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

feat(shared-data): Add "$otSharedSchema" property to labware schema 3 #17421

Draft
wants to merge 8 commits into
base: edge
Choose a base branch
from
+140 −60
Draft

feat(shared-data): Add "$otSharedSchema" property to labware schema 3 #17421

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a062ee1
Add $otSharedSchema required property to labware schema.
SyntaxColoring Jan 30, 2025
743d2c2
Update labware definitions.
SyntaxColoring Jan 30, 2025
faec36c
Update labware test fixtures.
SyntaxColoring Jan 30, 2025
faba464
Update Python and TypeScript bindings.
SyntaxColoring Feb 4, 2025
8e2e01f
fix(analyses-snapshot-testing): heal identify_labware_defs snapshots …
github-actions[bot] Feb 5, 2025
a28c175
Grammar.
SyntaxColoring Feb 5, 2025
ed3456a
Revert "fix(analyses-snapshot-testing): heal identify_labware_defs sn…
SyntaxColoring Feb 10, 2025
cd1aadf
Merge branch 'edge' into identify_labware_defs
SyntaxColoring Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions ...est/test_analysis_snapshot[2b866b03f3][Flex_S_v2_21_P1000_96_GRIP_HS_MB_TC_TM_Smoke].json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1240,6 +1240,7 @@
},
"result": {
"definition": {
"$otSharedSchema": "#/labware/schemas/3",
Copy link
Contributor Author

@SyntaxColoring SyntaxColoring Feb 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's surprising to me that any analysis snapshots need to change. These are for PAPIv2.21 protocols. PAPIv2.21
was released in robot software v8.2.0. Are schema 3 labware already being used in the wild? Because my understanding was that schema 3 was not ready for that.

It's a bummer if that's the case because it means it'll be difficult to make breaking schema changes. And if we can't make any breaking schema changes then we may as well have stayed on schema 2 in the first place.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. It looks like the answer to this is that these labware have only a schema v3 definition:

  • evotips_flex_96_tiprack_adapter
  • evotips_opentrons_96_labware
  • opentrons_tough_pcr_auto_sealing_lid
  • protocol_engine_lid_stack_object
  • opentrons_flex_tiprack_lid

and what's in these analyses is the thermocycler lid. these haven't shipped yet, so as long as we make sure there's v2 definitions in 8.3 before it ships we're good.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For posterity: the above is EXEC-1179 + EXEC-1180.

"allowedRoles": [
"labware",
"lid"
Expand Down Expand Up @@ -1398,6 +1399,7 @@
},
"result": {
"definition": {
"$otSharedSchema": "#/labware/schemas/3",
"allowedRoles": [
"labware",
"lid"
Expand Down Expand Up @@ -1556,6 +1558,7 @@
},
"result": {
"definition": {
"$otSharedSchema": "#/labware/schemas/3",
"allowedRoles": [
"labware",
"lid"
Expand Down Expand Up @@ -1714,6 +1717,7 @@
},
"result": {
"definition": {
"$otSharedSchema": "#/labware/schemas/3",
"allowedRoles": [
"labware",
"lid"
Expand Down Expand Up @@ -1872,6 +1876,7 @@
},
"result": {
"definition": {
"$otSharedSchema": "#/labware/schemas/3",
"allowedRoles": [
"labware",
"lid"
Expand Down
5 changes: 5 additions & 0 deletions ..._snapshot_test/test_analysis_snapshot[7d16d5dbf0][Flex_X_v2_21_tc_lids_wrong_target].json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1925,6 +1925,7 @@
},
"result": {
"definition": {
"$otSharedSchema": "#/labware/schemas/3",
"allowedRoles": [
"labware",
"lid"
Expand Down Expand Up @@ -2083,6 +2084,7 @@
},
"result": {
"definition": {
"$otSharedSchema": "#/labware/schemas/3",
"allowedRoles": [
"labware",
"lid"
Expand Down Expand Up @@ -2241,6 +2243,7 @@
},
"result": {
"definition": {
"$otSharedSchema": "#/labware/schemas/3",
"allowedRoles": [
"labware",
"lid"
Expand Down Expand Up @@ -2399,6 +2402,7 @@
},
"result": {
"definition": {
"$otSharedSchema": "#/labware/schemas/3",
"allowedRoles": [
"labware",
"lid"
Expand Down Expand Up @@ -2557,6 +2561,7 @@
},
"result": {
"definition": {
"$otSharedSchema": "#/labware/schemas/3",
"allowedRoles": [
"labware",
"lid"
Expand Down
3 changes: 3 additions & 0 deletions ...es_snapshot_test/test_analysis_snapshot[99c15c6c62][Flex_S_v2_21_tc_lids_happy_path].json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
},
"result": {
"definition": {
"$otSharedSchema": "#/labware/schemas/3",
"allowedRoles": [
"labware",
"lid"
Expand Down Expand Up @@ -255,6 +256,7 @@
},
"result": {
"definition": {
"$otSharedSchema": "#/labware/schemas/3",
"allowedRoles": [
"labware",
"lid"
Expand Down Expand Up @@ -413,6 +415,7 @@
},
"result": {
"definition": {
"$otSharedSchema": "#/labware/schemas/3",
"allowedRoles": [
"labware",
"lid"
Expand Down
1 change: 1 addition & 0 deletions shared-data/js/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,7 @@ export interface LabwareDefinition2 {

export interface LabwareDefinition3 {
version: number
$otSharedSchema: '#/labware/schemas/3'
schemaVersion: 3
namespace: string
metadata: LabwareMetadata
Expand Down
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/agilent_1_reservoir_290ml/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/appliedbiosystemsmicroamp_384_wellplate_40ul/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4726,5 +4726,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/armadillo_96_wellplate_200ul_pcr_full_skirt/3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1163,5 +1163,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/axygen_1_reservoir_90ml/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/biorad_384_wellplate_50ul/3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4737,5 +4737,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/biorad_96_wellplate_200ul_pcr/3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1178,5 +1178,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/corning_12_wellplate_6.9ml_flat/3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,5 +201,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/corning_24_wellplate_3.4ml_flat/3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,5 +333,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/corning_384_wellplate_112ul_flat/3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5112,5 +5112,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/corning_48_wellplate_1.6ml_flat/3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -601,5 +601,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/corning_6_wellplate_16.8ml_flat/3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,5 +125,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/corning_96_wellplate_360ul_flat/3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1168,5 +1168,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/nest_12_reservoir_15ml/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,5 +222,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/nest_1_reservoir_195ml/3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,5 +79,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/nest_1_reservoir_290ml/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/nest_96_wellplate_100ul_pcr_full_skirt/3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1157,5 +1157,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/nest_96_wellplate_200ul_flat/3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1136,5 +1136,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/nest_96_wellplate_2ml_deep/3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1258,5 +1258,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/opentrons_10_tuberack_falcon_4x50ml_6x15ml_conical/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,5 +228,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion ...a/labware/definitions/3/opentrons_10_tuberack_falcon_4x50ml_6x15ml_conical_acrylic/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,5 +226,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/opentrons_10_tuberack_nest_4x50ml_6x15ml_conical/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,5 +231,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/opentrons_15_tuberack_falcon_15ml_conical/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,5 +255,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/opentrons_15_tuberack_nest_15ml_conical/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,5 +247,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/opentrons_24_aluminumblock_generic_2ml_screwcap/3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,5 +326,6 @@
"conicalWell": {
"sections": []
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/opentrons_24_aluminumblock_nest_0.5ml_screwcap/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,5 +366,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/opentrons_24_aluminumblock_nest_1.5ml_screwcap/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,5 +352,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/opentrons_24_aluminumblock_nest_1.5ml_snapcap/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,5 +347,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/opentrons_24_aluminumblock_nest_2ml_screwcap/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,5 +346,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/opentrons_24_aluminumblock_nest_2ml_snapcap/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,5 +375,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion ...-data/labware/definitions/3/opentrons_24_tuberack_eppendorf_1.5ml_safelock_snapcap/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,5 +414,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion ...ed-data/labware/definitions/3/opentrons_24_tuberack_eppendorf_2ml_safelock_snapcap/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -469,5 +469,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion ...labware/definitions/3/opentrons_24_tuberack_eppendorf_2ml_safelock_snapcap_acrylic/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,5 +334,6 @@
"conicalWell": {
"sections": []
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion ...ed-data/labware/definitions/3/opentrons_24_tuberack_generic_0.75ml_snapcap_acrylic/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,5 +323,6 @@
"conicalWell": {
"sections": []
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/opentrons_24_tuberack_generic_2ml_screwcap/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,5 +347,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/opentrons_24_tuberack_nest_0.5ml_screwcap/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,5 +367,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
3 changes: 2 additions & 1 deletion shared-data/labware/definitions/3/opentrons_24_tuberack_nest_1.5ml_screwcap/2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,5 +353,6 @@
}
]
}
}
},
"$otSharedSchema": "#/labware/schemas/3"
}
Loading
Loading