CtrlK
BlogDocsLog inGet started
Tessl Logo

phoenix-rest-api

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

73

Quality

92%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

Phoenix REST API

Endpoints: src/phoenix/server/api/routers/v1/. Read the relevant reference.

Checklist — run before committing any endpoint change

  1. make openapi — regenerate schema + client types, commit all generated files
  2. 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)
  3. make lint-python — fix any lint errors before committing
ReferenceWhen
references/endpoint-patterns.mdAdding or modifying an endpoint
references/openapi-codegen.mdRegenerating schema or client types
references/testing-patterns.mdWriting integration tests
Repository
Arize-ai/phoenix
Last updated
First committed

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.