Uploaded image for project: 'Active and Available Inventory'
  1. Active and Available Inventory
  2. AAI-1185

Versioning for ONAP Components with Backward Compatibility

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Not Done
    • Icon: Medium Medium
    • Honolulu Release
    • None
    • None
    • API Versioning

      As an ONAP team member, I want to standardize component API versioning, establish a backwards compatibility (BWC) policy and expedite development and testing ONAP APIs:

      Components will be “speaking the same language” in terms of how versions are characterized by employing the semantic versioning methodology.
      APIs can be released as MINOR versions, instead of a MAJOR version each release, which will expedite testing and minimize development introducing breaking changes.
      An established BWC policy limits how long previous versions need to be active/available.
      API clients can target specific versions and servers can evolve APIs without breaking existing clients (within the BWC timeframe).
      Lay the foundation for API cataloging and automated compatibility/dependency matrices.

      We will also use this feature to implement additional changes to the APIs to better align with REST standards.

            jimmydot jimmydot
            jimmydot jimmydot
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: