openstack/api-sig
Code Issues Proposed changes

Update compatibility doc and references

Browse Source 
The compatibility doc was out of date and making promises of having
additional information that is now provided by the interoperability
document. So we now link from compatibility to api_interoperability and
in discoverability where we had been linking to compatibility we now
link to the recent information on consuming the catalog.

Change-Id: I296d5b167ffad63a256a2b133ee9250710e2837b
Closes-Bug: #1593312
This commit is contained in:
Chris Dent 2017-07-26 17:20:06 +01:00
parent 12bf769d63
commit 6cfa7550dd
3 changed files with 6 additions and 11 deletions

2
guidelines/api_interoperability.rst

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

13
guidelines/compatibility.rst

@ -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

@ -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
--------