Gitiles
Code Review Sign In
gerrit.nordix.org / onap / ccsdk / oran / fba2c668e8036187b4dcaf3422c1143d1b2abc7e / . / docs / offeredapis / offeredapis.rst
blob: a43c0460bc357835bbd1e5cbf280a32c736b955e [file] [log] [blame]
elinuxhenrik3c0cb322020-10-01 10:52:59 +0200[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0
2 International License.
3.. http://creativecommons.org/licenses/by/4.0
4.. Copyright 2020 Nordix Foundation
Singal, Kapil (ks220y)535be962020-10-07 12:59:08 -0400[diff] [blame]5
6.. _offered_apis:
elinuxhenrik3c0cb322020-10-01 10:52:59 +0200[diff] [blame]7
8
9Offered APIs
10============
11
12Introduction
13************
14
elinuxhenrikea2fcc82020-10-13 16:39:13 +0200[diff] [blame]15The north bound REST API of the Policy Management Service provides convenient methods to handle policies.
elinuxhenrik3c0cb322020-10-01 10:52:59 +0200[diff] [blame]16
17
PatrikBuhr66cf3242021-03-08 12:33:17 +0100[diff] [blame]18Overview
elinuxhenrik3c0cb322020-10-01 10:52:59 +0200[diff] [blame]19************************
20
21Following illustration provides a global view about **ORAN** architecture,
22integration with other ONAP components and API resource/operation provided.
23
elinuxhenrik42fb47f2020-11-17 17:43:28 +0100[diff] [blame]24.. image:: ../media/ONAP-A1ControllerArchitecture.png
Singal, Kapil (ks220y)535be962020-10-07 12:59:08 -0400[diff] [blame]25 :width: 500pt
elinuxhenrik3c0cb322020-10-01 10:52:59 +0200[diff] [blame]26
27
elinuxhenrik3c0cb322020-10-01 10:52:59 +0200[diff] [blame]28API Version
29***********
30
31APIs are described with a state version with "v" following the API Name,
elinuxhenrikea2fcc82020-10-13 16:39:13 +0200[diff] [blame]32e.g.: ``v2/policy``.
elinuxhenrik3c0cb322020-10-01 10:52:59 +0200[diff] [blame]33The schema associated with a REST API must have its version number aligned
34with that of the REST API.
35
36The version number has major, minor and revision numbers. E.g. v1.0.0
37The version number (without the revision number) is held in the URI.
38
39The major version number is incremented for an incompatible change.
40The minor version number is incremented for a compatible change.
41For minor modifications of the API, version numbering must not be updated,
elinuxhenrik3c0cb322020-10-01 10:52:59 +0200[diff] [blame]42
43For major modifications of the API, not backward compatible and forcing client
PatrikBuhr66cf3242021-03-08 12:33:17 +0100[diff] [blame]44implementations to be changed, the major version number must be updated.
elinuxhenrik3c0cb322020-10-01 10:52:59 +0200[diff] [blame]45
46
47API Table
48*********
49
50.. |swagger-icon| image:: ../media/swagger.png
51 :width: 40px
52
elinuxhenrik9bb9a4c2020-10-08 14:36:37 +0200[diff] [blame]53.. |yaml-icon| image:: ../media/yaml_logo.png
54 :width: 40px
55
elinuxhenrik3c0cb322020-10-01 10:52:59 +0200[diff] [blame]56
57.. csv-table::
elinuxhenrik9bb9a4c2020-10-08 14:36:37 +0200[diff] [blame]58 :header: "API name", "|swagger-icon|", "|yaml-icon|"
59 :widths: 10,5, 5
elinuxhenrik3c0cb322020-10-01 10:52:59 +0200[diff] [blame]60
elinuxhenrik9bb9a4c2020-10-08 14:36:37 +0200[diff] [blame]61 "PMS API", ":download:`link <./swagger/pms-api.json>`", ":download:`link <./swagger/pms-api.yaml>`"
elinuxhenrikea2fcc82020-10-13 16:39:13 +0200[diff] [blame]62 "A1 ADAPTER API (Internal)", ":download:`link <./swagger/a1-adapter-api.json>`", ":download:`link <./swagger/a1-adapter-api.yaml>`"
elinuxhenrik3c0cb322020-10-01 10:52:59 +0200[diff] [blame]63
64
Singal, Kapil (ks220y)535be962020-10-07 12:59:08 -0400[diff] [blame]65.. _pms_api:
66
elinuxhenrik3c0cb322020-10-01 10:52:59 +0200[diff] [blame]67PMS API
68.......
69`PMS API <./pms-api.html>`_
70
elinuxhenrikea2fcc82020-10-13 16:39:13 +0200[diff] [blame]71.. _a1_adapter_api:
72
73A1 ADAPTER API
74..............
75`A1 ADAPTER API (Internal) <./a1-adapter-api.html>`_
76