Skip to content

Developers

API versioning & compatibility

The Airfree Maps APIs are versioned in the URL path.

Current version

All endpoints live under /api/v1. The version increments only for breaking changes.

What we consider backward-compatible

  • Adding a new endpoint or an optional request parameter.
  • Adding a new field to a response.
  • Adding a new enum value where your client already tolerates unknown values.

What triggers a new version

  • Removing or renaming a field or endpoint.
  • Changing the type or meaning of an existing field.
  • Changing authentication or required parameters.

Deprecation

When an endpoint is deprecated we announce it in the changelog and continue to serve it for a reasonable migration window before removal. Preview APIs are exempt — they may change without a version bump until they reach general availability.