From dd7569eb70f1eecbc3fcdc1c75363c24df64ecf1 Mon Sep 17 00:00:00 2001
From: Shuwen Cai <caishuwen@fujitsu.com>
Date: Fri, 9 Sep 2022 14:54:58 +0900
Subject: [PATCH] Add docs for performance improvement

This patch makes the following updates to the api-ref doc.

* Add `metadata` information into vnf_instance.instantiatedVnfInfo

Implement: blueprint system-performance-management
Change-Id: I022367f9268315d4e3d8ffe4f590ac809dcedf07
---
 api-ref/source/v2/parameters_vnflcm.yaml                  | 8 ++++++++
 .../v2/samples/vnflcm/list-vnf-instance-response.json     | 5 ++++-
 .../v2/samples/vnflcm/show-vnf-instance-response.json     | 5 ++++-
 api-ref/source/v2/vnflcm.inc                              | 2 ++
 4 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/api-ref/source/v2/parameters_vnflcm.yaml b/api-ref/source/v2/parameters_vnflcm.yaml
index c4f52179b..89032e0d8 100644
--- a/api-ref/source/v2/parameters_vnflcm.yaml
+++ b/api-ref/source/v2/parameters_vnflcm.yaml
@@ -799,6 +799,14 @@ instantiated_vnf_info:
   in: body
   required: false
   type: object
+instantiated_vnf_info_metadata:
+  description: |
+    This attribute is not a standard attribute defined by ETSI. Information
+    about the VNF after successful instantiation is stored in this attribute.
+    Used in other lifecycle operations.
+  in: body
+  required: false
+  type: key value pairs
 instantiation_level_id:
   description: |
     Identifier of the instantiation level of the deployment flavour to be
diff --git a/api-ref/source/v2/samples/vnflcm/list-vnf-instance-response.json b/api-ref/source/v2/samples/vnflcm/list-vnf-instance-response.json
index c3315feea..6d801ea76 100644
--- a/api-ref/source/v2/samples/vnflcm/list-vnf-instance-response.json
+++ b/api-ref/source/v2/samples/vnflcm/list-vnf-instance-response.json
@@ -462,7 +462,10 @@
                         }
                     ]
                 }
-            ]
+            ],
+            "metadata": {
+                "stack_id": "74350884-fcfd-43f3-a425-2eb007180bc4"
+            }
         },
         "instantiationState": "INSTANTIATED",
         "metadata": {},
diff --git a/api-ref/source/v2/samples/vnflcm/show-vnf-instance-response.json b/api-ref/source/v2/samples/vnflcm/show-vnf-instance-response.json
index e55445370..a14957644 100644
--- a/api-ref/source/v2/samples/vnflcm/show-vnf-instance-response.json
+++ b/api-ref/source/v2/samples/vnflcm/show-vnf-instance-response.json
@@ -461,7 +461,10 @@
                     }
                 ]
             }
-        ]
+        ],
+        "metadata": {
+            "stack_id": "74350884-fcfd-43f3-a425-2eb007180bc4"
+        }
     },
     "instantiationState": "INSTANTIATED",
     "metadata": {},
diff --git a/api-ref/source/v2/vnflcm.inc b/api-ref/source/v2/vnflcm.inc
index 0df877eae..0def01b04 100644
--- a/api-ref/source/v2/vnflcm.inc
+++ b/api-ref/source/v2/vnflcm.inc
@@ -435,6 +435,7 @@ Response Parameters
   - vimConnectionId: vim_connection_id
   - resourceId: resource_handle_resource_id
   - vimLevelResourceType: resource_handle_vim_level_resource_type
+  - metadata: instantiated_vnf_info_metadata
   - metadata: vnf_instance_metadata
   - vnfcInfo: vnfc_info
   - id: vnfc_info_id
@@ -599,6 +600,7 @@ Response Parameters
   - vimConnectionId: vim_connection_id
   - resourceId: resource_handle_resource_id
   - vimLevelResourceType: resource_handle_vim_level_resource_type
+  - metadata: instantiated_vnf_info_metadata
   - metadata: vnf_instance_metadata
   - vnfcInfo: vnfc_info
   - id: vnfc_info_id