openstack/api-sig
Code Issues Proposed changes
api-sig/guidelines/evaluating_api_changes.rst
Chris Dent 6eef12125a Create a set of api interoperability guidelines 
A new tag has been proposed in governance (see
I34cdfe0e00cd29d816e94668ace2146d66734814 ) which asserts that a
project follows OpenStack guidelines for an API maintaining
compatibility over time. The original "Evaluating API Changes"
guideline is used as the reference for what compatibility means.

That guideline was copied from the wiki in May 2015 and the content
that had been on the wiki last saw substantive change in August of
2012[1]. Under review it was discovered the guidance insufficiently
robust in a situation where the primary goal is for there to be
interoperability between clouds.

A new set of guidelines on what signifies change or instability in an API
is created in this document, with a new name, and with greater context on
the reasoning. The old document has been updated to link to this new
one with an explanation for why.

[1] https://wiki.openstack.org/w/index.php?title=APIChangeGuidelines&action=history

Change-Id: I0063c892cb1bddcca0745cd9f16b5004ff57959a
2017-04-27 17:20:46 +01:00

482 B
Raw Permalink Blame History

Evaluating API Changes

This document has been superseded by api_interoperability after the guidelines in this document were discovered to insufficiently capture the concepts of stability and compatibility in a world where interoperability between clouds is the ultimate priority.