summaryrefslogtreecommitdiff
path: root/core/api-common.rst
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2020-03-30 15:58:52 +0530
committerFlorian Dold <florian.dold@gmail.com>2020-03-30 15:58:52 +0530
commitba934cc1ef9158bf0178f6d722bab2eb911583a5 (patch)
treefdc1f9edfeaffba654b6acdcdaefe83638c79fdd /core/api-common.rst
parent293b3d55d8cd6cf946bb4e86bfe8ef743156838b (diff)
downloaddocs-ba934cc1ef9158bf0178f6d722bab2eb911583a5.tar.gz
docs-ba934cc1ef9158bf0178f6d722bab2eb911583a5.tar.bz2
docs-ba934cc1ef9158bf0178f6d722bab2eb911583a5.zip
integrate Christian's idea about 'revision' field
Diffstat (limited to 'core/api-common.rst')
-rw-r--r--core/api-common.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/core/api-common.rst b/core/api-common.rst
index 5fafacb..1721c42 100644
--- a/core/api-common.rst
+++ b/core/api-common.rst
@@ -133,9 +133,11 @@ version range they support. These version ranges are written down in the
A protocol version is a positive, non-zero integer. A protocol version range consists of three components:
1. The ``current`` version. This is the latest version of the protocol supported by the client or service.
-2. The ``revision`` number. This value is not to be interpreted by the client/server, but serves
+2. The ``revision`` number. This value should usually not be interpreted by the client/server, but serves
purely as a comment. Each time a service/client for a protocol is updated while supporting the same
set of protocol versions, the revision should be increased.
+ In rare cases, the revision number can be used to work around unintended breakage in deployed
+ versions of a service. This is discouraged and should only be used in exceptional situations.
3. The ``age`` number. This non-zero integer identifies with how many previous protocol versions this
implementation is compatible. An ``age`` of 0 implies that the implementation only supports
the ``current`` protocol version. The ``age`` must be less or equal than the ``current`` protocol version.