openstack/api-sig
Code Issues Proposed changes

Merge "Update compatibility doc and references"

Browse Source
This commit is contained in:
Jenkins 2017-08-03 16:50:16 +00:00 committed by Gerrit Code Review
commit e9be2965b2
3 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
guidelines/api_interoperability.rst
View File

@ -4,6 +4,8 @@
http://creativecommons.org/licenses/by/3.0/legalcode
.. _interoperability:
=============================
Ensuring API Interoperability
=============================

13
guidelines/compatibility.rst
View File

@ -3,13 +3,6 @@
Compatibility
=============
This topic document serves to provide guidance on how to handle proposed
changes to a public REST API.
See also the topic document on :ref:`discoverability`.
Guidance
--------
**TODO** Take pieces from https://wiki.openstack.org/wiki/APIChangeGuidelines
and add them to this topic document, one at a time, in separate patches.
This document has been superseded by :ref:`interoperability` which provides
guidance on how to ensure an API is both compatible across changes and
interoperable between different installations.

2
guidelines/discoverability.rst
View File

@ -6,7 +6,7 @@ API Discoverability
This topic document serves to provide guidance on how to have a public REST
API expose the URIs and resources to end users in a machine-readable way.
See also the topic document on :ref:`compatibility`.
See also the topic document on :ref:`consuming-catalog`.
Guidance
--------