API Versioning

Registered by Vilobh Meshram

Tracking work for API versioning. Will add more use case and detailed design in a spec as this work is prioritized.

Blueprint information

Status:
Complete
Approver:
Adrian Otto
Priority:
Undefined
Drafter:
Vilobh Meshram
Direction:
Approved
Assignee:
Jaycen Grant
Definition:
Approved
Series goal:
None
Implementation:
Implemented
Milestone target:
None
Started by
Jaycen Grant
Completed by
Jaycen Grant

Related branches

Sprints

Whiteboard

Please be aware of the ongoing reviews of microversions guidelines [1] in the OpenStack API Working Group. Feedback on those reviews is welcome. If Magnum chooses to do microversions, they should adhere to those guidelines.

Update:

Header work and basic versions had already been added. Several bugs have now been resolved that were unresolved by previous work. See https://review.openstack.org/304705

Still lacking version method selection implementation. This is addressed in: https://review.openstack.org/343060

Magnum Client needs to be updated to support versioning. Client default to latest, but provide support for any supported microversions. This is addressed in: micro-version can be specified with
command line option already.

After this Magnum API versioning will be up to date with openstack microversioning specs and will be ready to use. It appears that there will be API changes(async commands) that will go in Newton cycles. So this work will likely need to be approved and completed in Newton.

[1] https://review.openstack.org/#/q/status:open+project:openstack/api-wg,n,z

Gerrit topic: https://review.openstack.org/#q,topic:bp/api-versioning,n,z

Addressed by: https://review.openstack.org/304705
    Adds specification for API versioning

Addressed by: https://review.openstack.org/343060
    [WIP] Add microversioning support for methods

Gerrit topic: https://review.openstack.org/#q,topic:bug/1588425,n,z

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.