Repository navigation
docs(api): pin the r9cam schema to v0.8.1 - #529
Merged
Merged
Conversation
v0.8.0 was tagged but never published, so v0.8.1 is the first release with its changes. The schema only gains fields: the CaptureRole enum, capture_role, session_id and raw_sha256 on the capture metadata, and the role and session_id query parameters on POST /captures. r9cam-models 0.7.0, the floor in backend/pyproject.toml, already carries them. The file is the unmodified openapi.r9cam.json of the v0.8.1 tag. Signed-off-by: Simon van Lierde <90462640+simonvanlierde@users.noreply.github.com>
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.
Pull Request
Summary
Pins the docs' r9cam schema to v0.8.1 and refreshes
openapi.r9cam.json. It was on v0.7.2.Type of change
Why
The API docs still describe r9cam 0.7.2, but the backend already reads the new capture fields through
r9cam-models0.7.0. v0.8.0 was tagged and never published, so v0.8.1 is the first release that carries them.Checklist
just ci)just test)Security, if relevant
Not relevant: a pin and a generated JSON file.
Notes for reviewers
CaptureRoleenum,capture_role,session_idandraw_sha256on the capture metadata, and theroleandsession_idquery parameters onPOST /captures.openapi.r9cam.jsonof the v0.8.1 tag.r9cam-models>=0.7.0,<0.8inbackend/pyproject.tomlstays as it is.Tested:
curlof the v0.8.1 file diffs clean against the committed one,pnpm buildindocs/builds 34 pages, andpnpm testpasses 22 tests.Not checked:
just ci, the backend tests and the e2e and link checks did not run.