Phoenix REST API
Endpoints: src/phoenix/server/api/routers/v1/. Read the relevant reference.
Checklist — run before committing any endpoint change
make openapi— regenerate schema + client types, commit all generated files- Add endpoint to the correct list in
tests/integration/_helpers.py:- GET →
_COMMON_RESOURCE_ENDPOINTS - Admin-only →
_ADMIN_ONLY_ENDPOINTS - POST/PUT/DELETE →
_VIEWER_BLOCKED_WRITE_OPERATIONS - Path format: use
fake-id-{}for path params,test-tagfor tag/name params (these are normalized by_ensure_endpoint_coverage_is_exhaustive)
- GET →
make lint-python— fix any lint errors before committing
| Reference | When |
|---|---|
references/endpoint-patterns.md | Adding or modifying an endpoint |
references/openapi-codegen.md | Regenerating schema or client types |
references/testing-patterns.md | Writing integration tests |