From f7e11655a83b6d6c79355e52960e9c8903ff565c Mon Sep 17 00:00:00 2001 From: Rene Robert Date: Mon, 23 Apr 2018 14:15:02 +0000 Subject: add info in doc Issue-ID: EXTAPI-74 Change-Id: Iebea5ef0fa56ae0c9c11babdc108acc9b3ee0e40 Signed-off-by: Rene Robert --- docs/consumedapis/consumedapis.rst | 44 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) (limited to 'docs/consumedapis') diff --git a/docs/consumedapis/consumedapis.rst b/docs/consumedapis/consumedapis.rst index fd5395f..6962e02 100644 --- a/docs/consumedapis/consumedapis.rst +++ b/docs/consumedapis/consumedapis.rst @@ -5,3 +5,47 @@ Consumed APIs ============= + + +NBI application is interacting with 3 ONAP APIs + +*************** +SDC API +*************** + +this API is used to provide Service Catalog information +Information are retrieved in SDC (and in Tosca "service template" file) - Only GET operation is provided - this API DID NOT UPDATE SDC + + SDC_ROOT_URL = "/sdc/v1/catalog/services/"; + SDC_GET_PATH = "/metadata"; + SDC_TOSCA_PATH = "/toscaModel"; + +*************** +AAI API +*************** + +this API is used to provide Service Inventory information +This API retrieves service(s) in the AAI inventory. Only following attributes will be retrieve in service inventory: id, name and type (no state or startDate available ) + + AAI_GET_TENANTS_PATH = "/aai/v11/cloud-infrastructure/cloud-regions/cloud-region/$onap.cloudOwner/$onap.lcpCloudRegionId/tenants"; + AAI_GET_CUSTOMER_PATH = "/aai/v11/business/customers/customer/"; + AAI_GET_SERVICES_FOR_CUSTOMER_PATH = + "/aai/v11/business/customers/customer/$customerId/service-subscriptions"; + AAI_PUT_SERVICE_FOR_CUSTOMER_PATH = + "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/"; + AAI_GET_SERVICE_FOR_CUSTOMER_PATH = + "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/$serviceSpecName/service-instances/service-instance/$serviceId"; + AAI_GET_SERVICE_INSTANCES_PATH = + "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/$serviceSpecName/service-instances/"; + + +*************** +SO API +*************** + +this API is used to perform Service Order and thus instantiate a service + + + MSO_CREATE_SERVICE_INSTANCE_PATH = "/ecomp/mso/infra/serviceInstance/v4"; + MSO_GET_REQUEST_STATUS_PATH = "/ecomp/mso/infra/orchestrationRequests/v4/"; + MSO_DELETE_REQUEST_STATUS_PATH = "/ecomp/mso/infra/serviceInstances/"; -- cgit 1.2.3-korg