Support operation field for CPS Temporal Query Output API

[cps/cps-temporal.git] / docs / content / deployment.rst

diff --git a/docs/content/deployment.rst b/docs/content/deployment.rst
index fd6fd59..0013466 100644 (file)
--- a/docs/content/deployment.rst
+++ b/docs/content/deployment.rst
@@ -2,7 +2,7 @@
 .. Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 ..
-.. Copyright (C) 2021 Bell Canada
+.. Copyright (C) 2021-2022 Bell Canada
 .. Modifications Copyright (C) 2021 Nordix Foundation
 
 =======================
@@ -127,3 +127,14 @@ For development purposes, CPS Temporal can be ran on any environment using
 Docker. Refer to `README.md <https://github.com/onap/cps-cps-temporal/blob/master/README.md>`_
 and `docker-compose.yml <https://github.com/onap/cps-cps-temporal/blob/master/docker-compose.yml>`_
 files for more details.
+
+Upgrade
+=======
+
+**Cps data-updated-event schema v2**
+
+Cps data-updated-event schema v2 used in Jakarta is backward compatible with data-updated-event schema v1 used in Istanbul.
+
+It means that consumers using the schema v2 can process events generated by producers using the schema v2 or v1.
+
+This implies that cps temporal (consumer) must be upgraded from Istanbul to Jakarta at the same time or before cps core (producer) is upgraded from Istanbul to Jakarta.
\ No newline at end of file