summaryrefslogtreecommitdiffstats
path: root/docs/consumedapis/consumedapis.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/consumedapis/consumedapis.rst')
-rw-r--r--docs/consumedapis/consumedapis.rst52
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/consumedapis/consumedapis.rst b/docs/consumedapis/consumedapis.rst
index fd5395f..66e5885 100644
--- a/docs/consumedapis/consumedapis.rst
+++ b/docs/consumedapis/consumedapis.rst
@@ -5,3 +5,55 @@
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/"
+