Skip to content

Add API Reference to docs navigation#127

Open
beran-t wants to merge 39 commits intomainfrom
add-api-ref-to-nav
Open

Add API Reference to docs navigation#127
beran-t wants to merge 39 commits intomainfrom
add-api-ref-to-nav

Conversation

@beran-t
Copy link
Contributor

@beran-t beran-t commented Feb 23, 2026

Summary

  • Add OpenAPI-based API Reference anchor to docs.json navigation, using openapi-public.yml as the spec source
  • Include the openapi-public.yml spec file
  • Hide deprecated badges in sidebar via custom CSS to prevent endpoint name truncation
  • Add generation script (scripts/generate_openapi_reference.py)
  • Add validation script (scripts/validate_api_reference.py)
  • Add workflow for creating pr if docs change

beran-t added 20 commits March 3, 2026 15:30
…points, add status mismatch catch-all

- Change DELETE /templates/{templateID} cleanup expected status from 200 to 204
- Remove POST /init test (internal endpoint, not in public spec)
- Remove unauthenticated 401 tests to avoid load balancer rate limiting
- Use account-owned template alias instead of hardcoded 'base' for alias test
- Send no-op Update to process instead of PTY resize (avoids 500 on non-PTY process)
- Add post-processing catch-all that flags any tested endpoint with unexpected status code
…hase 3, update workflow

- Remove 3 endpoints that tested API key against Bearer-only endpoints (just confirmed 401)
- Move GET /templates/aliases/{alias} test to phase 3, use the test template we create there
- Update workflow to generate spec, diff, run validation, and create PR with status indicator
- Add POST /sandboxes/{sandboxID}/snapshots and GET /snapshots endpoints
- Add SnapshotInfo schema and FILE_TYPE_SYMLINK enum value
- Replace SandboxAutoResumePolicy enum with SandboxAutoResumeEnabled boolean
- Stop filtering out snapshot paths in generate script
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