diff --git a/guidelines/api_interoperability.rst b/guidelines/api_interoperability.rst index 25f19a7..fd1f034 100644 --- a/guidelines/api_interoperability.rst +++ b/guidelines/api_interoperability.rst @@ -4,6 +4,8 @@ http://creativecommons.org/licenses/by/3.0/legalcode +.. _interoperability: + ============================= Ensuring API Interoperability ============================= diff --git a/guidelines/compatibility.rst b/guidelines/compatibility.rst index c80e2fd..98ac0c8 100644 --- a/guidelines/compatibility.rst +++ b/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. diff --git a/guidelines/discoverability.rst b/guidelines/discoverability.rst index 723e688..6ea1b7b 100644 --- a/guidelines/discoverability.rst +++ b/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 --------