Guideline No. AI001
Purpose To clarify implementation best practices regarding technical aspects of the API specification
Description Implementation best practices are as defined in these community guidelines:

Stage Finalised
Guideline No. AI002
Purpose To clarify the mechanism defined for API Governance (versioning and compatibility best practices)
Description The open API specifications follow semantic versioning principles. 

Changes are expected to be introduced in a non-breaking manner, thus ensuring existing implementations are forward compatible, while newer implementations (that have implemented the latest version) are backward compatible.

Only when unavoidable will there be a breaking change introduced, signalled through a major version change.

Older versions will be sunset on the basis of a reasonable migration window provided to all implementers.

All version changes and other aspects of API governance are currently controlled and published by ReBIT.

These guidelines are informal interpretations of what is understood to be their policy.

Stage Under deliberation
Guideline No. AI003
Purpose To clarify the version of the API specifications that the ecosystem is “live” on
Description The version of the open API specifications (across FIP, FIU, AA APIs) that all entities are live on (as of August 2022) is V 1.1.2. 

While V 1.1.3 has been published by ReBIT, there are no API governance guidelines published and/or implemented by participants, that would ensure backward and forward compatibility amongst entities operating on two different versions.

Hence, no entity is live on V 1.1.3.

As newer versions get released, a discussion on API Governance principles and implementations needs to happen to ensure a smooth migration to newer versions takes place.

Stage Finalised

Back to AA Community Guidelines Summary