summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis
diff options
context:
space:
mode:
authorPatrikBuhr <patrik.buhr@est.tech>2021-03-08 12:33:17 +0100
committerPatrikBuhr <patrik.buhr@est.tech>2021-03-08 12:34:05 +0100
commit66cf324545a90ed8275cdda04eb7ade4587ee306 (patch)
tree589d6991a4e25a681370b02faf826d677390656f /docs/offeredapis
parent65f7495a59cecff060b44ba039df758b08dc0323 (diff)
Documentation updates
Change-Id: Idbfdc085cb25835ff0c77d6d1963fece4fb0fe24 Issue-ID: CCSDK-2966 Signed-off-by: PatrikBuhr <patrik.buhr@est.tech>
Diffstat (limited to 'docs/offeredapis')
-rw-r--r--docs/offeredapis/offeredapis.rst16
1 files changed, 2 insertions, 14 deletions
diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst
index b6b2cd66..a43c0460 100644
--- a/docs/offeredapis/offeredapis.rst
+++ b/docs/offeredapis/offeredapis.rst
@@ -15,7 +15,7 @@ Introduction
The north bound REST API of the Policy Management Service provides convenient methods to handle policies.
-Global ORAN architecture
+Overview
************************
Following illustration provides a global view about **ORAN** architecture,
@@ -39,21 +39,9 @@ The version number (without the revision number) is held in the URI.
The major version number is incremented for an incompatible change.
The minor version number is incremented for a compatible change.
For minor modifications of the API, version numbering must not be updated,
-provided the following backward compatibility rules are respected:
-
-- New elements in a data type must be optional (``minOccurs=0``)
-- Changes in the cardinality of an attribute in a data type must be from
- mandatory to optional or from lower to greater
-- New attributes defined in an element must be optional (absence of
- ``use="required"``).
-- If new enumerated values are included, the former ones and its meaning must
- be kept.
-- If new operations are added, the existing operations must be kept
-- New parameters added to existing operations must be optional and existing
- parameters must be kept
For major modifications of the API, not backward compatible and forcing client
-implementations to be changed, the version number must be updated.
+implementations to be changed, the major version number must be updated.
API Table