Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a critical issue where the API reference link in the documentation was incorrectly formed, leading to build failures in both local development environments and CI/CD pipelines. By adjusting the relative path, the documentation now builds successfully, ensuring that the API reference is accessible and the project's documentation workflows remain operational.

Highlights

• Broken Link Fix: Corrected the API reference link path in docs/rest-api.md by removing the ../ prefix, which was causing mkdocs build --strict to abort with a warning and breaking GitHub Pages and PR Preview workflows.

Dependency Review

Scanned Files

No actionable comments were generated in the recent review. 🎉

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.64%. Comparing base (77cdbcc) to head (3827707).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

@@           Coverage Diff           @@
##             main     #320   +/-   ##
=======================================
  Coverage   93.64%   93.64%           
=======================================
  Files         427      427           
  Lines       19177    19177           
  Branches     1846     1846           
=======================================
  Hits        17959    17959           
  Misses        943      943           
  Partials      275      275           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Greptile Summary

This PR fixes a broken hyperlink in docs/rest-api.md by removing the ../ prefix from the path to the generated Scalar API reference page. The scripts/export_openapi.py script writes its output to docs/_generated/api-reference.html, which is inside the MkDocs docs/ root. Because rest-api.md sits at the top level of the docs tree, the correct relative path is _generated/api-reference.html — not ../_generated/api-reference.html, which escaped the docs directory and caused MkDocs --strict to abort.

• Root cause confirmed: scripts/export_openapi.py sets OUTPUT_DIR = REPO_ROOT / "docs" / "_generated", placing the file at docs/_generated/api-reference.html — inside the MkDocs source tree.
• Impact of the bug: The ../ prefix resolved to the repository root (outside docs/), triggering a MkDocs warning that failed both the GitHub Pages and PR Preview CI workflows when run with --strict.
• Fix: The one-character path correction (../_generated/ → _generated/) is minimal and precisely targeted.

Confidence Score: 5/5

• This PR is safe to merge — it is a single, verified path correction with no functional logic changes.
• The change is a one-line documentation fix. Cross-referencing scripts/export_openapi.py confirms the generated file lives at docs/_generated/api-reference.html, exactly matching the corrected link. No logic, no dependencies, and no risk of regression.
• No files require special attention.

Important Files Changed

Sequence Diagram

sequenceDiagram
    participant CI as CI Workflow
    participant Script as scripts/export_openapi.py
    participant DocsDir as docs/_generated/
    participant MkDocs as mkdocs build --strict
    participant Site as _site/docs/

    CI->>Script: uv run python scripts/export_openapi.py
    Script->>DocsDir: writes api-reference.html
    Script->>DocsDir: writes openapi.json
    CI->>MkDocs: uv run mkdocs build --strict
    MkDocs->>DocsDir: resolves _generated/api-reference.html ✅
    Note over MkDocs,DocsDir: Previously: ../_generated/ escaped docs/ root → warning/abort
    MkDocs->>Site: copies _generated/api-reference.html to output

_{Last reviewed commit: 3827707}