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

API Versioning and Compatibility

Compatibility expectations for the release-candidate API.

Pin the documented version and re-run the drift checks when upgrading.

Source boundary

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

The documented version is v1 with release identity 1.0.0-rc.1. Changes to routes, methods, DTOs, error codes, authentication, or webhook verification require a new source audit and documentation revision.

CheckSource-backed expectation
ScopeRelease compatibility is separate from edition identity; both must be explicit.
EvidenceUse placeholders, timestamps, release identity, route, status, and request ID where relevant.
Safe actionpnpm validate:api
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
pnpm validate:api

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