API publication and support policy
An API can be published only when all of the following are recorded and approved:
- Classification: public, authenticated customer, or private/internal.
- Owner: accountable product and engineering owners.
- Support commitment: availability, response, compatibility, and support channel.
- Contract: versioned request/response schema, errors, idempotency, pagination, and limits.
- Authentication and authorization: supported client identity and least privilege.
- Tenant isolation: every operation enforces the caller’s authorized
dealer_id; identifiers alone are not authorization. - Abuse controls: rate limits, quotas, validation, monitoring, and safe failure behavior.
- Data review: sensitive fields, retention, consent, audit, and redaction.
- Operational readiness: observability, incident owner, rollback, and dependency behavior.
- Lifecycle: changelog, deprecation window, migration guidance, and retirement process.
- Examples: synthetic values only—no secrets or real customer data.
- Specification: only approved operations appear in the published OpenAPI document.
Supabase Edge Functions and private service routes remain internal unless individually promoted through this process.
Was this page helpful?Yes·Needs improvement