aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api/SO_Interface.rst26
-rw-r--r--docs/api/offered_consumed_apis.rst25
-rw-r--r--docs/api/swagger.json2302
-rw-r--r--docs/architecture/architecture.rst8
-rw-r--r--docs/developer_info/developer_information.rst18
-rw-r--r--docs/release_notes/release-notes.rst6
6 files changed, 2348 insertions, 37 deletions
diff --git a/docs/api/SO_Interface.rst b/docs/api/SO_Interface.rst
index 695cedbd48..4f3d9146e4 100644
--- a/docs/api/SO_Interface.rst
+++ b/docs/api/SO_Interface.rst
@@ -18,7 +18,7 @@ Create service instance
+--------------------+-------------------------------------+
|Interface Definition|Description |
+====================+=====================================+
-|URI |{serverRoot}/serviceInstances/v6 |
+|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6 |
+--------------------+-------------------------------------+
|Operation Type |POST |
+--------------------+-------------------------------------+
@@ -210,7 +210,7 @@ Delete service instance
+--------------------+---------------------------------------------------------+
|Interface Definition|Description |
+====================+=========================================================+
-|URI |{serverRoot}/serviceInstances/v6/{serviceInstanceId} |
+|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId} |
+--------------------+---------------------------------------------------------+
|Operation Type |DELETE |
+--------------------+---------------------------------------------------------+
@@ -263,7 +263,7 @@ Create Volume Group
+--------------------+-------------------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+===========================================================================================+
-|URI |{serverRoot}/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups |
+|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups |
+--------------------+-------------------------------------------------------------------------------------------+
|Operation Type |POST |
+--------------------+-------------------------------------------------------------------------------------------+
@@ -394,7 +394,7 @@ Delete Volume Group
+--------------------+---------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+=====================================================================================================================+
-|URI |{serverRoot}/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id} |
+|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id} |
+--------------------+---------------------------------------------------------------------------------------------------------------------+
|Operation Type |DELETE |
+--------------------+---------------------------------------------------------------------------------------------------------------------+
@@ -455,7 +455,7 @@ Create VF Module
+--------------------+----------------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+========================================================================================+
-|URI |{serverRoot}/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules |
+|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules |
+--------------------+----------------------------------------------------------------------------------------+
|Operation Type |POST |
+--------------------+----------------------------------------------------------------------------------------+
@@ -550,7 +550,7 @@ Delete VF Module
+--------------------+--------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+==============================================================================================================+
-|URI |{serverRoot}/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id} |
+|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id} |
+--------------------+--------------------------------------------------------------------------------------------------------------+
|Operation Type |DELETE |
+--------------------+--------------------------------------------------------------------------------------------------------------+
@@ -619,7 +619,7 @@ Create VNF
+--------------------+--------------------------------------------------------------+
|Interface Definition|Description |
+====================+==============================================================+
-|URI |{serverRoot}/serviceInstances/v6/{serviceInstanceId}/vnfs |
+|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs |
+--------------------+--------------------------------------------------------------+
|Operation Type |POST |
+--------------------+--------------------------------------------------------------+
@@ -766,7 +766,7 @@ Delete VNF
+--------------------+------------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+==============================================================================+
-|URI |{serverRoot}/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId} |
+|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId} |
+--------------------+------------------------------------------------------------------------------+
|Operation Type |DELETE |
+--------------------+------------------------------------------------------------------------------+
@@ -847,7 +847,7 @@ GET Orchestration Request
+--------------------+--------------------------------------------------------------+
|Interface Definition|Description |
+====================+==============================================================+
-|URI |{serverRoot}/orchestrationRequests/v6/{request-id} |
+|URI |/onap/so/infra/serviceInstantiation/orchestrationRequests/v6/{request-id} |
+--------------------+--------------------------------------------------------------+
|Operation Type |GET |
+--------------------+--------------------------------------------------------------+
@@ -998,7 +998,7 @@ GET Orchestration Requests
+--------------------+--------------------------------------------------------------+
|Interface Definition|Description |
+====================+==============================================================+
-|URI |{serverRoot}/orchestrationRequests/v6 |
+|URI |/onap/so/infra/serviceInstantiation/orchestrationRequests/v6 |
+--------------------+--------------------------------------------------------------+
|Operation Type |GET |
+--------------------+--------------------------------------------------------------+
@@ -1751,7 +1751,7 @@ Create E2E service instance
+--------------------+-------------------------------------+
|Interface Definition|Description |
+====================+=====================================+
-|URI |{serverRoot}/e2eServiceInstances/v3 |
+|URI |/onap/so/infra/serviceInstantiation/e2eServiceInstances/v3 |
+--------------------+-------------------------------------+
|Operation Type |POST |
+--------------------+-------------------------------------+
@@ -1848,7 +1848,7 @@ Delete E2E service instance
+--------------------+-----------------------------------------------+
|Interface Definition|Description |
+====================+===============================================+
-|URI |{serverRoot}/e2eServiceInstances/v3/{serviceId}|
+|URI |/onap/so/infra/serviceInstantiation/e2eServiceInstances/v3/{serviceId}|
+--------------------+-----------------------------------------------+
|Operation Type |DELETE |
+--------------------+-----------------------------------------------+
@@ -1877,7 +1877,7 @@ Query E2E service operation result
+--------------------+------------------------------------------------------------------------+
|Interface Definition|Description |
+====================+========================================================================+
-|URI |{serverRoot}/e2eServiceInstances/v3/{serviceId}/operations/{operationId}|
+|URI |/onap/so/infra/serviceInstantiation/e2eServiceInstances/v3/{serviceId}/operations/{operationId}|
+--------------------+------------------------------------------------------------------------+
|Operation Type |GET |
+--------------------+------------------------------------------------------------------------+
diff --git a/docs/api/offered_consumed_apis.rst b/docs/api/offered_consumed_apis.rst
index 6f8b7fcb89..0cf7e0f341 100644
--- a/docs/api/offered_consumed_apis.rst
+++ b/docs/api/offered_consumed_apis.rst
@@ -5,11 +5,20 @@
SO Offered and Consumed APIs
=====================================
-SO APIs
---------
-All the Service Orchestrator APIs, both inward and outward are documented in the below link of onap wiki.
-
-.. toctree::
- :maxdepth: 1
-
- SO_Interface.rst
+The list of APIs that SO offerers could be find in the following table:
+
+.. |yml-icon| image:: swagger/images/yaml.png
+ :width: 40px
+
+.. |swagger-icon| image:: swagger/images/swagger.png
+ :width: 40px
+
+.. |html-icon| image:: swagger/images/html.png
+ :width: 40px
+
+.. csv-table::
+ :header: "|Swagger-icon|", "|html-icon|", "|yml-icon|"
+ :widths: 60,60,60
+
+ "swagger json file", "html doc", "yaml doc"
+ ":download:`link <swagger/swagger.json>`", ":download:`link <swagger/swagger.html>`", ":download:`link <swagger/swagger.yaml>`"
diff --git a/docs/api/swagger.json b/docs/api/swagger.json
new file mode 100644
index 0000000000..65d7ff0d11
--- /dev/null
+++ b/docs/api/swagger.json
@@ -0,0 +1,2302 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "3.1.2",
+ "title": "SO Casablanca APIs"
+ },
+ "tags": [
+ {
+ "name": "e2eServiceInstances"
+ },
+ {
+ "name": "globalhealthcheck"
+ },
+ {
+ "name": "nodehealthcheck"
+ },
+ {
+ "name": "onapsoinfraorchestrationRequests"
+ },
+ {
+ "name": "onapsoinfraserviceInstantiation"
+ },
+ {
+ "name": "onapsoinfratasks"
+ },
+ {
+ "name": "onapsoinfracloudResources"
+ },
+ {
+ "name": "onapsoinfracloudResourcesRequests"
+ },
+ {
+ "name": "onapsoinframodelDistributions"
+ }
+ ],
+ "schemes": [
+ "https"
+ ],
+ "paths": {
+ "/e2eServiceInstances/{version}": {
+ "post": {
+ "tags": [
+ "e2eServiceInstances"
+ ],
+ "summary": "Create an E2E Service Instance on a version provided",
+ "description": "",
+ "operationId": "createE2EServiceInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][3-5]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/e2eServiceInstances/{version}/{serviceId}": {
+ "put": {
+ "tags": [
+ "e2eServiceInstances"
+ ],
+ "summary": "Update an E2E Service Instance on a version provided and serviceId",
+ "description": "",
+ "operationId": "updateE2EServiceInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][3-5]"
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "e2eServiceInstances"
+ ],
+ "summary": "Delete E2E Service Instance on a specified version and serviceId",
+ "description": "",
+ "operationId": "deleteE2EServiceInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][3-5]"
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}": {
+ "get": {
+ "tags": [
+ "e2eServiceInstances"
+ ],
+ "summary": "Find e2eServiceInstances Requests for a given serviceId and operationId",
+ "description": "",
+ "operationId": "getE2EServiceInstances",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "serviceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][3-5]"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/e2eServiceInstances/{version}/{serviceId}/scale": {
+ "post": {
+ "tags": [
+ "e2eServiceInstances"
+ ],
+ "summary": "Scale E2E Service Instance on a specified version",
+ "description": "",
+ "operationId": "scaleE2EServiceInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][3-5]"
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/e2eServiceInstances/{version}/{serviceId}/modeldifferences": {
+ "post": {
+ "tags": [
+ "e2eServiceInstances"
+ ],
+ "summary": "Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId ",
+ "description": "",
+ "operationId": "compareModelwithTargetVersion",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][3-5]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/globalhealthcheck": {
+ "get": {
+ "tags": [
+ "globalhealthcheck"
+ ],
+ "summary": "Performing global health check",
+ "description": "",
+ "operationId": "globalHealthcheck",
+ "produces": [
+ "text/html"
+ ],
+ "parameters": [
+ {
+ "name": "enableBpmn",
+ "in": "query",
+ "required": false,
+ "type": "boolean",
+ "default": true
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/nodehealthcheck": {
+ "get": {
+ "tags": [
+ "nodehealthcheck"
+ ],
+ "summary": "Performing node health check",
+ "description": "",
+ "operationId": "nodeHealthcheck",
+ "produces": [
+ "text/html"
+ ],
+ "parameters": [],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/orchestrationRequests/{version}": {
+ "get": {
+ "tags": [
+ "onapsoinfraorchestrationRequests"
+ ],
+ "summary": "Find Orchestrated Requests for a URI Information",
+ "description": "",
+ "operationId": "getOrchestrationRequest",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][4-7]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/orchestrationRequests/{version}/{requestId}": {
+ "get": {
+ "tags": [
+ "onapsoinfraorchestrationRequests"
+ ],
+ "summary": "Find Orchestrated Requests for a given requestId",
+ "description": "",
+ "operationId": "getOrchestrationRequestForReqId",
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "requestId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][4-7]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/orchestrationRequests/{version}/{requestId}/unlock": {
+ "post": {
+ "tags": [
+ "onapsoinfraorchestrationRequests"
+ ],
+ "summary": "Unlock Orchestrated Requests for a given requestId",
+ "description": "",
+ "operationId": "unlockOrchestrationRequest",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "requestId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][4-7]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/deactivateAndCloudDelete": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Deactivate and Cloud Delete VfModule instance",
+ "description": "",
+ "operationId": "deactivateAndCloudDeleteVfModuleInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnfInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vfmoduleInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/enablePort": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Enable Port Mirroring",
+ "description": "",
+ "operationId": "enablePort",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "configurationInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/disablePort": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Disable Port Mirroring",
+ "description": "",
+ "operationId": "disablePort",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "configurationInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/activate": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Activate Port Mirroring",
+ "description": "",
+ "operationId": "activatePort",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "configurationInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/deactivate": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Deactivate Port Mirroring",
+ "description": "",
+ "operationId": "deactivatePort",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "configurationInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/addRelationships": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Add Relationships to a Service Instance",
+ "description": "",
+ "operationId": "addRelationships",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][6-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/scaleOut": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "VF Auto Scale Out",
+ "description": "",
+ "operationId": "scaleOutVfModule",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnfInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/inPlaceSoftwareUpdate": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Perform VNF software update",
+ "description": "",
+ "operationId": "inPlaceSoftwareUpdate",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][6-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnfInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/applyUpdatedConfig": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Apply updated configuration",
+ "description": "",
+ "operationId": "applyUpdatedConfig",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][6-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnfInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Create a Service Instance on a version provided",
+ "description": "",
+ "operationId": "createServiceInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/activate": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Activate provided Service Instance",
+ "description": "",
+ "operationId": "activateServiceInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/deactivate": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Deactivate provided Service Instance",
+ "description": "",
+ "operationId": "deactivateServiceInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}": {
+ "delete": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Delete provided Service Instance",
+ "description": "",
+ "operationId": "deleteServiceInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/assign": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Assign Service Instance",
+ "description": "",
+ "operationId": "assignServiceInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][7]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/unassign": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Unassign Service Instance",
+ "description": "",
+ "operationId": "unassignServiceInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Create Port Mirroring Configuration",
+ "description": "",
+ "operationId": "createPortConfiguration",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}": {
+ "delete": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Delete provided Port",
+ "description": "",
+ "operationId": "deletePortConfiguration",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "configurationInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/removeRelationships": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Remove Relationships from Service Instance",
+ "description": "",
+ "operationId": "removeRelationships",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][6-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Create VNF on a specified version and serviceInstance",
+ "description": "",
+ "operationId": "createVnfInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/replace": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Replace provided VNF instance",
+ "description": "",
+ "operationId": "replaceVnfInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnfInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}": {
+ "put": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Update VNF on a specified version, serviceInstance and vnfInstance",
+ "description": "",
+ "operationId": "updateVnfInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnfInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Delete provided VNF instance",
+ "description": "",
+ "operationId": "deleteVnfInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnfInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Create VfModule on a specified version, serviceInstance and vnfInstance",
+ "description": "",
+ "operationId": "createVfModuleInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnfInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/replace": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Create VfModule on a specified version, serviceInstance and vnfInstance",
+ "description": "",
+ "operationId": "replaceVfModuleInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnfInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vfmoduleInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}": {
+ "put": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Update VfModule on a specified version, serviceInstance, vnfInstance and vfModule",
+ "description": "",
+ "operationId": "updateVfModuleInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnfInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vfmoduleInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Delete provided VfModule instance",
+ "description": "",
+ "operationId": "deleteVfModuleInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnfInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vfmoduleInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Create VolumeGroup on a specified version, serviceInstance, vnfInstance",
+ "description": "",
+ "operationId": "createVolumeGroupInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnfInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}": {
+ "put": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Update VolumeGroup on a specified version, serviceInstance, vnfInstance and volumeGroup",
+ "description": "",
+ "operationId": "updateVolumeGroupInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnfInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "volumeGroupInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Delete provided VolumeGroup instance",
+ "description": "",
+ "operationId": "deleteVolumeGroupInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnfInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "volumeGroupInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks": {
+ "post": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Create NetworkInstance on a specified version and serviceInstance ",
+ "description": "",
+ "operationId": "createNetworkInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}": {
+ "put": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Update VolumeGroup on a specified version, serviceInstance, networkInstance",
+ "description": "",
+ "operationId": "updateNetworkInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "networkInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "onapsoinfraserviceInstantiation"
+ ],
+ "summary": "Delete provided Network instance",
+ "description": "",
+ "operationId": "deleteNetworkInstance",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][5-7]"
+ },
+ {
+ "name": "serviceInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "networkInstanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/tasks/{version}": {
+ "get": {
+ "tags": [
+ "onapsoinfratasks"
+ ],
+ "summary": "Finds Manual Tasks",
+ "description": "",
+ "operationId": "queryFilters",
+ "parameters": [
+ {
+ "name": "taskId",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "originalRequestId",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "subscriptionServiceType",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "nfRole",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "buildingBlockName",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "originalRequestDate",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "originalRequestorId",
+ "in": "query",
+ "required": false,
+ "type": "string"
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV]1"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/cloudResources/{version}/operationalEnvironments": {
+ "post": {
+ "tags": [
+ "onapsoinfracloudResources"
+ ],
+ "summary": "Create an Operational Environment",
+ "description": "",
+ "operationId": "createOperationEnvironment",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][1]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/activate": {
+ "post": {
+ "tags": [
+ "onapsoinfracloudResources"
+ ],
+ "summary": "Activate an Operational Environment",
+ "description": "",
+ "operationId": "activateOperationEnvironment",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][1]"
+ },
+ {
+ "name": "operationalEnvironmentId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/deactivate": {
+ "post": {
+ "tags": [
+ "onapsoinfracloudResources"
+ ],
+ "summary": "Deactivate an Operational Environment",
+ "description": "",
+ "operationId": "deactivateOperationEnvironment",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][1]"
+ },
+ {
+ "name": "operationalEnvironmentId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/cloudResourcesRequests/{version}/{requestId}/unlock": {
+ "post": {
+ "tags": [
+ "onapsoinfracloudResourcesRequests"
+ ],
+ "summary": "Unlock CloudOrchestration requests for a specified requestId",
+ "description": "",
+ "operationId": "unlockOrchestrationRequestForReqId",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "requestId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][1]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/cloudResourcesRequests/{version}": {
+ "get": {
+ "tags": [
+ "onapsoinfracloudResourcesRequests"
+ ],
+ "summary": "Get status of an Operational Environment based on filter criteria",
+ "description": "",
+ "operationId": "getOperationEnvironmentStatusFilter",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][1]"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ },
+ "/onap/so/infra/modelDistributions/{version}/distributions/{distributionId}": {
+ "post": {
+ "tags": [
+ "onapsoinframodelDistributions"
+ ],
+ "summary": "Update model distribution status",
+ "description": "",
+ "operationId": "updateModelDistributionStatus",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "in": "body",
+ "name": "body",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "version",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "pattern": "[vV][1]"
+ },
+ {
+ "name": "distributionId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ }
+ }
+ }
+ }
+ }
+} \ No newline at end of file
diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst
index 7965e1d50f..6ca11cd6b3 100644
--- a/docs/architecture/architecture.rst
+++ b/docs/architecture/architecture.rst
@@ -89,10 +89,10 @@ SO Sub-Components
**SO Monitoring**
Monitor BPMN Workflow execution by providing
- * Service list search based on search criteria
- * Service statistic
- * Service Process Instance Rendering and Detail
-
+ * Service list search based on search criteria
+ * Service statistic
+ * Service Process Instance Rendering and Detail
+
Third Party and Open Source
---------------------------
diff --git a/docs/developer_info/developer_information.rst b/docs/developer_info/developer_information.rst
index 8613f2605c..61be8f006f 100644
--- a/docs/developer_info/developer_information.rst
+++ b/docs/developer_info/developer_information.rst
@@ -8,13 +8,13 @@ SO Developer Information
.. toctree::
:maxdepth: 1
-.. developer_info/developer_info_Project_Structure.rst
- developer_info/Camunda_Modeler.rst
-.. developer_info/developer_info_Main_Process_Flows.rst
-.. developer_info/developer_info_Subprocess_Process_Flows.rst
-.. developer_info/developer_info_Project_Deployment_Strategy.rst
- developer_info/Building_SO.rst
- developer_info/Working_with_SO_Docker.rst
- developer_info/Camunda_Cockpit_Community_Edition.rst
- developer_info/Camunda_Cockpit_Enterprise_Edition.rst
+.. 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
diff --git a/docs/release_notes/release-notes.rst b/docs/release_notes/release-notes.rst
index d3448497cf..f9c7002e8a 100644
--- a/docs/release_notes/release-notes.rst
+++ b/docs/release_notes/release-notes.rst
@@ -19,7 +19,7 @@ Temp release for Casablanca at M4.
* Support PNF resource type.
* Extend the support of homing to vFW, VDNS usecases.
* Workflow Designer Integration.
-* Monitoring BPMN worflow capabiliities through UI.
+* Monitoring BPMN worflow capabilities through UI.
* Support to the CCVPN Usecase.
* SO internal architecture improvements
@@ -35,7 +35,7 @@ The Beijing release is the second release of the Service Orchestrator (SO) proje
* Enhance Platform maturity by improving SO maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Beijing+Release+Platform+Maturity>`_.
* Manual scaling of network services and VNFs.
-* Homing and placement capabiliities through OOF interaction.
+* Homing and placement capabilities through OOF interaction.
* Ability to perform change management.
* Integrated to APPC
* Integrated to OOF
@@ -102,7 +102,7 @@ It executes end-to-end service activities by processing workflows and business l
The orchestration engine is a reusable service. Any component of the architecture can execute SO orchestration capabilities.
* Orchestration services will process workflows based on defined models and recipe.
-* The service model maintains consistency and reusability across all orchestration activities and ensures consistent methods, structure and version of the workflow execution environment.
+* The service model maintains consistency and re-usability across all orchestration activities and ensures consistent methods, structure and version of the workflow execution environment.
* Orchestration processes interact with other platform components or external systems via standard and well-defined APIs.