Skip to main content
ClaudeWave
ES, Spanish
Skill12k estrellas del repoactualizado 6d ago

phoenix-rest-api

The Phoenix REST API skill provides guidance for developing and maintaining REST endpoints in the Phoenix observability platform. Use this when adding, modifying, or testing API endpoints, as it includes essential checklists for schema regeneration, endpoint registration in test suites, and linting requirements to ensure consistent implementation across the codebase.

Instalar en Claude Code
Copiar
git clone --depth 1 https://github.com/Arize-ai/phoenix /tmp/phoenix-rest-api && cp -r /tmp/phoenix-rest-api/.agents/skills/phoenix-rest-api ~/.claude/skills/phoenix-rest-api
Después abre una sesión nueva de Claude Code; el skill carga automáticamente.

SKILL.md

# 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

| 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 |