summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api/apis/SO_Interface.rst (renamed from docs/api/SO_Interface.rst)381
-rw-r--r--docs/api/offered_consumed_apis.rst11
-rw-r--r--docs/developer_info/developer_information.rst11
3 files changed, 19 insertions, 384 deletions
diff --git a/docs/api/SO_Interface.rst b/docs/api/apis/SO_Interface.rst
index 4f3d9146e4..b079989aff 100644
--- a/docs/api/SO_Interface.rst
+++ b/docs/api/apis/SO_Interface.rst
@@ -5,7 +5,7 @@
SO Interfaces
================================
-.. image:: ../images/SO_1.png
+.. image:: ../../images/SO_1.png
SO APIs
----------------
@@ -1151,8 +1151,8 @@ RequestStatus Object
|percentProgress |String |percentage of progress |
+-------------------------+------------------+-------------------------------------------------+
-SDC API
---------
+SDC Client API
+------------------
Get List of Existing Catalog Assets
+++++++++++++++++++++++++++++++++++
@@ -1371,380 +1371,9 @@ Response:
|Content-Disposition |M |Specifies the name of file to store the downloaded artifact’s payload ( RFC 2183) . |
+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
-Upload Artifact
-+++++++++++++++
-
-+--------------------+-----------------------------------------------------------------------------------------------+
-|Interface Definition|Description |
-+====================+===============================================================================================+
-|URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts|
-+--------------------+-----------------------------------------------------------------------------------------------+
-|Operation Type |POST |
-+--------------------+-----------------------------------------------------------------------------------------------+
-
-Request Parameters:
-
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|Attribute |Qualifier|Cardinality|Content|Description |
-+==============================+=========+===========+=======+=====================================================================================+
-|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-
-Request Body
-++++++++++++
-
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|Attribute |Qualifier|Cardinality|Content|Description |
-+==============================+=========+===========+=======+=====================================================================================+
-|payloadData |M |1 |String |The data of the artifact after Base64 encoding |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|artifactLabel |M |1 |String |Identifier of the artifact within the VF / Service. |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|artifactName |M |1 |String |The name of the artifact |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|artifactType |M |1 |String |The type of the artifact |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|artifactGroupType |M |1 |String |Whether the artifact is informational or deployment. |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|description |M |1 |String |Description of the artifact |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-
-Request Headers:
-
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Header Name |Qualifier|Description |
-+===================+=========+=========================================================================================+
-|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|X-ECOMP-InstanceID |Y |Instance ID |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Authorization |Y |Base64 encoded username:password |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Content-Type |Y |Valid value is : application/json |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Content-MD5 |Y |The value for this header must be the MD5 checksum over the whole json body |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-
-Response:
-
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|Attribute |Qualifier|Content|Description |
-+====================+=========+=======+===================================================================================================+
-|artifactName |M |String |Artifact File name |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|artifactType |M |String |Artifact Type |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|artifactURL |M |String |Relative artifact’s URL. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|artifactDescription |M |String |Artifact Description. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|artifactTimeout |N |String |Will be populated only if its value is not 0. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|artifactChecksum |Y |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|artifactVersion |Y |String |Service Version . |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-
-Update Artifact
-+++++++++++++++
-
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-|Interface Definition|Description |
-+====================+==============================================================================================================+
-|URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-|Operation Type |POST |
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-
-Request Parameters:
-
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|Attribute |Qualifier|Cardinality|Content|Description |
-+==============================+=========+===========+=======+=====================================================================================+
-|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|artifactUUID |M |1 |String |The uuid of the artifact as published in the response of the upload/update operation |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-
-Request Headers:
-
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Header Name |Qualifier|Description |
-+===================+=========+=========================================================================================+
-|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|X-ECOMP-InstanceID |Y |Instance ID |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Authorization |Y |Base64 encoded username:password |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Content-Type |Y |Valid value is : application/json |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Content-MD5 |Y |The value for this header must be the MD5 checksum over the whole json body |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-
-Request Body:
-
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|Attribute |Qualifier|Cardinality|Content|Description |
-+==============================+=========+===========+=======+=====================================================================================+
-|payloadData |M |1 |String |The data of the artifact after Base64 encoding |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|artifactLabel |M |1 |String |Identifier of the artifact within the VF / Service. |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|artifactName |M |1 |String |The name of the artifact |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|artifactType |M |1 |String |The type of the artifact |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|artifactGroupType |M |1 |String |Whether the artifact is informational or deployment. |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|description |M |1 |String |Description of the artifact |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-
-Response:
-
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|Attribute |Qualifier|Content|Description |
-+====================+=========+=======+===================================================================================================+
-|artifactName |M |String |Artifact File name |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|artifactType |M |String |Artifact Type |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|artifactURL |M |String |Relative artifact’s URL. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|artifactDescription |M |String |Artifact Description. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|artifactTimeout |N |String |Will be populated only if its value is not 0. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|artifactChecksum |Y |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|artifactVersion |Y |String |Service Version . |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-
-Delete Artifact
-+++++++++++++++
-
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-|Interface Definition|Description |
-+====================+==============================================================================================================+
-|URI |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-|Operation Type |DELETE |
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-
-Request Parameters:
-
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|Attribute |Qualifier|Cardinality|Content|Description |
-+==============================+=========+===========+=======+=====================================================================================+
-|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|artifactUUID |M |1 |String |The uuid of the artifact as published in the response of the upload/update operation |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-|resourceInstanceNormalizedName|M |1 |String |Normalized name of resource |
-+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
-
-Request Headers:
-
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Header Name |Qualifier|Description |
-+===================+=========+=========================================================================================+
-|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|X-ECOMP-InstanceID |Y |Instance ID |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Authorization |Y |Base64 encoded username:password |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-
-Response:
-
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|Attribute |Qualifier|Content|Description |
-+====================+=========+=======+===================================================================================================+
-|artifactUUID |Y |String |Global UUID generated by SDC each time when artifact payload is updated. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-
-Update Lifecycle
-++++++++++++++++
-
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-|Interface Definition|Description |
-+====================+==============================================================================================================+
-|URI |/sdc/v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation} |
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-|Operation Type |POST |
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-
-Request Parameters:
-
-+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
-|Attribute |Qualifier|Cardinality|Content|Description |
-+==============================+=========+===========+=======+=====================================================================================================+
-|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
-+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
-|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
-+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
-|lifecycleOperation |M |1 |String |The lifecycle operation to be performed on the asset.Valid values are: Checkin / Checkout / Certify |
-+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
-
-Request Headers:
-
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Header Name |Qualifier|Description |
-+===================+=========+=========================================================================================+
-|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|X-ECOMP-InstanceID |Y |Instance ID |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Authorization |Y |Base64 encoded username:password |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-
-Request Parameters:
-
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Attribute |Qualifier|Description |
-+===================+=========+=========================================================================================+
-|userRemarks |N |Short description (free text) about the asset version being changed |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-
-Response:
-
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|Attribute |Qualifier|Content|Description |
-+====================+=========+=======+===================================================================================================+
-|uuid |Y |String |UUID generated by SDC per each major version of the asset |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|invariantUUID |Y |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|name |Y |String |The name of the asset. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|version |Y |String |The asset version in SDC catalog |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|category |Y |String |Category of the asset. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|subcategory |Y |String |Sub-category of the asset. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|resourceType |Y |String |The type of resource. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|lifecycleState |Y |String |The lifecycle state of the asset. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|lastUpdaterUserId |Y |String |User ID of the SDC designer who was the last to update the asset for this major version. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-
-Create Resource
-+++++++++++++++
-
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-|Interface Definition|Description |
-+====================+==============================================================================================================+
-|URI |/sdc/v1/catalog/resources |
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-|Operation Type |POST |
-+--------------------+--------------------------------------------------------------------------------------------------------------+
-
-Request Headers:
-
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Header Name |Qualifier|Description |
-+===================+=========+=========================================================================================+
-|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|X-ECOMP-InstanceID |Y |Instance ID |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Authorization |Y |Base64 encoded username:password |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|USER_ID |Y |The user ID of the DCAE Designer. This user must also have Designer role in SDC |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Content-Type |Y |Valid value is : application/json |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-
-Request Parameters:
-
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|Attribute |Qualifier|Description |
-+===================+=========+=========================================================================================+
-|name |Y |The name of the resource |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|description |Y |Short description of the resource |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|resourceType |Y |“VFCMT” / “VF” / “PNF” |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|category |Y |VFCMT category is “Template”. |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|subcategory |Y |VFCMT subcategory is “Monitoring Template”. |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|vendorName |Y |Vendor Name |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|vendorRelease |Y |Vendor Release |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|tags |Y |The tags are used for search options. |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|icon |Y |The icon should be pre-defined in SDC. |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-|contactId |Y |The user ID of user responsible for this VFCMT. |
-+-------------------+---------+-----------------------------------------------------------------------------------------+
-
-Response:
-
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|Attribute |Qualifier|Content|Description |
-+====================+=========+=======+===================================================================================================+
-|uuid |Y |String |UUID generated by SDC per each major version of the asset |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|invariantUUID |Y |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|name |Y |String |The name of the asset. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|version |Y |String |The asset version in SDC catalog |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|category |Y |String |Category of the asset. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|subcategory |Y |String |Sub-category of the asset. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|resourceType |Y |String |The type of resource. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|lifecycleState |Y |String |The lifecycle state of the asset. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-|lastUpdaterUserId |Y |String |User ID of the SDC designer who was the last to update the asset for this major version. |
-+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
-
-UUI API
+E2E Service API
----------------
+
Create E2E service instance
++++++++++++++++++++++++++++
diff --git a/docs/api/offered_consumed_apis.rst b/docs/api/offered_consumed_apis.rst
index f6b593a84d..0caef0a426 100644
--- a/docs/api/offered_consumed_apis.rst
+++ b/docs/api/offered_consumed_apis.rst
@@ -31,6 +31,13 @@ The list of APIs that SO offerers for monitroing the BPMN flows could be found i
"swagger json file", "yaml doc"
":download:`link <swagger/SO_MONITORING_SWAGGER.json>`", ":download:`link <swagger/SO_MONITORING_SWAGGER.yaml>`"
-
+
+Further Reading
+----------------------------------------
+
Detailed documentation can be found here:
- SO_Interface.rst \ No newline at end of file
+
+.. toctree::
+ :maxdepth: 1
+
+ apis/SO_Interface.rst \ No newline at end of file
diff --git a/docs/developer_info/developer_information.rst b/docs/developer_info/developer_information.rst
index 61be8f006f..f6d66b913d 100644
--- a/docs/developer_info/developer_information.rst
+++ b/docs/developer_info/developer_information.rst
@@ -7,14 +7,13 @@ SO Developer Information
.. toctree::
:maxdepth: 1
-
-.. developer_info_Project_Structure.rst
+
Camunda_Modeler.rst
-.. developer_info_Main_Process_Flows.rst
-.. developer_info_Subprocess_Process_Flows.rst
-.. developer_info_Project_Deployment_Strategy.rst
Building_SO.rst
Working_with_SO_Docker.rst
Camunda_Cockpit_Community_Edition.rst
Camunda_Cockpit_Enterprise_Edition.rst
- \ No newline at end of file
+.. developer_info_Project_Structure.rst
+.. developer_info_Main_Process_Flows.rst
+.. developer_info_Subprocess_Process_Flows.rst
+.. developer_info_Project_Deployment_Strategy.rst \ No newline at end of file