summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis/offeredapis.rst
diff options
context:
space:
mode:
authorelinuxhenrik <henrik.b.andersson@est.tech>2020-10-01 10:52:59 +0200
committerSingal, Kapil (ks220y) <ks220y@att.com>2020-10-07 11:02:35 -0400
commit3c0cb32c558ebec18600ee5ec3c00e7fc323f099 (patch)
treed34177c4422f84219cb8fa13e0408a2c76466e5d /docs/offeredapis/offeredapis.rst
parentabc005f4b2f9f80ed7fa658758da803ad6d91583 (diff)
Use redoc for api docs
Change-Id: Ia530424154226698aad6c1498c90eadf23efdea0 Issue-ID: CCSDK-2833 Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
Diffstat (limited to 'docs/offeredapis/offeredapis.rst')
-rw-r--r--docs/offeredapis/offeredapis.rst81
1 files changed, 81 insertions, 0 deletions
diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst
new file mode 100644
index 00000000..2b29aa41
--- /dev/null
+++ b/docs/offeredapis/offeredapis.rst
@@ -0,0 +1,81 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+ International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2020 Nordix Foundation
+.. _offeredapis:
+
+
+Offered APIs
+============
+
+Introduction
+************
+
+The north bound ...
+
+
+Global ORAN architecture
+************************
+
+Following illustration provides a global view about **ORAN** architecture,
+integration with other ONAP components and API resource/operation provided.
+
+.. image:: ../images/onap_ccsdk_oran.jpg
+ :width: 800px
+
+
+API Endpoint
+************
+
+TBD
+
+
+API Version
+***********
+
+APIs are described with a state version with "v" following the API Name,
+e.g.: ``TBD``.
+The schema associated with a REST API must have its version number aligned
+with that of the REST API.
+
+The version number has major, minor and revision numbers. E.g. v1.0.0
+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.
+
+
+API Table
+*********
+
+.. |swagger-icon| image:: ../media/swagger.png
+ :width: 40px
+
+
+.. csv-table::
+ :header: "API name", "|swagger-icon|"
+ :widths: 10,5
+
+ "PMS API", ":download:`link <./swagger/pms-api.json>`"
+
+
+PMS API
+.......
+`PMS API <./pms-api.html>`_
+