Skip to content
AutoCore1.0.0-rc.1 · Release Candidate
1.0.0-rc.1 · Release Candidate2 min read

Response Shapes and Resource Semantics

How clients should read resource, collection, and mutation responses.

Prefer stable contract fields and ignore unknown fields for forward compatibility.

Source boundary

Source boundary: AutoCore current main 7a504f6e430c16d4fcb03ebdea3cc3fb7816df60, checked against immutable v1.0.0-rc.1 at 9edfb109f44cc80385784c694b96392cfc04e70f.

Resource DTOs and response decorators define the executable response surface. Collections commonly use items, total, page, and pageSize; mutation outcomes should be interpreted alongside status codes and audit/request identifiers.

CheckSource-backed expectation
ScopeDo not reconstruct database records from undocumented fields or admin-only response data.
EvidenceUse placeholders, timestamps, release identity, route, status, and request ID where relevant.
Safe actioncurl -s https://api.example.invalid/api/v1/listings | jq '.items'
Stop conditionUnknown authorization, destructive impact, secret exposure, or conflicting evidence.

Verification

Run the safe check, record its result, and compare the outcome with the documented contract. If the result depends on external configuration or provider availability, mark it as configuration-dependent rather than claiming a product guarantee.

Code
curl -s https://api.example.invalid/api/v1/listings | jq '.items'

Safety boundary

Examples are non-production and use placeholders. Do not deploy, reset, force a migration, create secrets, activate providers, replay sensitive work, or expose private data from this page.

Related articles