summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarcin Rzepecki <marcin.rzepecki@nokia.com>2021-03-25 14:47:56 +0100
committerMarcin Rzepecki <marcin.rzepecki@nokia.com>2021-03-25 14:47:56 +0100
commitc1e2be87038ba1297a24809bc17073e764870722 (patch)
tree3f04728e68f19331598fbbace220d3a7c2574188
parentf971a3343283c07e0a7cf1f4634229430a497e55 (diff)
bug fix - add missing required information to docs.
Issue-ID: SO-3571 Signed-off-by: Marcin Rzepecki <marcin.rzepecki@nokia.com> Change-Id: I365980d9ef4c9451bd3b4074d3d910210d452de8
Diffstat
-rw-r--r--docs/api/apis/serviceInstances-api.rst201
1 files changed, 152 insertions, 49 deletions
diff --git a/docs/api/apis/serviceInstances-api.rst b/docs/api/apis/serviceInstances-api.rst
index a46af713dc..b639427333 100644
--- a/docs/api/apis/serviceInstances-api.rst
+++ b/docs/api/apis/serviceInstances-api.rst
@@ -43,6 +43,14 @@ Create service instance
|Content-Type |application/json |
+--------------------+--------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -51,7 +59,7 @@ Request Body:
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
-RequestDetails Object
+RequestDetails Object
+-------------------+--------------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -77,7 +85,7 @@ RequestDetails Object
|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
+-------------------+--------------------------+-------------------------------------------------+
-ModelInfo Object
+ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -106,7 +114,7 @@ ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
-SubscriberInfo Object
+SubscriberInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -116,7 +124,7 @@ SubscriberInfo Object
|SubscriberName |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
-RequestInfo Object
+RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -142,7 +150,7 @@ RequestInfo Object
|requestorId |String |requestorId of the request |
+-------------------------+------------------+-------------------------------------------------+
-RequestParameters Object
+RequestParameters Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -166,7 +174,7 @@ RequestParameters Object
|controllerType |String |controllerType |
+-------------------------+------------------+-------------------------------------------------+
-UserParams Object
+UserParams Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -176,7 +184,7 @@ UserParams Object
|value |String |Value of the tag |
+-------------------------+------------------+-------------------------------------------------+
-CloudConfiguration Object
+CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -238,6 +246,14 @@ Delete service instance
|Content-Type |application/json |
+--------------------+--------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -246,7 +262,7 @@ Request Body:
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
-RequestDetails Object
+RequestDetails Object
+-------------------+-------------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -256,7 +272,7 @@ RequestDetails Object
|requestInfo |requestInfo Object |Content of requestInfo object. |
+-------------------+-------------------------+-------------------------------------------------+
-ModelInfo Object
+ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -270,7 +286,7 @@ ModelInfo Object
|ModelVersion |String |Version of the model |
+-------------------------+------------------+-------------------------------------------------+
-RequestInfo Object
+RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -294,6 +310,14 @@ Create Volume Group
|Content-Type |application/json |
+--------------------+------------------------------------------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -302,7 +326,7 @@ Request Body:
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
-RequestDetails Object
+RequestDetails Object
+-------------------+--------------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -328,7 +352,7 @@ RequestDetails Object
|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
+-------------------+--------------------------+-------------------------------------------------+
-ModelInfo Object
+ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -356,7 +380,7 @@ ModelInfo Object
|modelInstanceName |String |The Model Instance name |
+-------------------------+------------------+-------------------------------------------------+
-CloudConfiguration Object
+CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -368,7 +392,7 @@ CloudConfiguration Object
|aicNodeClli |String |aicNodeClli property |
+-------------------------+------------------+-------------------------------------------------+
-RequestInfo Object
+RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -394,7 +418,7 @@ RequestInfo Object
|requestorId |String |requestorId of the request |
+-------------------------+------------------+-------------------------------------------------+
-relatedInstance List
+relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -402,7 +426,7 @@ relatedInstance List
|relatedInstance |Object |relatedInstance Object |
+-------------------------+------------------+-------------------------------------------------+
-relatedInstance List
+relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -427,6 +451,14 @@ Delete Volume Group
|Content-Type |application/json |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -435,7 +467,7 @@ Request Body:
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
-RequestDetails Object
+RequestDetails Object
+---------------------+-------------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -447,7 +479,7 @@ RequestDetails Object
|requestInfo |requestInfo Object |Content of requestInfo object. |
+---------------------+-------------------------+-------------------------------------------------+
-ModelInfo Object
+ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -457,7 +489,7 @@ ModelInfo Object
|ModelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
-CloudConfiguration Object
+CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -467,7 +499,7 @@ CloudConfiguration Object
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
-RequestInfo Object
+RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -490,6 +522,14 @@ Create VF Module
|Content-Type |application/json |
+--------------------+---------------------------------------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -498,7 +538,7 @@ Request Body:
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
-RequestDetails Object
+RequestDetails Object
+---------------------+-------------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -512,7 +552,7 @@ RequestDetails Object
|relatedInstanceList |List |Content of relatedInstanceList. |
+---------------------+-------------------------+-------------------------------------------------+
-ModelInfo Object
+ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -530,7 +570,7 @@ ModelInfo Object
|ModelCustomization Name |String |The Model Customization name |
+-------------------------+------------------+-------------------------------------------------+
-CloudConfiguration Object
+CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -540,7 +580,7 @@ CloudConfiguration Object
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
-RequestInfo Object
+RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -552,7 +592,7 @@ RequestInfo Object
|SuppressRollback |Boolean |SuppressRollback |
+-------------------------+------------------+-------------------------------------------------+
-relatedInstance List
+relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -560,7 +600,7 @@ relatedInstance List
|relatedInstance |Object |relatedInstance Object |
+-------------------------+------------------+-------------------------------------------------+
-relatedInstance List
+relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -587,6 +627,14 @@ Delete VF Module
|Content-Type |application/json |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -595,7 +643,7 @@ Request Body:
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
-RequestDetails Object
+RequestDetails Object
+---------------------+-------------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -607,7 +655,7 @@ RequestDetails Object
|requestInfo |requestInfo Object |Content of requestInfo object. |
+---------------------+-------------------------+-------------------------------------------------+
-ModelInfo Object
+ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -625,7 +673,7 @@ ModelInfo Object
|ModelCustomization Name |String |The Model Customization name |
+-------------------------+------------------+-------------------------------------------------+
-CloudConfiguration Object
+CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -635,7 +683,7 @@ CloudConfiguration Object
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
-RequestInfo Object
+RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -659,6 +707,14 @@ Create VNF
|Content-Type |application/json |
+--------------------+-------------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -667,7 +723,7 @@ Request Body:
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
-RequestDetails Object
+RequestDetails Object
+-------------------+--------------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -693,7 +749,7 @@ RequestDetails Object
|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
+-------------------+--------------------------+-------------------------------------------------+
-ModelInfo Object
+ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -721,7 +777,7 @@ ModelInfo Object
|modelInstanceName |String |The Model Instance name |
+-------------------------+------------------+-------------------------------------------------+
-CloudConfiguration Object
+CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -731,7 +787,7 @@ CloudConfiguration Object
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
-RequestInfo Object
+RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -757,7 +813,7 @@ RequestInfo Object
|requestorId |String |requestorId of the request |
+-------------------------+------------------+-------------------------------------------------+
-relatedInstance List
+relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -765,7 +821,7 @@ relatedInstance List
|relatedInstance |Object |relatedInstance Object |
+-------------------------+------------------+-------------------------------------------------+
-relatedInstance List
+relatedInstance List
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -775,7 +831,7 @@ relatedInstance List
|modelInfo |Object |Content of modelInfo object. |
+-------------------------+------------------+-------------------------------------------------+
-RequestParameters Object
+RequestParameters Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -783,7 +839,7 @@ RequestParameters Object
|UserParams |Array |The product family Id. |
+-------------------------+------------------+-------------------------------------------------+
-UserParams Object
+UserParams Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -808,6 +864,14 @@ Delete VNF
|Content-Type |application/json |
+--------------------+-----------------------------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -816,7 +880,7 @@ Request Body:
|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. |
+----------------+---------+-----------+--------------------------+-------------------------------------------+
-RequestDetails Object
+RequestDetails Object
+---------------------+-------------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -830,7 +894,7 @@ RequestDetails Object
|requestParameters |requestParameters Object |Content of requestParameters object. |
+---------------------+-------------------------+-------------------------------------------------+
-ModelInfo Object
+ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -840,7 +904,7 @@ ModelInfo Object
|ModelName |String |Name of the Model |
+-------------------------+------------------+-------------------------------------------------+
-CloudConfiguration Object
+CloudConfiguration Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -850,7 +914,7 @@ CloudConfiguration Object
|tenantId |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
-RequestInfo Object
+RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -858,7 +922,7 @@ RequestInfo Object
|Source |String |source of the request |
+-------------------------+------------------+-------------------------------------------------+
-RequestParameters Object
+RequestParameters Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -866,7 +930,7 @@ RequestParameters Object
|UserParams |Array |The product family Id. |
+-------------------------+------------------+-------------------------------------------------+
-UserParams Object
+UserParams Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -891,6 +955,14 @@ GET Orchestration Request
|Content-Type |application/json |
+--------------------+-------------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Response Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -917,7 +989,7 @@ Request Object
|requestStatus |M |1 |requestStatus Object |Type of the request. |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
-RequestDetails Object
+RequestDetails Object
+-------------------+--------------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -943,7 +1015,7 @@ RequestDetails Object
|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. |
+-------------------+--------------------------+-------------------------------------------------+
-ModelInfo Object
+ModelInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -971,7 +1043,7 @@ ModelInfo Object
|modelInstanceName |String |The Model Instance name |
+-------------------------+------------------+-------------------------------------------------+
-SubscriberInfo Object
+SubscriberInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -981,7 +1053,7 @@ SubscriberInfo Object
|SubscriberName |String |Name of the Subscriber |
+-------------------------+------------------+-------------------------------------------------+
-RequestInfo Object
+RequestInfo Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -1007,7 +1079,7 @@ RequestInfo Object
|requestorId |String |requestorId of the request |
+-------------------------+------------------+-------------------------------------------------+
-RequestParameters Object
+RequestParameters Object
+-------------------------+------------------+-------------------------------------------------+
|Attribute |Content |Description |
@@ -1045,6 +1117,37 @@ GET Orchestration Requests
|Content-Type |application/json |
+--------------------+--------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
+Query Parameters:
+
++-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
+|Attribute |Required |Cardinality|Content|Description |
++===================+=========+===========+=======+=====================================================================================================+
+|filter |Y |1 |String | Orchestration filter (scheme KeyTypes:Option:Value) |
+| | | | | |
+| | | | | KeyTypes: |
+| | | | | serviceInstanceId, serviceInstanceName, vnfInstanceId, pnfName, vnfInstanceName, |
+| | | | | vfModuleInstanceId, vfModuleInstanceName, volumeGroupInstanceId, volumeGroupInstanceName, |
+| | | | | networkInstanceId, networkInstanceName, configurationInstanceId, configurationInstanceName, |
+| | | | | lcpCloudRegionId, tenantId, modelType, requestorId, requestExecutionDate, startTime, requestScope |
+| | | | | |
+| | | | | Option: |
+| | | | | EQUALS (or any not null string), DOES_NOT_EQUAL [e.g. modelType:EQUALS:VNF, modelType:qwe:VNF ] |
+| | | | | for KeyTypes equals startTime or requestExecutionDate: DOES_NOT_EQUAL, BETWEEN_DATES |
+| | | | | [e.g. startTime:BETWEEN_DATES:30-5-2000:30-5-2030 ] |
++-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
+|includeCloudRequest|N |1 |Boolean| Enable or disable cloud data request |
++-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
+|format |N |1 |String | Orchestration request format [DETAIL, STATUSDETAIL, SIMPLE, SIMPLENOTASKINFO] |
++-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
+
Response Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+