| 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 |
| 13 | ************ |
| 14 | |
| 15 | The north bound ... |
| 16 | |
| 17 | |
| 18 | Global ORAN architecture |
| 19 | ************************ |
| 20 | |
| 21 | Following illustration provides a global view about **ORAN** architecture, |
| 22 | integration with other ONAP components and API resource/operation provided. |
| 23 | |
| Singal, Kapil (ks220y) | 535be96 | 2020-10-07 12:59:08 -0400 | [diff] [blame] | 24 | .. image:: ../media/oran_architecture.png |
| 25 | :width: 500pt |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 26 | |
| 27 | |
| 28 | API Endpoint |
| 29 | ************ |
| 30 | |
| 31 | TBD |
| 32 | |
| 33 | |
| 34 | API Version |
| 35 | *********** |
| 36 | |
| 37 | APIs are described with a state version with "v" following the API Name, |
| 38 | e.g.: ``TBD``. |
| 39 | The schema associated with a REST API must have its version number aligned |
| 40 | with that of the REST API. |
| 41 | |
| 42 | The version number has major, minor and revision numbers. E.g. v1.0.0 |
| 43 | The version number (without the revision number) is held in the URI. |
| 44 | |
| 45 | The major version number is incremented for an incompatible change. |
| 46 | The minor version number is incremented for a compatible change. |
| 47 | For minor modifications of the API, version numbering must not be updated, |
| 48 | provided the following backward compatibility rules are respected: |
| 49 | |
| 50 | - New elements in a data type must be optional (``minOccurs=0``) |
| 51 | - Changes in the cardinality of an attribute in a data type must be from |
| 52 | mandatory to optional or from lower to greater |
| 53 | - New attributes defined in an element must be optional (absence of |
| 54 | ``use="required"``). |
| 55 | - If new enumerated values are included, the former ones and its meaning must |
| 56 | be kept. |
| 57 | - If new operations are added, the existing operations must be kept |
| 58 | - New parameters added to existing operations must be optional and existing |
| 59 | parameters must be kept |
| 60 | |
| 61 | For major modifications of the API, not backward compatible and forcing client |
| 62 | implementations to be changed, the version number must be updated. |
| 63 | |
| 64 | |
| 65 | API Table |
| 66 | ********* |
| 67 | |
| 68 | .. |swagger-icon| image:: ../media/swagger.png |
| 69 | :width: 40px |
| 70 | |
| elinuxhenrik | 9bb9a4c | 2020-10-08 14:36:37 +0200 | [diff] [blame^] | 71 | .. |yaml-icon| image:: ../media/yaml_logo.png |
| 72 | :width: 40px |
| 73 | |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 74 | |
| 75 | .. csv-table:: |
| elinuxhenrik | 9bb9a4c | 2020-10-08 14:36:37 +0200 | [diff] [blame^] | 76 | :header: "API name", "|swagger-icon|", "|yaml-icon|" |
| 77 | :widths: 10,5, 5 |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 78 | |
| elinuxhenrik | 9bb9a4c | 2020-10-08 14:36:37 +0200 | [diff] [blame^] | 79 | "PMS API", ":download:`link <./swagger/pms-api.json>`", ":download:`link <./swagger/pms-api.yaml>`" |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 80 | |
| 81 | |
| Singal, Kapil (ks220y) | 535be96 | 2020-10-07 12:59:08 -0400 | [diff] [blame] | 82 | .. _pms_api: |
| 83 | |
| elinuxhenrik | 3c0cb32 | 2020-10-01 10:52:59 +0200 | [diff] [blame] | 84 | PMS API |
| 85 | ....... |
| 86 | `PMS API <./pms-api.html>`_ |
| 87 | |