Fix spec error on infra_workload API

[multicloud/framework.git] / docs / specs / multicloud_infra_workload.rst

diff --git a/docs/specs/multicloud_infra_workload.rst b/docs/specs/multicloud_infra_workload.rst
index 57b3f7c..69fa4e8 100644 (file)
--- a/docs/specs/multicloud_infra_workload.rst
+++ b/docs/specs/multicloud_infra_workload.rst
@@ -132,30 +132,7 @@ Heat examples
         "flavor":"m1.heat"
      },
      "stack_name":"teststack",
-     "template":{
-        "heat_template_version":"2013-05-23",
-        "description":"Simple template to test heat commands",
-        "parameters":
-        {
-           "flavor":{
-              "default":"m1.tiny",
-              "type":"string"
-           }
-        },
-        "resources":{
-           "hello_world":{
-              "type":"OS::Nova::Server",
-              "properties":{
-                 "key_name":"heat_key",
-                 "flavor":{
-                    "get_param":"flavor"
-                 },
-                 "image":"40be8d1a-3eb9-40de-8abd-43237517384f",
-                 "user_data":"#!/bin/bash -xv\necho \"hello world\" > /root/hello-world.txt\n"
-              }
-           }
-        }
-     },
+     "template": "\nheat_template_version: 2013-05-23\ndescription: Simple template to test heat commands\nparameters:\n  flavor: {default: m1.tiny, type: string}\nresources:\n  hello_world:\n    type: OS::Nova::Server\n    properties:\n      key_name: heat_key\n      flavor: {get_param: flavor}\n      image: 40be8d1a-3eb9-40de-8abd-43237517384f\n      user_data: |\n        #!/bin/bash -xv\n        echo \"hello world\" > /root/hello-world.txt",
      "timeout_mins":60
   }
 
@@ -206,6 +183,51 @@ Response Body
         }
     }
 
+Update infrastructure workload information in AAI (i.e. Heatbridge)
+-------------------------------------------------------------------
+
+API URL: POST http://{msb IP}:{msb port}/api/multicloud/v1/{cloud-owner}/{cloud-region-id}/infra_workload/{workload-id}
+
+Request Body:
+>>>>>>>>>>>>>
+::
+
+  {
+     "generic-vnf-id":"<generic-vnf-id>",
+     "vf-module-id":"<vf-module-id>"
+  }
+
+Response:
+>>>>>>>>>
+
+Response Codes
+::::::::::::::
+Success
+.......
+
++--------------------+----------------------------------------------------------------------+
+| Code               | Reason                                                               |
++====================+======================================================================+
+| 202 - Accepted     | The request was accepted.                                            |
++--------------------+----------------------------------------------------------------------+
+
+Error
+.....
+
++--------------------+----------------------------------------------------------------------+
+| Code               | Reason                                                               |
++====================+======================================================================+
+| 400 - Bad Request  | Some content in the request was invalid.                             |
++--------------------+----------------------------------------------------------------------+
+| 401 - Unauthorized | User must authenticate before making a request.                      |
++--------------------+----------------------------------------------------------------------+
+| 409 - Conflict     | This operation conflicted with another operation on this resource.   |
++--------------------+----------------------------------------------------------------------+
+
+Response Body
+:::::::::::::
+
+
 Delete infrastructure workload
 ------------------------------
 
@@ -289,7 +311,7 @@ Response Body
     {
         "template_type":"<heat/tosca/etc.>",
         "workload_id": "<The ID of infrastructure workload resource>",
-        "workload_status":"CREATE_IN_PROCESS/CREATE_COMPLETE/DELETE_IN_PROCESS/etc"
+        "workload_status":"CREATE_IN_PROCESS/CREATE_COMPLETE/DELETE_IN_PROCESS/AAI_IN_PROGRESS/AAI_COMPLETE/etc"
     }
 
 Work Items