Navigation
Contribution Type New API Version
Approximately once or twice per ONAP release, the AAI API version is incremented, e.g. in Casablanca the version was v14 and in Dublin the versions were v15 and v16.
New API version number should be accompanied by Updating AAI charts for MSB discovery config
New API version number should be accompanied by updates to AAI R4 Integration Sanity Test Plans
Updated procedures should be published in setup wiki pages like AAI Developer Environment Setup - Dublin
Updated procedures should be published in tutorial wiki pages like AAI Tutorial-Making and Testing a Schema Change - Dublin
Bring discussion to AAI Weekly Status Meeting
Bring discussion to AAI Developers Meeting
tbc
Contribution Type New Schema or EdgeRule
Approximately one or more times per ONAP release, new schema or EdgeRule updates are done within an API version, e.g. the CCVPN use case was introduced in Casablanca (v14) .
New schema elements are done in the OXM file. Relationships between schema elements are done in the EdgeRule file.
New schema or EdgeRule changes should be following AAI Data Model Principles
New schema or EdgeRule changes should be accompanied by new wiki pages under AAI Design Documentation
New schema or EdgeRule changes should be accompanied by updates to AAI R4 Integration Sanity Test Plans
Bring discussion to AAI Weekly Status Meeting
Bring discussion to AAI Developers Meeting
tbc
Contribution Type Breaking Change to Schema or EdgeRule
Less than once per several ONAP releases, breaking changes to schema or EdgeRule may be contemplated, e.g. the pnf unique key was changed in Dublin (v16).
Breaking changes are those which break compatibility with the API, thus forcing clients of AAI to adapt both code and data to use the updated API.
New schema or EdgeRule changes should be following AAI Data Model Principles
New schema or EdgeRule changes should be accompanied by new wiki pages under AAI Design Documentation
New schema or EdgeRule changes should be accompanied by updates to AAI R4 Integration Sanity Test Plans
Migration plan should be published in new wiki pages under AAI Design Documentation
Updated procedures should be published in tutorial wiki pages like AAI Tutorial-Making and Testing a Schema Change - Dublin
Breaking changes should be accompanied by new documentation for readthedocs
Bring discussion to AAI Weekly Status Meeting
Bring discussion to AAI Developers Meeting
Bring discussion to PTL Meeting
tbc
Contribution Type New Microservice
New microservice is assumed to be within existing code repositories.
New microservice should be accompanied by new wiki pages under AAI Design Documentation
New microservice should be accompanied by updates to AAI R4 Integration Sanity Test Plans
Updated procedures should be published in setup wiki pages like AAI Developer Environment Setup - Dublin
Updated procedures should be published in tutorial wiki pages like AAI Tutorial-Making and Testing a Schema Change - Dublin
New microservice should be accompanied by Updating AAI charts for MSB discovery config
New microservice should be accompanied by new test coverage measured by Sonar
New microservice should be accompanied by new documentation for readthedocs
New microservice should be accompanied by new Helm charts for OOM deployment
Bring discussion to AAI Weekly Status Meeting
Bring discussion to AAI Developers Meeting
tbc
Contribution Type New Code Repository
New code repository usually means new microservice(s) as well (include the actions from section "Contribution Type New Microservice").
New code repository should be accompanied by new Jenkins jobs
Bring discussion to AAI Weekly Status Meeting
Bring discussion to AAI Developers Meeting
tbc
Contribution Type New REST URL API within Microservice
New REST URL API should be accompanied by new wiki pages under AAI Design Documentation
New REST URL API should be accompanied by updates to AAI R4 Integration Sanity Test Plans
New REST URL API should be accompanied by Updating AAI charts for MSB discovery config
New REST URL API should be accompanied by new test coverage measured by Sonar
New REST URL API should be accompanied by new documentation for readthedocs
Bring discussion to AAI Weekly Status Meeting
Bring discussion to AAI Developers Meeting
tbc
Contribution Type Decommissioning API version, Schema, EdgeRule, Microservice or REST URL API
Decommissioning existing functions hasn't really happened yet, but it is definitely a "breaking change" (include the actions from section "Contribution Type Breaking Change to Schema or EdgeRule").
Bring discussion to AAI Weekly Status Meeting
Bring discussion to AAI Developers Meeting
tbc
Other Contributions
Contributing To AAI By Assisting with Sonar Reports
Contributing To AAI By Assisting with Maven Warnings