Skip to content

docs(api): pin the r9cam schema to v0.8.1 - #529

Merged
simonvanlierde merged 1 commit into
mainfrom
docs-r9cam-schema-v0-8-1
Nov 16, 2026
Merged

simonvanlierde merged 1 commit into
mainfrom
docs-r9cam-schema-v0-8-1

Conversation

@simonvanlierde

Copy link
Copy Markdown
Contributor

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

  • 🚀 feat: New feature
  • 🐛 fix: Bug fix
  • 🛠️ build: Build system or dependency changes
  • 🔄 ci: CI configuration changes
  • 📚 docs: Documentation only changes
  • 🏎️ perf: Performance improvement
  • ♻️ refactor: Code refactoring (no functional changes)
  • 🎨 style: Code style/formatting changes
  • ✅ test: Adding or updating tests
  • 🔧 chore: Other maintenance work

Why

The API docs still describe r9cam 0.7.2, but the backend already reads the new capture fields through r9cam-models 0.7.0. v0.8.0 was tagged and never published, so v0.8.1 is the first release that carries them.

Checklist

  • I've read the contributing guidelines
  • Code follows style guidelines and passes quality checks (just ci)
  • Unit tests added/updated and passing locally (just test)
  • Documentation updated (if applicable)
  • Database migrations created (if applicable)

Security, if relevant

Not relevant: a pin and a generated JSON file.

Notes for reviewers

  • 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.
  • The file is the unmodified openapi.r9cam.json of the v0.8.1 tag.
  • r9cam-models>=0.7.0,<0.8 in backend/pyproject.toml stays as it is.

Tested: curl of the v0.8.1 file diffs clean against the committed one, pnpm build in docs/ builds 34 pages, and pnpm test passes 22 tests.

Not checked: just ci, the backend tests and the e2e and link checks did not run.

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>
@simonvanlierde
simonvanlierde merged commit 183c972 into main Nov 16, 2026
20 checks passed
@simonvanlierde
simonvanlierde deleted the docs-r9cam-schema-v0-8-1 branch November 16, 2026 01:49
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.

1 participant