summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-08-03 16:50:16 +0000
committerGerrit Code Review <review@openstack.org>2017-08-03 16:50:16 +0000
commite9be2965b289a07746521f2985144525dd7f3908 (patch)
treef6dc7a0930c037a84bf71ad200a597f256d0f1aa
parent8b16c92912f81097a9839fb60dcfc947ae8a92b9 (diff)
parent6cfa7550ddb31258df04764571160004a338ceeb (diff)
Merge "Update compatibility doc and references"
-rw-r--r--guidelines/api_interoperability.rst2
-rw-r--r--guidelines/compatibility.rst13
-rw-r--r--guidelines/discoverability.rst2
3 files changed, 6 insertions, 11 deletions
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 @@
4 4
5 http://creativecommons.org/licenses/by/3.0/legalcode 5 http://creativecommons.org/licenses/by/3.0/legalcode
6 6
7.. _interoperability:
8
7============================= 9=============================
8Ensuring API Interoperability 10Ensuring API Interoperability
9============================= 11=============================
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 @@
3Compatibility 3Compatibility
4============= 4=============
5 5
6This topic document serves to provide guidance on how to handle proposed 6This document has been superseded by :ref:`interoperability` which provides
7changes to a public REST API. 7guidance on how to ensure an API is both compatible across changes and
8 8interoperable between different installations.
9See also the topic document on :ref:`discoverability`.
10
11Guidance
12--------
13
14**TODO** Take pieces from https://wiki.openstack.org/wiki/APIChangeGuidelines
15and add them to this topic document, one at a time, in separate patches.
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
6This topic document serves to provide guidance on how to have a public REST 6This topic document serves to provide guidance on how to have a public REST
7API expose the URIs and resources to end users in a machine-readable way. 7API expose the URIs and resources to end users in a machine-readable way.
8 8
9See also the topic document on :ref:`compatibility`. 9See also the topic document on :ref:`consuming-catalog`.
10 10
11Guidance 11Guidance
12-------- 12--------