openstack
/
api-sig
Code Issues Proposed changes
OpenStack API Special Interest Group
212 Commits 1 Branch 0 Tags 4.8 MiB
Python 100%
Go to file
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
doc/source Removes unnecessary utf-8 encoding 2016-12-26 10:49:54 +08:00
guidelines Create a set of api interoperability guidelines 2017-04-27 17:20:46 +01:00
tests Allow JSON files for JSON Schemas and JSON examples 2015-03-25 21:07:25 -05:00
tools Fix some issues in add-reviewers 2016-03-07 14:42:55 +00:00
.gitignore Moves from markdown to rst 2014-10-22 16:24:41 +10:30
.gitreview Moves from markdown to rst 2014-10-22 16:24:41 +10:30
.testr.conf Moves from markdown to rst 2014-10-22 16:24:41 +10:30
LICENSE Moves from markdown to rst 2014-10-22 16:24:41 +10:30
README.rst Update and correct links in README 2016-10-11 20:17:38 +01:00
requirements.txt Add RSS feed 2014-12-12 09:22:02 +01:00
setup.cfg Moves from markdown to rst 2014-10-22 16:24:41 +10:30
setup.py Moves from markdown to rst 2014-10-22 16:24:41 +10:30
tox.ini Moves from markdown to rst 2014-10-22 16:24:41 +10:30

README.rst

README

Openstack API Working Group documents

This repository contains documents from the OpenStack API working group, including guidelines and proposed rules concerning API consistency, naming conventions, and best practice recommendations. The published information can be found at specs.openstack.org.

Interested in contributing to the API conversations? Simply clone this repository and follow the OpenStack code and review submission processes and the process document.