AIARCOASC Docs
Sign inStart free

Versioning

URI versioning (/v1, /v2…), 12-month deprecation, Sunset headers.

What it is

We version in the URI path (/v1/…). Breaking changes get a new version. Non-breaking changes (new fields, new optional params, new endpoints) ship under the existing version.

When a version is deprecated, every response from it carries:

  • Deprecation: true
  • Sunset: <RFC-2616 date> — the date the version stops serving traffic (no less than 12 months out).
  • Link: <https://docs.asc.aiarco.com/migrate/v1-to-v2>; rel="successor-version"

What we consider non-breaking (won't bump major):

  • Adding a field to a response.
  • Adding a new optional request parameter.
  • Adding a new endpoint or scope.
  • Adding a new enum value (treat as forward-compatible — log unknown values).

What we consider breaking (bumps major):

  • Removing or renaming a field.
  • Changing a field's type or units.
  • Tightening validation on an existing endpoint.

Quickstart

curl -I https://api.asc.aiarco.com/v1/pods
# Deprecation: true                       (if applicable)
# Sunset: Mon, 22 May 2027 00:00:00 GMT    (if applicable)
# Pin SDK to a minor; upgrade deliberately.
# pip install 'aiarco>=2026.5,&lt;2026.6'
// Same pattern in package.json: pin minor.

Limits & quotas

LimitDefaultBurstNotes
Deprecation notice≥12 months—Before sunset

Security

All access is authenticated and scoped. See Auth & scopes and Network controls.