Add menu screen and input endpoints to OpenAPI specification#9
Open
chrisgleissner wants to merge 5 commits into
Open
Add menu screen and input endpoints to OpenAPI specification#9chrisgleissner wants to merge 5 commits into
chrisgleissner wants to merge 5 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the OpenAPI specifications to expand device/machine control capabilities and normalize parts of the spec formatting.
Changes:
- Added new machine-control endpoints (menu screen readout, REST input injection) and an
/infoendpoint. - Introduced/expanded reusable schemas for binary menu-screen payloads and input event/state payloads.
- Normalized several response-code keys/formatting and refactored some inline schemas into component refs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| u2plus-open-api-spec.yaml | Adds /info, menu-control/input endpoints, and refactors portions of response schemas/formatting. |
| Ultimate_OpenAPI_specs.yaml | Adds shared schemas and documents menu-screen + input endpoints under machine control. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…pportd for that device due to hardware limitations.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi,
thanks for maintaining these specs.
This PR adds the new REST endpoints from my Ultimate 64 / U2 firmware work, as documented in GideonZ/1541u-documentation#27:
GET /machine:menu_screenGET /machine:input(U64-based devices only due to hardware constraints as per Gideon)POST /machine:input(same)Some Notes:
masteron the 1541ultimate firmware repo, but the input change is already intest-merge(precursor to being merged tomaster), and I hope themenu_buttonwill follow once Gideon will have had the time to review.{}as well as{ }), and to avoid blanks in otherwise empty lines.modinstead ofmodeas specified in Gideon's official docs. I changed that tomode.One related question: would there be interest in maintaining these OpenAPI files directly in
GideonZ/1541u-documentation? That would let the human and machine-readable REST docs evolve in lock step, and avoid needing multiple PRs for the same API changes.Many thanks and best wishes
Christian