Skip to content

Commit 5f869ea

Browse files
docs(robot-server): Exclude /labwareOffsets endpoints from docs (#17219)
1 parent 0fa2cfc commit 5f869ea

File tree

1 file changed

+4
-0
lines changed
  • robot-server/robot_server/labware_offsets

1 file changed

+4
-0
lines changed

robot-server/robot_server/labware_offsets/router.py

+4
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
"""
4343
),
4444
status_code=201,
45+
include_in_schema=False, # todo(mm, 2025-01-08): Include for v8.4.0.
4546
)
4647
async def post_labware_offset( # noqa: D103
4748
store: Annotated[LabwareOffsetStore, fastapi.Depends(get_labware_offset_store)],
@@ -72,6 +73,7 @@ async def post_labware_offset( # noqa: D103
7273
" Filters are ANDed together."
7374
" Results are returned in order from oldest to newest."
7475
),
76+
include_in_schema=False, # todo(mm, 2025-01-08): Include for v8.4.0.
7577
)
7678
async def get_labware_offsets( # noqa: D103
7779
store: Annotated[LabwareOffsetStore, fastapi.Depends(get_labware_offset_store)],
@@ -163,6 +165,7 @@ async def get_labware_offsets( # noqa: D103
163165
path="/labwareOffsets/{id}",
164166
summary="Delete a single labware offset",
165167
description="Delete a single labware offset. The deleted offset is returned.",
168+
include_in_schema=False, # todo(mm, 2025-01-08): Include for v8.4.0.
166169
)
167170
async def delete_labware_offset( # noqa: D103
168171
store: Annotated[LabwareOffsetStore, fastapi.Depends(get_labware_offset_store)],
@@ -185,6 +188,7 @@ async def delete_labware_offset( # noqa: D103
185188
router.delete,
186189
path="/labwareOffsets",
187190
summary="Delete all labware offsets",
191+
include_in_schema=False, # todo(mm, 2025-01-08): Include for v8.4.0.
188192
)
189193
async def delete_all_labware_offsets( # noqa: D103
190194
store: Annotated[LabwareOffsetStore, fastapi.Depends(get_labware_offset_store)]

0 commit comments

Comments
 (0)