Repository navigation
Docs/openapi spec - #166
Merged
Merged
Conversation
public/openapi.yaml describes every endpoint in the REST API section (uploads, results, flows, device sessions, IP addresses), served at https://docs.devicecloud.dev/openapi.yaml and linked from the overview. It is written from dcd/api, and responses captured from the dev API for all 30 operations validate against it. CI lints it with Redocly CLI 2.71.2 after the link check. redocly.yaml turns off three rules that don't fit: no license, no 4xx on GET /ip-addresses, and oneOf-of-required branches. CLAUDE.md asks for the spec to change with any page under api/. The overview's endpoint table also gains the Device Sessions row it was missing.
Found while writing the OpenAPI spec against the code. Handing back counts as a command, and a command's status and the human status count as reads. A rate-limited answer carries retry_after_s in the body rather than just saying how long to wait, and starting a session has no per-minute limit. Some errors (a malformed start, for one) have a message but no error code, and error responses mostly don't carry the session block.
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. 🤖 Generated with Claude Code |
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.
No description provided.