phoenix-rest-api

REST API development for Phoenix. Use when adding, modifying, or reviewing endpoints in src/phoenix/server/api/routers/v1/.

Quality

87%

Does it follow best practices?

Impact

—

No eval scenarios have been run

Securityby

Passed

No known issues

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-tag for tag/name params (these are normalized by _ensure_endpoint_coverage_is_exhaustive)
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

Repository: Arize-ai/phoenix
Commit: 924117e

Last updated: 5 days ago
Created: 5 days ago

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.