Skip to content

fix: regenerate OpenAPI spec from gateway schema fixes#18

Merged
bburda merged 2 commits intomainfrom
fix/17-regenerate-schemas
Mar 31, 2026
Merged

fix: regenerate OpenAPI spec from gateway schema fixes#18
bburda merged 2 commits intomainfrom
fix/17-regenerate-schemas

Conversation

@bburda
Copy link
Copy Markdown
Contributor

@bburda bburda commented Mar 31, 2026

Summary

Regenerated spec/openapi.yaml from gateway with all schema fixes from selfpatch/ros2_medkit#329. Bumped both client package versions to 0.1.1.

Key spec changes

  • Lock endpoints: AcquireLockRequest/ExtendLockRequest with integer lock_expiration, X-Client-Id header documented
  • PUT /locks/{id}: 204 No Content (was 200 + Lock)
  • New schemas: DataWriteRequest, ExecutionUpdateRequest, ScriptControlRequest
  • ScriptMetadata.parameters_schema now nullable
  • x-medkit fields: additionalProperties: true
  • trigger_condition: additionalProperties: true
  • LogConfiguration: optional fields, severity_filter enum, bounds
  • All routes accept optional trailing slash

Testing

  • TypeScript: npm run build + 54 vitest tests pass
  • Python: 90 pytest tests pass
  • Spec exported from live gateway running with all schema fixes

Regenerated spec/openapi.yaml from gateway with all schema fixes from
selfpatch/ros2_medkit#329. Bumped both client package versions to 0.1.1.

Key spec changes:
- Lock endpoints: AcquireLockRequest/ExtendLockRequest with integer
  lock_expiration, X-Client-Id header documented
- PUT /locks/{id}: 204 No Content (was 200 + Lock)
- New schemas: DataWriteRequest, ExecutionUpdateRequest,
  ScriptControlRequest with proper field types and enums
- ScriptMetadata.parameters_schema now nullable
- x-medkit fields: additionalProperties: true
- trigger_condition: additionalProperties: true
- LogConfiguration: optional fields, severity_filter enum, bounds
- All routes accept optional trailing slash
Copilot AI review requested due to automatic review settings March 31, 2026 17:33
@mfaferek93 mfaferek93 self-requested a review March 31, 2026 17:36
mfaferek93
mfaferek93 previously approved these changes Mar 31, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Regenerates the repository’s static OpenAPI specification from the gateway’s updated schema definitions, and bumps both TypeScript and Python client package versions to reflect the updated API contract.

Changes:

  • Regenerated spec/openapi.yaml with updated lock endpoints, new request schemas, and schema fixes (nullable fields, additionalProperties, LogConfiguration constraints).
  • Updated lock endpoints to document X-Client-Id header behavior and changed lock extension responses to 204 No Content.
  • Bumped TypeScript and Python client package versions to 0.1.1.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.

File Description
spec/openapi.yaml Updates the OpenAPI 3.1 spec to match gateway schema fixes and endpoint contract changes.
clients/typescript/package.json Bumps TS client package version to 0.1.1.
clients/typescript/package-lock.json Keeps lockfile in sync with the TS package version bump.
clients/python/pyproject.toml Bumps Python client package version to 0.1.1.
Files not reviewed (1)
  • clients/typescript/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@bburda bburda merged commit b4ade2f into main Mar 31, 2026
6 checks passed
@bburda bburda deleted the fix/17-regenerate-schemas branch March 31, 2026 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Regenerate OpenAPI spec after gateway schema fixes (ros2_medkit#328)

3 participants