Skip to content

chore: update openapi schema to examples from example #1321

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

Merged
ZohebShaikh merged 1 commit into from
Jan 5, 2026
Merged

chore: update openapi schema to examples from example #1321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions docs/reference/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ info:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
title: BlueAPI Control
version: 1.1.1
version: 1.1.2
openapi: 3.1.0
paths:
/config/oidc:
Expand Down Expand Up @@ -596,14 +596,14 @@ paths:
requestBody:
content:
application/json:
example:
instrument_session: cm12345-1
name: count
params:
detectors:
- x
schema:
$ref: '#/components/schemas/TaskRequest'
examples:
- instrument_session: cm12345-1
name: count
params:
detectors:
- x
required: true
responses:
'201':
Expand Down
4 changes: 2 additions & 2 deletions src/blueapi/service/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
from .runner import WorkerDispatcher

#: API version to publish in OpenAPI schema
REST_API_VERSION = "1.1.1"
REST_API_VERSION = "1.1.2"

LICENSE_INFO: dict[str, str] = {
"name": "Apache 2.0",
Expand Down Expand Up @@ -298,7 +298,7 @@ def get_device_by_name(
def submit_task(
request: Request,
response: Response,
task_request: Annotated[TaskRequest, Body(..., example=example_task_request)],
task_request: Annotated[TaskRequest, Body(..., examples=[example_task_request])],
runner: Annotated[WorkerDispatcher, Depends(_runner)],
) -> TaskResponse:
"""Submit a task to the worker."""
Expand Down