docs/offeredapis/offeredapis.rst

   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 2018 ORANGE
   5 .. _offeredapis:
   6
   7
   8 ============
   9 Offered APIs
  10 ============
  11 ************
  12 Introduction
  13 ************
  14
  15 NBI stands for NorthBound Interface. It brings to ONAP a set of API that can
  16 be used by external systems as BSS for example. These API are based on
  17 **TMF API**.
  18
  19 *******************************************
  20 Global NBI architecture for El Alto release
  21 *******************************************
  22
  23 Following illustration provides a global view about **NBI** architecture,
  24 integration with other ONAP components and API resource/operation provided.
  25
  26 .. image:: ../images/onap_nbi_dublin.jpg
  27    :width: 800px
  28
  29 ***********
  30 API Version
  31 ***********
  32
  33 APIs are described with a  state version with "v" following the API Name,
  34 e.g.:  ``nbi/api/v4/productOrder``.
  35 The schema associated with a REST API must have its version number aligned
  36 with that of the REST API.
  37
  38 The version number has major, minor and revision numbers. E.g. v1.0.0
  39 The version number (without the revision number) is held in the URI.
  40
  41 The major version number is incremented for an incompatible change.
  42 The minor version number is incremented for a compatible change.
  43 For minor modifications of the API, version numbering must not be updated,
  44 provided the following  backward compatibility rules are respected:
  45
  46 - New elements in a data type must be optional (``minOccurs=0``)
  47 - Changes in the cardinality of an attribute in a data type must be from
  48   mandatory to optional or from lower to greater
  49 - New attributes defined in an element must be optional (absence of
  50   ``use="required"``).
  51 - If new enumerated values are included, the former ones and its meaning must
  52   be kept.
  53 - If new operations are added, the existing operations must be kept
  54 - New parameters added to existing operations must be optional and existing
  55   parameters must be kept
  56
  57 For major modifications of the API, not backward compatible and forcing client
  58 implementations to be changed, the version number must be updated.
  59
  60 *********
  61 API Table
  62 *********
  63
  64 .. |pdf-icon| image:: images/pdf.png
  65               :width: 40px
  66
  67 .. |swagger-icon| image:: images/swagger.png
  68                   :width: 40px
  69
  70
  71 .. |swaggerUI-icon| image:: images/swaggerUI.png
  72                     :width: 40px
  73
  74 .. |html-icon| image:: images/html.png
  75                :width: 40px
  76
  77 .. |plantuml-icon| image:: images/uml.jpg
  78                   :width: 40px
  79
  80 .. |postman-icon| image:: images/postman.png
  81                   :width: 40px
  82
  83 .. |xml-icon| image:: images/text_xml.png
  84                   :width: 40px
  85
  86 .. csv-table::
  87    :header: "API", "|swagger-icon|", "|swagger-icon|", "|plantuml-icon|", "|xml-icon|"
  88    :widths: 10,5,5,5,5
  89
  90    " ", "json file", "yaml file", "plant UML file", "xml schemas"
  91    "hub", ":download:`link <api_hub/swagger.json>`", ":download:`link <api_hub/swagger.yaml>`", ":download:`link <api_hub/api.plantuml>`", ":download:`link <api_hub/model.xsd>`"
  92    "serviceCatalog", ":download:`link <api_serviceCatalog/swagger.json>`", ":download:`link <api_serviceCatalog/swagger.yaml>`", ":download:`link <api_serviceCatalog/api.plantuml>`", ":download:`link <api_serviceCatalog/model.xsd>`"
  93    "serviceInventory", ":download:`link <api_serviceInventory/swagger.json>`", ":download:`link <api_serviceInventory/swagger.yaml>`", ":download:`link <api_serviceInventory/api.plantuml>`", ":download:`link <api_serviceInventory/model.xsd>`"
  94    "serviceOrder", ":download:`link <api_serviceOrder/swagger.json>`", ":download:`link <api_serviceOrder/swagger.yaml>`", ":download:`link <api_serviceOrder/api.plantuml>`", ":download:`link <api_serviceOrder/model.xsd>`"
  95    "status", ":download:`link <api_status/swagger.json>`", ":download:`link <api_status/swagger.yaml>`", ":download:`link <api_status/api.plantuml>`", ":download:`link <api_status/model.xsd>`"
  96
  97 ***************
  98 API Description
  99 ***************
 100
 101 --------------
 102 serviceCatalog
 103 --------------
 104
 105 This API is based from TMF633 serviceCatalog. Only high level information
 106 is provided - Swagger is documented.
 107
 108 Only ``serviceSpecification`` resource is provided.
 109 Information are retrieved in **SDC** (and in TOSCA file)
 110 - Only GET operation is provided - this API does not update **SDC**.
 111
 112 Only characteristics at service level will be retrieved in ONAP TOSCA file.
 113 For example if an ONAP service is composed of VNF and the VF module, the
 114 ``serviceSpecification`` resource will only feature characteristic described in
 115 the ONAP service TOSCA model and not attributes in the TOSCA files for VNF
 116 or VF module.
 117
 118 Only *basic* service characteristics will be managed in this release. By
 119 *basic* we mean string, boolean, integer parameter type and we do not manage
 120 *map* or *list* parameter type.
 121
 122
 123 **GET serviceSpecification(list)**
 124
 125 Example: ``GET /nbi/api/v4/serviceSpecification/
 126 ?category=NetworkService&distributionStatus=DISTRIBUTED``
 127
 128 It is possible to retrieve a list of ``serviceSpecification`` (get by list).
 129
 130 Only attributes ``category`` and ``distributionStatus`` are available for
 131 ``serviceSpecification`` filtering. It is possible to select retrieved
 132 attributes using fields attribute.
 133
 134 If no ``serviceSpecification`` matches, an empty list is send back.
 135
 136 **GET service Specification (id)**
 137
 138 Example: ``GET /nbi/api/v4/serviceSpecification/{uuid}``
 139
 140 It is use to retrieve one ``serviceSpecification`` - all available information
 141 are retieved (see Swagger for description)
 142
 143 **GET service Specification Schema (id)**
 144
 145 Example:
 146 ``GET /nbi/api/v4/serviceSpecification/{uuid}/specificationInputSchema``
 147
 148 It is use to retrieve one  input schema from the tosca file stored in **NBI**
 149 - all available information are retieved (see Swagger for description)
 150
 151 ----------------
 152 serviceInventory
 153 ----------------
 154
 155 This API is based from TMF638 serviceInventory. Only high level information
 156 is provided - Swagger is documented.
 157
 158 This API retrieves service(s) in the **A&AI** inventory. Only following
 159 attributes will be retrieve in service inventory: ``id``, ``name``, ``state``
 160 and ``type``
 161
 162 **GET Service Inventory (list)**
 163
 164 Example: ``GET /nbi/api/v4/service/?relatedParty.id=Pontus``
 165
 166 GET (by list) allows to request with following criteria (all optional) :
 167
 168 *   ``id`` (id of the service instance) - id of the service instance
 169     (inventory)
 170 *   ``serviceSpecification.id`` - id of the service specification (catalog)
 171 *   ``serviceSpecification.name`` - name of the service specification (catalog)
 172 *   ``relatedParty.id`` - id of the (**A&AI**) customer - if not filled we use
 173     *generic* customer
 174
 175 if no service matches, an empty list is send back.
 176
 177 1. If a request is send without any parameter, we'll retrieve the list of
 178    service-instance for the *generic* customer
 179 2. If only customer parameter is filled (``relatedParty.id`` +
 180    role= relatedParty'ONAPcustomer') we'll retrieve the list of
 181    service-instance for this customer
 182 3. If serviceSpecification.id or name is filled we'll retrieve the list of
 183    Service instance (from this service specification) - We'll use the customer
 184    id if provided (with Role='ONAPcustomer) or generic if no customer id
 185    provided
 186
 187 **GET Service Inventory (id)**
 188
 189 Example: ``GET /nbi/api/v4/service/{id}`` When querying for a specific service
 190 instance id, no additional filters are required.
 191
 192 The Service Inventory API will retrieve the service instance data from A&AI
 193 using the nodes query with the service instance id as the key.
 194 ``relatedParty.id`` + ``serviceSpecification.name`` are added to the response
 195 based on the A&AI service instance url.
 196
 197 ------------
 198 serviceOrder
 199 ------------
 200
 201 This API is based from  TMF641 serviceOrder. Only high level information
 202 is provided - Swagger is documented.
 203
 204 It is possible to use POST operation to create new ``serviceOrder`` in **NBI**
 205 and triggers service provisioning. GET operation is also available to retrieve
 206 one service order by providing id or a list of service order. For this release,
 207 only a subset of criteria is available:
 208
 209 * ``externalId``
 210 * ``state``
 211 * ``description``
 212 * ``orderDate.gt`` (orderDate must be greater - after -than)
 213 * ``orderDate.lt`` (orderDate must be lower-before - than)
 214 * ``fields`` - attribute used to filter retrieved attributes (if needed) and
 215   also for sorted SO
 216 * ``offset`` and ``limit`` are used for pagination purpose
 217
 218 ServiceOrder will manage following ``actionItem`` action:
 219
 220 * ``add`` - a new service will be created
 221 * ``delete`` - an existing service will be deleted
 222 * ``change`` - an existing service will be deleted and then created with new
 223   attribute value
 224
 225 **Prerequisites & assumptions**
 226
 227 * Cloud & tenant information MUST BE defined in the external API property file
 228 * Management of ONAP customer for add service action
 229
 230 With the current version of APIs used from **SO** and **A&AI** we need to
 231 manage a *customer*. This customer concept is confusing with Customer BSS
 232 concept. We took the following rules to manage the *customer* information:
 233
 234 * It could be provided through a ``serviceOrder`` in the service Order a
 235   ``relatedParty`` with role ``ONAPcustomer`` should be provided in the
 236   ``serviceOrder`` header (we will not consider in this release the party
 237   at item level). External API component will check if this customer exists
 238   and create it in **A&AI** if not.
 239 * If no ``relatedParty`` is provided, the service will be affected to
 240   ``generic customer`` (dummy customer) - we assume this ``generic customer``
 241   always exists.
 242 * Additionally **NBI** will create in **A&AI** the service-type if it did not
 243   exists for the customer
 244
 245 **ServiceOrder management in NBI will support 2 modes:**
 246
 247 * E2E integration - **NBI** calls **SO** API to perform an End-To-end
 248   integration
 249 * Service-level only integration - **NBI** will trigger only **SO** request at
 250   serviceInstance level. **SO** prerequisite: **SO** must be able to find a
 251   BPMN to process service fulfillment (integrate VNF, VNF activation in
 252   **SDNC**, VF module
 253
 254 The choice of the mode is done in NBI depending on information retrieved in
 255 **SDC**. If the serviceSpecification is within a Category "E2E Service" ,
 256 **NBI** will use E2E **SO** API, if not only API at service instance level
 257 will be used.
 258
 259 There is no difference or specific expectation in the service order API used
 260 by **NBI** user.
 261
 262 **ServiceOrder tracking**
 263
 264 State management: States are only managed by ServiceOrder component and could
 265 not be updated from north side via API.
 266 Accordingly to service order item fulfillment progress, order item state are
 267 updated. Order state is automatically updated based on item state.
 268 Additionnally to this state, **NBI** provided a completion percent progress to
 269 have detailled information about order progress.
 270 Order Message are retrieved in the ``GET serviceOrder`` to provide **NBI** used
 271 addtionnal information about ``serviceOrder`` management.
 272
 273 **Notification:**
 274
 275 It is possible for an external system to subscribe to service order
 276 notifications. 3 events are managed:
 277
 278 * A new service order is created in **NBI**
 279 * A service order state changes
 280 * A service order item state changes
 281
 282 It is also possible to subscribe to **AAI** and **SDC** notifications via
 283 **NBI**.
 284 4 events are managed:
 285
 286 * A new service is created in  **AAI***
 287 * A service attribute value is changed in **AAI**
 288 * A service is removed in **AAI**
 289 * A service specification is distributed in **SDC**
 290
 291 These 7 events have distinct notification allowing any system to subscribe to
 292 one, two or all notification types.
 293
 294 The implementation will be split in 2 components:
 295
 296 * A HUB resource must be managed within the NBI/serviceOrder API. This HUB
 297   resource allows system to subscribe to **NBI** notification
 298 * An Event API must be available at listener side in order to be able to
 299   receive Listener (when event occurs). **NBI** will be upgraded to use this
 300   API as client - **NBI** will shoot ``POST listener/``
 301
 302 The following diagram illustrates such notification flow:
 303
 304 .. image:: images/notification.jpg
 305    :width: 800px
 306
 307 **East-west interaction of ONAP instances through External API**
 308
 309 Operator's SO component will talk to service provider's external API component
 310 through its own external API component.
 311
 312 External API support two methods of posting a Service Order or registering for
 313 Hub.
 314
 315 1. If the incoming request is per current implementation (no additional headers
 316 ) then no changes will be made. The request will be serviced per BAU flow.
 317 2. If the incoming request has additional *Target* header parameters, External
 318 API will identify that the request has to be relayed to another ONAP instance
 319 and route the request accordingly.
 320
 321 Target parameter: The public endpoint url for target ONAP instance's External
 322 API, for instance
 323 http://externalDomain/nbi/api/vX
 324
 325 * For posting service order and getting service order status, the request will
 326   be relayed to target (service provider's External API) as-is. These are
 327   synchronous requests and operator's External API will wait for response from
 328   the target and relay it back to original calling system (operator's SO).
 329 * For Hub API, there is an additional step required. The listener from calling
 330   system (operator's SO) will be replaced with External APIs own listener.
 331   A mapping of registered subscriber and its original listener will be
 332   maintained in External API's DB. Operator's External API will relay the Hub
 333   API call to service provider's External API. The service provider's External
 334   API will register operator's External API as a listener.
 335 * After SO processing in service provider's ONAP is completed (irrespective of
 336   status - reject, success, fail etc), service provider's External API will
 337   notify the operator's External API about request completion. Operator's
 338   External API will look-up for registered subscriber and its original listener
 339   (operator's SO) and relay the message.
 340
 341 Operator's Service Orchestrator will invoke its own External API component and
 342 add SP Partner URL in the header. After receiving an acknowledgement for
 343 Service Order request, the SO component will register with External API's hub
 344 and provide its listener for processing callback events.
 345
 346 Technical information about **East-west interaction exercise** design
 347 specification and API Flow illustration (with example messages) could be found
 348 here:
 349
 350 https://wiki.onap.org/download/attachments/8227019/CCVPN%20Phase%202%20HLD.docx?api=v2
 351
 352
 353 ***************
 354 Developer Guide
 355 ***************
 356
 357 Technical information about **NBI** (dependencies, configuration, running &
 358 testing) could be found here:
 359 :doc:`NBI_Developer_Guide <../architecture/NBI_Developer_Guide>`
 360
 361 API Flow illustration (with example messages) is described in this document:
 362 :download:`nbicallflow.pdf <pdf/nbicallflow.pdf>`