blob: 28f0083539ebf2abd0c9235d943600f040049fee [file] [log] [blame]
elinuxhenrik3c0cb322020-10-01 10:52:59 +02001.. This work is licensed under a Creative Commons Attribution 4.0
2 International License.
3.. http://creativecommons.org/licenses/by/4.0
JohnKeeney069b4692022-05-12 22:15:14 +01004.. Copyright 2022 Nordix Foundation
Singal, Kapil (ks220y)535be962020-10-07 12:59:08 -04005
6.. _offered_apis:
elinuxhenrik3c0cb322020-10-01 10:52:59 +02007
8
9Offered APIs
10============
11
12Introduction
JohnKeeneyde4ac0d2021-03-09 18:32:45 +000013------------
elinuxhenrik3c0cb322020-10-01 10:52:59 +020014
JohnKeeney069b4692022-05-12 22:15:14 +010015The north-bound REST API of the A1 Policy Management Service provides convenient methods to handle A1 policies.
elinuxhenrik3c0cb322020-10-01 10:52:59 +020016
17
JohnKeeneyde4ac0d2021-03-09 18:32:45 +000018Overall architecture for O-RAN A1 Policy functions
19--------------------------------------------------
elinuxhenrik3c0cb322020-10-01 10:52:59 +020020
JohnKeeneyde4ac0d2021-03-09 18:32:45 +000021This picture provides a overview of ONAP's A1 Controller architecture,
elinuxhenrik3c0cb322020-10-01 10:52:59 +020022integration with other ONAP components and API resource/operation provided.
23
elinuxhenrik42fb47f2020-11-17 17:43:28 +010024.. image:: ../media/ONAP-A1ControllerArchitecture.png
Singal, Kapil (ks220y)535be962020-10-07 12:59:08 -040025 :width: 500pt
elinuxhenrik3c0cb322020-10-01 10:52:59 +020026
27
elinuxhenrik3c0cb322020-10-01 10:52:59 +020028API Version
JohnKeeneyde4ac0d2021-03-09 18:32:45 +000029-----------
elinuxhenrik3c0cb322020-10-01 10:52:59 +020030
31APIs are described with a state version with "v" following the API Name,
elinuxhenrikea2fcc82020-10-13 16:39:13 +020032e.g.: ``v2/policy``.
elinuxhenrik3c0cb322020-10-01 10:52:59 +020033The schema associated with a REST API must have its version number aligned
34with that of the REST API.
35
elinuxhenrik3c0cb322020-10-01 10:52:59 +020036API Table
JohnKeeneyde4ac0d2021-03-09 18:32:45 +000037---------
elinuxhenrik3c0cb322020-10-01 10:52:59 +020038
39.. |swagger-icon| image:: ../media/swagger.png
40 :width: 40px
41
elinuxhenrik9bb9a4c2020-10-08 14:36:37 +020042.. |yaml-icon| image:: ../media/yaml_logo.png
43 :width: 40px
44
elinuxhenrik3c0cb322020-10-01 10:52:59 +020045
46.. csv-table::
elinuxhenrik9bb9a4c2020-10-08 14:36:37 +020047 :header: "API name", "|swagger-icon|", "|yaml-icon|"
48 :widths: 10,5, 5
elinuxhenrik3c0cb322020-10-01 10:52:59 +020049
JohnKeeneyde4ac0d2021-03-09 18:32:45 +000050 "A1 Policy Management Service API (NBI)", ":download:`link <./swagger/pms-api.json>`", ":download:`link <./swagger/pms-api.yaml>`"
elinuxhenrikea2fcc82020-10-13 16:39:13 +020051 "A1 ADAPTER API (Internal)", ":download:`link <./swagger/a1-adapter-api.json>`", ":download:`link <./swagger/a1-adapter-api.yaml>`"
elinuxhenrik3c0cb322020-10-01 10:52:59 +020052
Singal, Kapil (ks220y)535be962020-10-07 12:59:08 -040053.. _pms_api:
54
JohnKeeneyde4ac0d2021-03-09 18:32:45 +000055A1 Policy Management Service API
56................................
57
halil.cakal8ff65112023-02-02 14:22:55 +000058The A1 Policy Management Service API is described in more detail in `A1 Policy Management Service API (html) <./pms-api.html>`_
JohnKeeneyde4ac0d2021-03-09 18:32:45 +000059
elinuxhenrik3c0cb322020-10-01 10:52:59 +020060
elinuxhenrikea2fcc82020-10-13 16:39:13 +020061.. _a1_adapter_api:
62
63A1 ADAPTER API
64..............
elinuxhenrikea2fcc82020-10-13 16:39:13 +020065
JohnKeeneyde4ac0d2021-03-09 18:32:45 +000066The O-RAN A1 Adapter provides an **internal** RESTCONF API that is used by the A1 Policy Management System when accessing the A1 Interface. This API is useful for test and verification but should not be used otherwise.
67
68The A1 Adapter API is described in more detail in `A1 ADAPTER API (html) <./a1-adapter-api.html>`_