HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Versioning & Releases

Learn about Arcadia Signal API versioning, including version numbers and the meaning of Alpha, Beta, and Gamma designations for data structures and operations.

Version Numbers

The Arcadia Signal APIs are currently version 1.0. Version 2.0 (or 1.1) is not yet available. When new versions are released, the API signature will allow you to switch between versions seamlessly. You will not be required to migrate to a new version immediately after its introduction, as we understand the challenges involved in finding time for upgrades.

Version Names

Within a version (such as version 1.0), various data structures and operations/resources have their own version designations that indicate the maturity and stability of each component. Arcadia strives to release data and APIs early and frequently while ensuring we don't disrupt your existing implementations. Here are the guidelines for each version designation:

Alpha

An "alpha" designation indicates that we have made our best effort to anticipate the required basic data definitions, operation parameters, and requirements. However, the API contract has not yet been finalized and is likely to undergo changes.

Beta

A "beta" designation means the API has been used in production environments for an extended period and the contract has stabilized. We make every effort to avoid changes to the API contract once it reaches the beta stage.

Gamma

Components with a "gamma" designation have been thoroughly field-tested and have no anticipated changes. They are considered immutable for all practical purposes, and changes are extremely unlikely. If any modifications do occur, they will be minimal impact changes (such as adding optional parameters to requests). Any major changes required would result in a new API version.