← ClaudeAtlas

hex-restapi-schemalisted

Use when a REST request or response body gains or changes a field — the pydantic models in `restapi/schemas/<resource>.py` (`FooResponse`, `FooListResponse`, `FooCreateRequest`, `FooUpdateRequest`), PATCH `T | None = None` semantics, pagination shape, schema exports. Not the domain entity they mirror (`hex-domain-model`) and not the route that maps them (`hex-restapi-endpoint`).
wntic/pyhouse · ★ 3 · API & Backend · score 76
Install: claude install-skill wntic/pyhouse
# Hex REST — API Schema Produces one resource's schema module — the declared HTTP wire format for that resource, written here as pydantic models. The module is the boundary itself: domain entities never cross the wire, and schemas never cross into application or domain code. ## When to use vs. neighbours - Per-resource Pydantic schemas (request/response), including a field added to or removed from a body → this skill. - The route that consumes these schemas and maps them field by field → `hex-restapi-endpoint`. - The entity, value object, enum or filter record these models mirror — never imported here beyond enums → `hex-domain-model`. - Cross-cutting `ErrorResponse` / `error_responses()` in `restapi/schemas/errors.py` → `hex-restapi-app`; which of those codes a route advertises → `hex-restapi-endpoint`. - The handlers beneath this delivery layer, and the command DTO carrying the same partial-update contract → `hex-application`. - The container beneath this delivery layer → `hex-wiring`. - The four schema names and any field name → `naming`; `__all__` and the wildcard re-export into `schemas/__init__.py` → `python-packaging`. - Asserting a response body in a test → `hex-test-restapi-endpoint`. ## Template — pydantic ### File location ``` src/myapp/restapi/schemas/foos.py # the resource's schemas src/myapp/restapi/schemas/__init__.py # update to re-export ``` The module holds several classes on purpose: one resource's request and response models are a clos