You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

This page captures requirements for POMBA context builders to follow so they can plug into the POMBA framework and enable audit reports from new data sources. Context builders are standalone pieces of software that expose the context builder API.


API

All context builders must support a REST API with the following features.  If the request is not well-formed or is missing mandatory parameters, the request shall return an error, as appropriate.

The API shall be compliant to the ONAP API versioning strategy


GET  http://<host>:<port>/<server.contextPath>/service/context?<parameters>

ParameterMandatory?Description
ServiceInstanceIdYInstance id of the service being audited
ModelVersionIdN

Model UUID as published in service model metadata

ModelInvariantIdN

SDC generated invariant id as published in   service model metadata

Header NameMandatory?Description
X-TransactionIdN

Unique transaction ID.  If it is not   sent it will be automatically generated by on a request receipt.

X-FromAppIdYFor  auditing  purpose  each  component  calling API should identify  itself  by sending its  identity. If this header with non-null value is not supplied the HTTP Request will be rejected with '400 Bad Syntax’ response code.
Accept NDetermines the format of the body of the response. Valid values are :  “application/json”


Outputs

JSON compliant to the following data model.

Error Handling

The following are requirements against the error reporting solution

  1. Must be possible to return a mixture of results and errors to handle the case, for example, where for a given service, some service components provided information while others did not.
  2. Must be able to differentiate between information missing because the context builder does not support it and information missing because the information was not there as expected
  3. Must be able to report errors at the following levels
    1. Service instance
    2. Service component
    3. Attribute

See also LOG-392 - Getting issue details... STATUS

  • No labels