| elinuxhenrik | 3c0cb32 | 2020-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) | 535be96 | 2020-10-07 12:59:08 -0400 | [diff] [blame] | 5 | |
| 6 | .. _offered_apis: |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 7 | |
| 8 | |
| 9 | Offered APIs |
| 10 | ============ |
| 11 | |
| 12 | Introduction |
| JohnKeeney | de4ac0d | 2021-03-09 18:32:45 +0000 | [diff] [blame^] | 13 | ------------ |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 14 | |
| JohnKeeney | de4ac0d | 2021-03-09 18:32:45 +0000 | [diff] [blame^] | 15 | The north bound REST API of the A1 Policy Management Service provides convenient methods to handle policies. |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 16 | |
| 17 | |
| JohnKeeney | de4ac0d | 2021-03-09 18:32:45 +0000 | [diff] [blame^] | 18 | Overall architecture for O-RAN A1 Policy functions |
| 19 | -------------------------------------------------- |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 20 | |
| JohnKeeney | de4ac0d | 2021-03-09 18:32:45 +0000 | [diff] [blame^] | 21 | This picture provides a overview of ONAP's A1 Controller architecture, |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 22 | integration with other ONAP components and API resource/operation provided. |
| 23 | |
| elinuxhenrik | 42fb47f | 2020-11-17 17:43:28 +0100 | [diff] [blame] | 24 | .. image:: ../media/ONAP-A1ControllerArchitecture.png |
| Singal, Kapil (ks220y) | 535be96 | 2020-10-07 12:59:08 -0400 | [diff] [blame] | 25 | :width: 500pt |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 26 | |
| 27 | |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 28 | API Version |
| JohnKeeney | de4ac0d | 2021-03-09 18:32:45 +0000 | [diff] [blame^] | 29 | ----------- |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 30 | |
| 31 | APIs are described with a state version with "v" following the API Name, |
| elinuxhenrik | ea2fcc8 | 2020-10-13 16:39:13 +0200 | [diff] [blame] | 32 | e.g.: ``v2/policy``. |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 33 | The schema associated with a REST API must have its version number aligned |
| 34 | with that of the REST API. |
| 35 | |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 36 | API Table |
| JohnKeeney | de4ac0d | 2021-03-09 18:32:45 +0000 | [diff] [blame^] | 37 | --------- |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 38 | |
| 39 | .. |swagger-icon| image:: ../media/swagger.png |
| 40 | :width: 40px |
| 41 | |
| elinuxhenrik | 9bb9a4c | 2020-10-08 14:36:37 +0200 | [diff] [blame] | 42 | .. |yaml-icon| image:: ../media/yaml_logo.png |
| 43 | :width: 40px |
| 44 | |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 45 | |
| 46 | .. csv-table:: |
| elinuxhenrik | 9bb9a4c | 2020-10-08 14:36:37 +0200 | [diff] [blame] | 47 | :header: "API name", "|swagger-icon|", "|yaml-icon|" |
| 48 | :widths: 10,5, 5 |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 49 | |
| JohnKeeney | de4ac0d | 2021-03-09 18:32:45 +0000 | [diff] [blame^] | 50 | "A1 Policy Management Service API (NBI)", ":download:`link <./swagger/pms-api.json>`", ":download:`link <./swagger/pms-api.yaml>`" |
| elinuxhenrik | ea2fcc8 | 2020-10-13 16:39:13 +0200 | [diff] [blame] | 51 | "A1 ADAPTER API (Internal)", ":download:`link <./swagger/a1-adapter-api.json>`", ":download:`link <./swagger/a1-adapter-api.yaml>`" |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 52 | |
| Singal, Kapil (ks220y) | 535be96 | 2020-10-07 12:59:08 -0400 | [diff] [blame] | 53 | .. _pms_api: |
| 54 | |
| JohnKeeney | de4ac0d | 2021-03-09 18:32:45 +0000 | [diff] [blame^] | 55 | A1 Policy Management Service API |
| 56 | ................................ |
| 57 | |
| 58 | The A1 Policy Management Service API is described in more detail in `A1 Policy Management Service API (html) <./pms-api.html>`_ |
| 59 | |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 60 | |
| elinuxhenrik | ea2fcc8 | 2020-10-13 16:39:13 +0200 | [diff] [blame] | 61 | .. _a1_adapter_api: |
| 62 | |
| 63 | A1 ADAPTER API |
| 64 | .............. |
| elinuxhenrik | ea2fcc8 | 2020-10-13 16:39:13 +0200 | [diff] [blame] | 65 | |
| JohnKeeney | de4ac0d | 2021-03-09 18:32:45 +0000 | [diff] [blame^] | 66 | The 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 | |
| 68 | The A1 Adapter API is described in more detail in `A1 ADAPTER API (html) <./a1-adapter-api.html>`_ |