From 553bc77d8530b355953db6dc9aedd9f6223dc7c3 Mon Sep 17 00:00:00 2001 From: rameshiyer27 Date: Tue, 25 Aug 2020 16:49:34 +0100 Subject: Updating swagger.html for software upgrade with schema Issue-ID: SO-3120 Signed-off-by: zrrmmua Change-Id: Id0ff5f91b15644bcc0c2f8c2fde770b3cdf36520 --- docs/api/swagger/swagger.html | 895 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 885 insertions(+), 10 deletions(-) (limited to 'docs') diff --git a/docs/api/swagger/swagger.html b/docs/api/swagger/swagger.html index 5d7c963a8a..514c2bdda2 100644 --- a/docs/api/swagger/swagger.html +++ b/docs/api/swagger/swagger.html @@ -842,11 +842,191 @@ margin-bottom: 20px; } }, "description" : "This describes the subnet capabilities that can be queried" +}; + defs["RetrievingWorkflowResponse"] = { + "type" : "object", + "properties" : { + "workflowSpecificationList" : { + "type" : "array", + "description" : "List of Workflow specification data", + "items" : { + "$ref" : "#/definitions/WorkflowSpecification" + } + } + }, + "description" : "Response body of fetching workflows using resource target" +}; + defs["ServiceLevelWorkflowExecution"] = { + "type" : "object", + "properties" : { + "requestInfo" : { + "$ref" : "#/definitions/ServiceLevelWorkflowExecution_requestInfo" + }, + "modelInfo" : { + "$ref" : "#/definitions/ServiceLevelWorkflowExecution_modelInfo" + }, + "requestParameters" : { + "$ref" : "#/definitions/ServiceLevelWorkflowExecution_requestParameters" + }, + "subscriberInfo" : { + "$ref" : "#/definitions/ServiceLevelWorkflowExecution_subscriberInfo" + }, + "project" : { + "$ref" : "#/definitions/ServiceLevelWorkflowExecution_project" + }, + "owningEntity" : { + "$ref" : "#/definitions/ServiceLevelWorkflowExecution_owningEntity" + } + }, + "description" : "This describes the request body of service level custom workflow execution" +}; + defs["ServiceLevelWorkflowExecution_modelInfo"] = { + "type" : "object", + "properties" : { + "modelType" : { + "type" : "string", + "description" : "Type of the model to be executed" + }, + "modelInvariantUuid" : { + "type" : "string", + "description" : "Model invariant id corresponding to the service" + }, + "modelUuid" : { + "type" : "string", + "description" : "Model uuid corresponding to the service" + }, + "modelVersionId" : { + "type" : "string", + "description" : "Model version of the service instance" + }, + "modelName" : { + "type" : "string", + "description" : "Name of the service" + }, + "modelVersion" : { + "type" : "string", + "description" : "Version of the service instance" + } + }, + "description" : "Parameters related to the service model" +}; + defs["ServiceLevelWorkflowExecution_owningEntity"] = { + "type" : "object", + "properties" : { + "owningEntityId" : { + "type" : "string", + "description" : "Id of the owning Entity" + }, + "owningEntityName" : { + "type" : "string", + "description" : "Name of the owning Entity" + } + }, + "description" : "Object describes the entity details" +}; + defs["ServiceLevelWorkflowExecution_project"] = { + "type" : "object", + "properties" : { + "projectName" : { + "type" : "string", + "description" : "Name of the target project" + } + }, + "description" : "Information about the target project name" +}; + defs["ServiceLevelWorkflowExecution_requestInfo"] = { + "type" : "object", + "properties" : { + "source" : { + "type" : "string", + "description" : "Name of the sender" + }, + "suppressRollback" : { + "type" : "boolean", + "description" : "Enable/disable rollback suppression" + }, + "requestorId" : { + "type" : "string", + "description" : "Id of the sender" + } + }, + "description" : "Request object contains source information" +}; + defs["ServiceLevelWorkflowExecution_requestParameters"] = { + "type" : "object", + "properties" : { + "subscriptionServiceType" : { + "type" : "string", + "description" : "Type of service subscription" + } + }, + "description" : "User parameter object" +}; + defs["ServiceLevelWorkflowExecution_subscriberInfo"] = { + "type" : "object", + "properties" : { + "globalSubscriberId" : { + "type" : "string", + "description" : "Id of the subscriber sending the request" + } + }, + "description" : "Subscriber id information" }; defs["SubnetTypes"] = { "type" : "string", "description" : "This describes allowed subnet types", "enum" : [ "AN", "AN_NF", "CN", "TN_FH", "TN_MH", "TN_BH" ] +}; + defs["WorkflowSpecification"] = { + "type" : "object", + "properties" : { + "artifactInfo" : { + "$ref" : "#/definitions/WorkflowSpecification_artifactInfo" + } + }, + "description" : "This describes workflow specification object" +}; + defs["WorkflowSpecification_artifactInfo"] = { + "type" : "object", + "properties" : { + "artifactType" : { + "type" : "string", + "description" : "Type of the artifact to be queried" + }, + "artifactUuid" : { + "type" : "string", + "description" : "UUID of the artifact" + }, + "artifactName" : { + "type" : "string", + "description" : "Name of the artifact" + }, + "artifactVersion" : { + "type" : "string", + "description" : "Artifact's Version" + }, + "artifactDescription" : { + "type" : "string", + "description" : "" + }, + "workflowName" : { + "type" : "string", + "description" : "Name of the workflow fetched for the resource type" + }, + "operationName" : { + "type" : "string", + "description" : "Mapped operation name of the corresponding workflow" + }, + "workflowSource" : { + "type" : "string", + "description" : "" + }, + "workflowResourceTarget" : { + "type" : "string", + "description" : "Type of Resource mapped against the workflow" + } + }, + "description" : "Attributes related to artifact information " }; @@ -930,6 +1110,10 @@ margin-bottom: 20px;
  • unlockOrchestrationRequestForReqId
    • +
  • API Methods - OnapsoinfrainstanceManagement
    • +
  • + executeServiceLevelCustomWorkflow +
  • API Methods - OnapsoinframodelDistributions
  • updateModelDistributionStatus @@ -1067,6 +1251,10 @@ margin-bottom: 20px;
  • queryFilters
    • +
  • API Methods - OnapsoinfraworkflowSpecifications
    • +
  • + queryWorkflowSpecifications +
    • @@ -1449,7 +1637,7 @@ $(document).ready(function() {

    compareModelwithTargetVersion

    -

    Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId

    +

    Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId

    @@ -1536,7 +1724,7 @@ String *body = body_example; // (optional) E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init]; -// Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId +// Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId [apiInstance compareModelwithTargetVersionWith:serviceId version:version body:body @@ -1596,7 +1784,7 @@ namespace Example try { - // Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId + // Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId apiInstance.compareModelwithTargetVersion(serviceId, version, body); } catch (Exception e) @@ -1658,7 +1846,7 @@ version = version_example # String | body = body_example # String | (optional) try: - # Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId + # Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId api_instance.compare_modelwith_target_version(serviceId, version, body=body) except ApiException as e: print("Exception when calling E2eServiceInstancesApi->compareModelwithTargetVersion: %s\n" % e) @@ -7289,7 +7477,367 @@ except ApiException as e: -
    +
    +
    +
    + + String + + +
    +
    + Required +
    +
    +
    + + + + version* + + + +
    +
    +
    + + String + + +
    +
    + Required +
    +
    +
    + + + + + + +
    Body parameters
    + + + + + + + + + +
    NameDescription
    body + + + +
    +
    + + + +

    Responses

    +

    Status: default - successful operation

    + +
      +
    + +
    +
    + +
    + +
    + +
    +

    OnapsoinfrainstanceManagement

    +
    +
    +
    +

    executeServiceLevelCustomWorkflow

    +

    Executing service level custom workflow

    +
    +
    +
    +

    +

    +

    +
    + 
    /onap/so/infra/instanceManagement/{version}/serviceInstances/{serviceInstanceId}/workflows/{workflow_UUID}
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    + 
    curl -X POST "http://localhost/onap/so/infra/instanceManagement/{version}/serviceInstances/{serviceInstanceId}/workflows/{workflow_UUID}"
    +
    +
    + 
    import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.OnapsoinfrainstanceManagementApi;
+
+import java.io.File;
+import java.util.*;
+
+public class OnapsoinfrainstanceManagementApiExample {
+
+    public static void main(String[] args) {
+        
+        OnapsoinfrainstanceManagementApi apiInstance = new OnapsoinfrainstanceManagementApi();
+        String version = version_example; // String | 
+        String serviceInstanceId = serviceInstanceId_example; // String | 
+        String workflowUUID = workflowUUID_example; // String | 
+        ServiceLevelWorkflowExecution body = ; // ServiceLevelWorkflowExecution | 
+        try {
+            apiInstance.executeServiceLevelCustomWorkflow(version, serviceInstanceId, workflowUUID, body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OnapsoinfrainstanceManagementApi#executeServiceLevelCustomWorkflow");
+            e.printStackTrace();
+        }
+    }
+}
    +
    + +
    + 
    import io.swagger.client.api.OnapsoinfrainstanceManagementApi;
+
+public class OnapsoinfrainstanceManagementApiExample {
+
+    public static void main(String[] args) {
+        OnapsoinfrainstanceManagementApi apiInstance = new OnapsoinfrainstanceManagementApi();
+        String version = version_example; // String | 
+        String serviceInstanceId = serviceInstanceId_example; // String | 
+        String workflowUUID = workflowUUID_example; // String | 
+        ServiceLevelWorkflowExecution body = ; // ServiceLevelWorkflowExecution | 
+        try {
+            apiInstance.executeServiceLevelCustomWorkflow(version, serviceInstanceId, workflowUUID, body);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OnapsoinfrainstanceManagementApi#executeServiceLevelCustomWorkflow");
+            e.printStackTrace();
+        }
+    }
+}
    +
    + +
    + 
    String *version = version_example; // 
+String *serviceInstanceId = serviceInstanceId_example; // 
+String *workflowUUID = workflowUUID_example; // 
+ServiceLevelWorkflowExecution *body = ; //  (optional)
+
+OnapsoinfrainstanceManagementApi *apiInstance = [[OnapsoinfrainstanceManagementApi alloc] init];
+
+// Executing service level custom workflow
+[apiInstance executeServiceLevelCustomWorkflowWith:version
+    serviceInstanceId:serviceInstanceId
+    workflowUUID:workflowUUID
+    body:body
+              completionHandler: ^(NSError* error) {
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
    +
    + +
    + 
    var SoGuilinApIs = require('so_guilin_ap_is');
+
+var api = new SoGuilinApIs.OnapsoinfrainstanceManagementApi()
+
+var version = version_example; // {String} 
+
+var serviceInstanceId = serviceInstanceId_example; // {String} 
+
+var workflowUUID = workflowUUID_example; // {String} 
+
+var opts = { 
+  'body':  // {ServiceLevelWorkflowExecution} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+};
+api.executeServiceLevelCustomWorkflow(version, serviceInstanceId, workflowUUID, opts, callback);
+
    +
    + + +
    + 
    using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class executeServiceLevelCustomWorkflowExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new OnapsoinfrainstanceManagementApi();
+            var version = version_example;  // String | 
+            var serviceInstanceId = serviceInstanceId_example;  // String | 
+            var workflowUUID = workflowUUID_example;  // String | 
+            var body = new ServiceLevelWorkflowExecution(); // ServiceLevelWorkflowExecution |  (optional) 
+
+            try
+            {
+                // Executing service level custom workflow
+                apiInstance.executeServiceLevelCustomWorkflow(version, serviceInstanceId, workflowUUID, body);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling OnapsoinfrainstanceManagementApi.executeServiceLevelCustomWorkflow: " + e.Message );
+            }
+        }
+    }
+}
+
    +
    + +
    + 
    <?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\Api\OnapsoinfrainstanceManagementApi();
+$version = version_example; // String | 
+$serviceInstanceId = serviceInstanceId_example; // String | 
+$workflowUUID = workflowUUID_example; // String | 
+$body = ; // ServiceLevelWorkflowExecution | 
+
+try {
+    $api_instance->executeServiceLevelCustomWorkflow($version, $serviceInstanceId, $workflowUUID, $body);
+} catch (Exception $e) {
+    echo 'Exception when calling OnapsoinfrainstanceManagementApi->executeServiceLevelCustomWorkflow: ', $e->getMessage(), PHP_EOL;
+}
+?>
    +
    + +
    + 
    use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::OnapsoinfrainstanceManagementApi;
+
+my $api_instance = WWW::SwaggerClient::OnapsoinfrainstanceManagementApi->new();
+my $version = version_example; # String | 
+my $serviceInstanceId = serviceInstanceId_example; # String | 
+my $workflowUUID = workflowUUID_example; # String | 
+my $body = WWW::SwaggerClient::Object::ServiceLevelWorkflowExecution->new(); # ServiceLevelWorkflowExecution | 
+
+eval { 
+    $api_instance->executeServiceLevelCustomWorkflow(version => $version, serviceInstanceId => $serviceInstanceId, workflowUUID => $workflowUUID, body => $body);
+};
+if ($@) {
+    warn "Exception when calling OnapsoinfrainstanceManagementApi->executeServiceLevelCustomWorkflow: $@\n";
+}
    +
    + +
    + 
    from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.OnapsoinfrainstanceManagementApi()
+version = version_example # String | 
+serviceInstanceId = serviceInstanceId_example # String | 
+workflowUUID = workflowUUID_example # String | 
+body =  # ServiceLevelWorkflowExecution |  (optional)
+
+try: 
+    # Executing service level custom workflow
+    api_instance.execute_service_level_custom_workflow(version, serviceInstanceId, workflowUUID, body=body)
+except ApiException as e:
+    print("Exception when calling OnapsoinfrainstanceManagementApi->executeServiceLevelCustomWorkflow: %s\n" % e)
    +
    +
    + +

    Parameters

    + +
    Path parameters
    + + + + + + + + + + + - + @@ -22297,6 +22845,333 @@ except ApiException as e:
    +
    +

    OnapsoinfraworkflowSpecifications

    +
    +
    +
    +

    queryWorkflowSpecifications

    +

    Retrieve Workflow details based on the filter criteria

    +
    +
    +
    +

    +

    +

    +
    + 
    /onap/so/infra/workflowSpecifications/{version}/workflows
    +

    +

    Usage and SDK Samples

    +

    + + +
    +
    + 
    curl -X GET "http://localhost/onap/so/infra/workflowSpecifications/{version}/workflows?resourceTarget="
    +
    +
    + 
    import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.OnapsoinfraworkflowSpecificationsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class OnapsoinfraworkflowSpecificationsApiExample {
+
+    public static void main(String[] args) {
+        
+        OnapsoinfraworkflowSpecificationsApi apiInstance = new OnapsoinfraworkflowSpecificationsApi();
+        String version = version_example; // String | 
+        String resourceTarget = resourceTarget_example; // String | 
+        try {
+            RetrievingWorkflowResponse result = apiInstance.queryWorkflowSpecifications(version, resourceTarget);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OnapsoinfraworkflowSpecificationsApi#queryWorkflowSpecifications");
+            e.printStackTrace();
+        }
+    }
+}
    +
    + +
    + 
    import io.swagger.client.api.OnapsoinfraworkflowSpecificationsApi;
+
+public class OnapsoinfraworkflowSpecificationsApiExample {
+
+    public static void main(String[] args) {
+        OnapsoinfraworkflowSpecificationsApi apiInstance = new OnapsoinfraworkflowSpecificationsApi();
+        String version = version_example; // String | 
+        String resourceTarget = resourceTarget_example; // String | 
+        try {
+            RetrievingWorkflowResponse result = apiInstance.queryWorkflowSpecifications(version, resourceTarget);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling OnapsoinfraworkflowSpecificationsApi#queryWorkflowSpecifications");
+            e.printStackTrace();
+        }
+    }
+}
    +
    + +
    + 
    String *version = version_example; // 
+String *resourceTarget = resourceTarget_example; //  (optional)
+
+OnapsoinfraworkflowSpecificationsApi *apiInstance = [[OnapsoinfraworkflowSpecificationsApi alloc] init];
+
+// Retrieve Workflow details based on the filter criteria
+[apiInstance queryWorkflowSpecificationsWith:version
+    resourceTarget:resourceTarget
+              completionHandler: ^(RetrievingWorkflowResponse output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
    +
    + +
    + 
    var SoGuilinApIs = require('so_guilin_ap_is');
+
+var api = new SoGuilinApIs.OnapsoinfraworkflowSpecificationsApi()
+
+var version = version_example; // {String} 
+
+var opts = { 
+  'resourceTarget': resourceTarget_example // {String} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.queryWorkflowSpecifications(version, opts, callback);
+
    +
    + + +
    + 
    using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class queryWorkflowSpecificationsExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new OnapsoinfraworkflowSpecificationsApi();
+            var version = version_example;  // String | 
+            var resourceTarget = resourceTarget_example;  // String |  (optional) 
+
+            try
+            {
+                // Retrieve Workflow details based on the filter criteria
+                RetrievingWorkflowResponse result = apiInstance.queryWorkflowSpecifications(version, resourceTarget);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling OnapsoinfraworkflowSpecificationsApi.queryWorkflowSpecifications: " + e.Message );
+            }
+        }
+    }
+}
+
    +
    + +
    + 
    <?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\Api\OnapsoinfraworkflowSpecificationsApi();
+$version = version_example; // String | 
+$resourceTarget = resourceTarget_example; // String | 
+
+try {
+    $result = $api_instance->queryWorkflowSpecifications($version, $resourceTarget);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling OnapsoinfraworkflowSpecificationsApi->queryWorkflowSpecifications: ', $e->getMessage(), PHP_EOL;
+}
+?>
    +
    + +
    + 
    use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::OnapsoinfraworkflowSpecificationsApi;
+
+my $api_instance = WWW::SwaggerClient::OnapsoinfraworkflowSpecificationsApi->new();
+my $version = version_example; # String | 
+my $resourceTarget = resourceTarget_example; # String | 
+
+eval { 
+    my $result = $api_instance->queryWorkflowSpecifications(version => $version, resourceTarget => $resourceTarget);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling OnapsoinfraworkflowSpecificationsApi->queryWorkflowSpecifications: $@\n";
+}
    +
    + +
    + 
    from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.OnapsoinfraworkflowSpecificationsApi()
+version = version_example # String | 
+resourceTarget = resourceTarget_example # String |  (optional)
+
+try: 
+    # Retrieve Workflow details based on the filter criteria
+    api_response = api_instance.query_workflow_specifications(version, resourceTarget=resourceTarget)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling OnapsoinfraworkflowSpecificationsApi->queryWorkflowSpecifications: %s\n" % e)
    +
    +
    + +

    Parameters

    + +
    Path parameters
    +
    NameDescription
    version* + + +
    +
    +
    + + String + + +
    +
    + Required +
    +
    +
    +
    serviceInstanceId* + + +
    @@ -7305,11 +7853,11 @@ except ApiException as e:
    version*
    workflow_UUID* -
    +
    @@ -7345,7 +7893,7 @@ $(document).ready(function() { "name" : "body", "required" : false, "schema" : { - "type" : "string" + "$ref" : "#/definitions/ServiceLevelWorkflowExecution" } }; var schema = schemaWrapper.schema; @@ -7359,12 +7907,12 @@ $(document).ready(function() { } var view = new JSONSchemaView(schema,2,{isBodyParam: true}); - var result = $('#d2e199_unlockOrchestrationRequestForReqId_body'); + var result = $('#d2e199_executeServiceLevelCustomWorkflow_body'); result.empty(); result.append(view.render()); }); -
    +
    + + + + + + + + +
    NameDescription
    version* + + +
    +
    +
    + + String + + +
    +
    + Required +
    +
    +
    +
    + + + + +
    Query parameters
    + + + + + + + + + +
    NameDescription
    resourceTarget + + +
    +
    +
    + + String + + +
    +
    +
    +
    + +

    Responses

    +

    Status: default - List of workflow specifications on successful operation

    + + + +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    +