Merge "Improve VNF packages API documentation"

api-ref/source/v1/parameters.yaml

@@ -1,26 +1,4 @@
 # variables in header
-content_type:
-  description: |
-    If the VNFD is implemented in the form of multiple files, zip file will
-    be returned with Content-Type set as `application/zip` otherwise it will
-    be set to `text/plain` in the response header.
-  in: header
-  required: true
-  type: string
-fetch_content_type:
-  description: |
-    The fetched VNF Package will be returned with Content-Type set
-    as `application/zip` in the response header.
-  in: header
-  required: true
-  type: string
-range:
-  description: |
-    The byte range of VNF Package to be downloaded is specified in the Range
-    header.
-  in: header
-  required: false
-  type: string
 
 # variables in path
 alias_path:
@@ -77,12 +55,6 @@ vnf_id_path:
   in: path
   required: true
   type: string
-vnf_package_id_path:
-  description: |
-    The UUID of the VNF Package.
-  in: path
-  required: true
-  type: string
 vnfd_id_path:
   description: |
     The UUID of the VNFD.
@@ -105,13 +77,6 @@ vnffgd_id_path:
 # variables in query
 
 # variables in body
-addressInformation:
-  description: |
-    Address information of the VNF package content. The NFVO can use this address
-    to obtain the VNF package.
-  in: body
-  required: true
-  type: string
 alias:
   description: |
     The alias for the extension. For example,
@@ -389,37 +354,6 @@ nss:
   in: body
   required: true
   type: array
-onboardingState:
-  description: |
-    On-boarding state of the VNF package.
-    The on-boarding state is represented by the "onboardingState" attribute in the "VnfPkgInfo"
-    information element with below values:
-    CREATED: The VNF Package information object is created.
-    UPLOADING: The VNF Package is being uploaded.
-    PROCESSING: The VNF Package is being processed, e.g. validation.
-    ONBOARDED: The VNF Package is successfully on-boarded.
-  in: body
-  required: true
-  type: string
-operationalState:
-  description: |
-    Operational state of the VNF package.
-    The operational state is represented by the "operationalState" attribute in the "VnfPkgInfo"
-    information element with below values:
-    ENABLED: The VNF Package is enabled.
-    DISABLED: The VNF Package is disabled.
-    If the value of the onboardingState attribute is not equal to "ONBOARDED", the value of
-    the operationalState attribute shall be equal to "DISABLED".
-  in: body
-  required: true
-  type: string
-password:
-  description: |
-    Password to be used for authentication. Shall be present if password is needed but
-    has not been provisioned out of band.
-  in: body
-  required: false
-  type: string
 service_types:
   description: |
     A list of service type.
@@ -483,15 +417,6 @@ sfcs:
   in: body
   required: true
   type: array
-software_images:
-  description: |
-    Information about VNF package artifacts that are software images.
-    This attribute shall not be present before the VNF package content is on-boarded.
-    Otherwise, this attribute shall be present unless it has been requested to be
-    excluded per attribute selector.
-  in: body
-  required: true
-  type: array
 symmetrical:
   description: |
     Indicate whether reverse traffic should also flow through the path.
@@ -520,19 +445,6 @@ tenant_id_opt:
   in: body
   required: false
   type: string
-update_operational_state:
-  description: |
-    New value of the operational state of the on-boarded instance of the VNF
-    package. Valid values are "ENABLED" and "DISABLED". See note.
-  in: body
-  required: false
-  type: string
-update_user_defined_data:
-  description: |
-    User defined data to be updated. For existing keys, the value is replaced.
-  in: body
-  required: false
-  type: object
 updated_at:
   description: |
     The date and time when the resource was updated.
@@ -541,50 +453,6 @@ updated_at:
   in: body
   required: true
   type: string
-updated_operational_state:
-  description: |
-    Updated value of the operational state of the on-boarded instance of
-    the VNF package.
-  in: body
-  required: false
-  type: string
-updated_user_defined_data:
-  description: |
-    Updated value of user defined data.
-  in: body
-  required: false
-  type: object
-usageState:
-  description: |
-    Usage state of the VNF package.
-    The usage state is represented by the "usageState" attribute in the "VnfPkgInfo" information
-    element with below values:
-    IN_USE: The VNF Package is in use.
-    NOT_IN_USE: The VNF Package is not in use.
-    If the value of the onboardingState attribute is not equal to "ONBOARDED", the value of
-    the usageState attribute shall be equal to "NOT_IN_USE".
-  in: body
-  required: true
-  type: string
-user_defined_data_opt:
-  description: |
-    User defined data for the VNF package.
-  in: body
-  required: false
-  type: object
-userDefinedData:
-  description: |
-    User defined data for the VNF package.
-  in: body
-  required: true
-  type: object
-userName:
-  description: |
-    User name to be used for authentication. Shall be present if user name is needed
-    but has not been provisioned out of band.
-  in: body
-  required: false
-  type: string
 version_href:
   description: |
     Link to the API.
@@ -846,12 +714,6 @@ vnf_monitoring_policy:
   in: body
   required: true
   type: string
-vnf_package_id:
-  description: |
-    Identifier of the VNF package. This identifier is allocated by the NFVO.
-  in: body
-  required: true
-  type: string
 vnf_param_values:
   description: |
     VNF parameter object. These parameters will be substituted for VNF
@@ -872,28 +734,6 @@ vnf_param_values_opt:
   in: body
   required: false
   type: object
-vnf_pkg_content:
-  description: |
-    A VNF Package is a tar-archive containing all the information required for managing
-    the lifecycle of a VNF.
-    The "Content-Type" HTTP header should be set to "application/zip".
-  in: body
-  required: true
-  type: object
-vnf_pkg_links:
-  description: |
-    Links to resources related to this resource.
-  in: body
-  required: true
-  type: object
-vnf_pkg_vnfd_id:
-  description: |
-    This identifier, which is managed by the VNF provider, identifies the VNF package and the VNFD
-    in a globally unique way. It is copied from the VNFD of the onboarded VNF package. It shall be
-    present after the VNF package content has been on-boarded and absent otherwise.
-  in: body
-  required: true
-  type: string
 vnf_placement_attr:
   description: |
     VNF placement information object. This object includes ``region_name``
@@ -907,21 +747,6 @@ vnf_placement_attr_opt:
   in: body
   required: false
   type: object
-vnf_product_name:
-  description: |
-    Name to identify the VNF product. Invariant for the VNF product lifetime.
-    This information is copied from the VNFD. It shall be present after the VNF
-    package content has been on-boarded and absent otherwise.
-  in: body
-  required: true
-  type: string
-vnf_provider:
-  description: |
-    Provider of the VNF package and the VNFD. This information is copied from the VNFD.
-    It shall be present after the VNF package content has been on-boarded and absent otherwise.
-  in: body
-  required: true
-  type: string
 vnf_resource_id:
   description: |
     The UUID of the VNF resource. This is equivalent to Heat stack resource ID.
@@ -966,15 +791,6 @@ vnf_scale_type:
   in: body
   required: true
   type: string
-vnf_software_version:
-  description: |
-    Software version of the VNF. This is changed when there is any change to the software
-    included in the VNF package.
-    This information is copied from the VNFD. It shall be present after the VNF package
-    content has been on-boarded and absent otherwise.
-  in: body
-  required: true
-  type: string
 vnf_status:
   description: |
     Status of the VNF.
@@ -1019,14 +835,6 @@ vnfd_template_source:
   in: body
   required: false
   type: string
-vnfd_version:
-  description: |
-    The version of the VNFD. This information is copied from the VNFD.
-    It shall be present after the VNF package content has been on-boarded
-    and absent otherwise.
-  in: body
-  required: true
-  type: string
 vnfds:
   description: |
     A list of ``vnfd`` objects.

api-ref/source/v1/parameters_vnf_packages.yaml

@@ -0,0 +1,199 @@
+# variables in header
+content_type:
+  description: |
+    If the VNFD is implemented in the form of multiple files, zip file will
+    be returned with Content-Type set as `application/zip` otherwise it will
+    be set to `text/plain` in the response header.
+  in: header
+  required: true
+  type: string
+fetch_content_type:
+  description: |
+    The fetched VNF Package will be returned with Content-Type set
+    as `application/zip` in the response header.
+  in: header
+  required: true
+  type: string
+range:
+  description: |
+    The byte range of VNF Package to be downloaded is specified in the Range
+    header.
+  in: header
+  required: false
+  type: string
+
+# variables in path
+vnf_package_id_path:
+  description: |
+    The UUID of the VNF Package.
+  in: path
+  required: true
+  type: string
+
+# variables in query
+
+# variables in body
+address_information:
+  description: |
+    Address information of the VNF package content. The NFVO can use this address
+    to obtain the VNF package.
+  in: body
+  required: true
+  type: string
+onboarding_state:
+  description: |
+    On-boarding state of the VNF package.
+    The on-boarding state is represented by the "onboardingState" attribute in the "VnfPkgInfo"
+    information element with below values:
+    CREATED: The VNF Package information object is created.
+    UPLOADING: The VNF Package is being uploaded.
+    PROCESSING: The VNF Package is being processed, e.g. validation.
+    ONBOARDED: The VNF Package is successfully on-boarded.
+  in: body
+  required: true
+  type: string
+operational_state:
+  description: |
+    Operational state of the VNF package.
+    The operational state is represented by the "operationalState" attribute in the "VnfPkgInfo"
+    information element with below values:
+    ENABLED: The VNF Package is enabled.
+    DISABLED: The VNF Package is disabled.
+    If the value of the onboardingState attribute is not equal to "ONBOARDED", the value of
+    the operationalState attribute shall be equal to "DISABLED".
+  in: body
+  required: true
+  type: string
+password:
+  description: |
+    Password to be used for authentication. Shall be present if password is needed but
+    has not been provisioned out of band.
+  in: body
+  required: false
+  type: string
+software_images:
+  description: |
+    Information about VNF package artifacts that are software images.
+    This attribute shall not be present before the VNF package content is on-boarded.
+    Otherwise, this attribute shall be present unless it has been requested to be
+    excluded per attribute selector.
+  in: body
+  required: true
+  type: array
+update_operational_state:
+  description: |
+    New value of the operational state of the on-boarded instance of the VNF
+    package. Valid values are "ENABLED" and "DISABLED". See note.
+  in: body
+  required: false
+  type: string
+update_user_defined_data:
+  description: |
+    User defined data to be updated. For existing keys, the value is replaced.
+  in: body
+  required: false
+  type: object
+updated_operational_state:
+  description: |
+    Updated value of the operational state of the on-boarded instance of
+    the VNF package.
+  in: body
+  required: false
+  type: string
+updated_user_defined_data:
+  description: |
+    Updated value of user defined data.
+  in: body
+  required: false
+  type: object
+usage_state:
+  description: |
+    Usage state of the VNF package.
+    The usage state is represented by the "usageState" attribute in the "VnfPkgInfo" information
+    element with below values:
+    IN_USE: The VNF Package is in use.
+    NOT_IN_USE: The VNF Package is not in use.
+    If the value of the onboardingState attribute is not equal to "ONBOARDED", the value of
+    the usageState attribute shall be equal to "NOT_IN_USE".
+  in: body
+  required: true
+  type: string
+user_defined_data:
+  description: |
+    User defined data for the VNF package.
+  in: body
+  required: true
+  type: object
+user_defined_data_opt:
+  description: |
+    User defined data for the VNF package.
+  in: body
+  required: false
+  type: object
+user_name:
+  description: |
+    User name to be used for authentication. Shall be present if user name is needed
+    but has not been provisioned out of band.
+  in: body
+  required: false
+  type: string
+vnf_package_id:
+  description: |
+    Identifier of the VNF package. This identifier is allocated by the NFVO.
+  in: body
+  required: true
+  type: string
+vnf_pkg_content:
+  description: |
+    A VNF Package is a tar-archive containing all the information required for managing
+    the lifecycle of a VNF.
+    The "Content-Type" HTTP header should be set to "application/zip".
+  in: body
+  required: true
+  type: object
+vnf_pkg_links:
+  description: |
+    Links to resources related to this resource.
+  in: body
+  required: true
+  type: object
+vnf_pkg_vnfd_id:
+  description: |
+    This identifier, which is managed by the VNF provider, identifies the VNF package and the VNFD
+    in a globally unique way. It is copied from the VNFD of the onboarded VNF package. It shall be
+    present after the VNF package content has been on-boarded and absent otherwise.
+  in: body
+  required: true
+  type: string
+vnf_product_name:
+  description: |
+    Name to identify the VNF product. Invariant for the VNF product lifetime.
+    This information is copied from the VNFD. It shall be present after the VNF
+    package content has been on-boarded and absent otherwise.
+  in: body
+  required: true
+  type: string
+vnf_provider:
+  description: |
+    Provider of the VNF package and the VNFD. This information is copied from the VNFD.
+    It shall be present after the VNF package content has been on-boarded and absent otherwise.
+  in: body
+  required: true
+  type: string
+vnf_software_version:
+  description: |
+    Software version of the VNF. This is changed when there is any change to the software
+    included in the VNF package.
+    This information is copied from the VNFD. It shall be present after the VNF package
+    content has been on-boarded and absent otherwise.
+  in: body
+  required: true
+  type: string
+vnfd_version:
+  description: |
+    The version of the VNFD. This information is copied from the VNFD.
+    It shall be present after the VNF package content has been on-boarded
+    and absent otherwise.
+  in: body
+  required: true
+  type: string

api-ref/source/v1/vnf_packages.inc

@@ -32,7 +32,7 @@ Response Codes
 Request Parameters
 ------------------
 
-.. rest_parameters:: parameters.yaml
+.. rest_parameters:: parameters_vnf_packages.yaml
 
   - userDefinedData: user_defined_data_opt
 
@@ -45,14 +45,14 @@ Request Example
 Response Parameters
 -------------------
 
-.. rest_parameters:: parameters.yaml
+.. rest_parameters:: parameters_vnf_packages.yaml
 
   - id: vnf_package_id
   - _links: vnf_pkg_links
-  - onboardingState: onboardingState
+  - onboardingState: onboarding_state
-  - operationalState: operationalState
+  - operationalState: operational_state
-  - usageState: usageState
+  - usageState: usage_state
-  - userDefinedData: userDefinedData
+  - userDefinedData: user_defined_data
 
 Response Example
 ----------------
@@ -82,7 +82,7 @@ Response Codes
 Response Parameters
 -------------------
 
-.. rest_parameters:: parameters.yaml
+.. rest_parameters:: parameters_vnf_packages.yaml
 
   - id: vnf_package_id
   - vnfdId: vnf_pkg_vnfd_id
@@ -91,10 +91,10 @@ Response Parameters
   - vnfSoftwareVersion: vnf_software_version
   - vnfdVersion: vnfd_version
   - softwareImages: software_images
-  - onboardingState: onboardingState
+  - onboardingState: onboarding_state
-  - operationalState: operationalState
+  - operationalState: operational_state
-  - usageState: usageState
+  - usageState: usage_state
-  - userDefinedData: userDefinedData
+  - userDefinedData: user_defined_data
   - _links: vnf_pkg_links
 
 Response Example
@@ -126,14 +126,14 @@ Response Codes
 Request Parameters
 ------------------
 
-.. rest_parameters:: parameters.yaml
+.. rest_parameters:: parameters_vnf_packages.yaml
 
   - vnf_package_id: vnf_package_id_path
 
 Response Parameters
 -------------------
 
-.. rest_parameters:: parameters.yaml
+.. rest_parameters:: parameters_vnf_packages.yaml
 
   - id: vnf_package_id
   - vnfdId: vnf_pkg_vnfd_id
@@ -142,10 +142,10 @@ Response Parameters
   - vnfSoftwareVersion: vnf_software_version
   - vnfdVersion: vnfd_version
   - softwareImages: software_images
-  - onboardingState: onboardingState
+  - onboardingState: onboarding_state
-  - operationalState: operationalState
+  - operationalState: operational_state
-  - usageState: usageState
+  - usageState: usage_state
-  - userDefinedData: userDefinedData
+  - userDefinedData: user_defined_data
   - _links: vnf_pkg_links
 
 Response Example
@@ -183,7 +183,7 @@ Response Codes
 Request Parameters
 ------------------
 
-.. rest_parameters:: parameters.yaml
+.. rest_parameters:: parameters_vnf_packages.yaml
 
   - vnf_package_id: vnf_package_id_path
 
@@ -215,7 +215,7 @@ Response Codes
 Request Parameters
 ------------------
 
-.. rest_parameters:: parameters.yaml
+.. rest_parameters:: parameters_vnf_packages.yaml
 
   - vnf_package_id: vnf_package_id_path
   - vnf_package_content: vnf_pkg_content
@@ -249,11 +249,11 @@ Response Codes
 Request Parameters
 ------------------
 
-.. rest_parameters:: parameters.yaml
+.. rest_parameters:: parameters_vnf_packages.yaml
 
   - vnf_package_id: vnf_package_id_path
-  - addressInformation: addressInformation
+  - addressInformation: address_information
-  - userName: userName
+  - userName: user_name
   - password: password
 
 Update VNF Package Information
@@ -281,7 +281,7 @@ Response Codes
 Request Parameters
 ------------------
 
-.. rest_parameters:: parameters.yaml
+.. rest_parameters:: parameters_vnf_packages.yaml
 
   - vnf_package_id: vnf_package_id_path
   - operationalState: update_operational_state
@@ -303,7 +303,7 @@ Request Example
 Response Parameters
 -------------------
 
-.. rest_parameters:: parameters.yaml
+.. rest_parameters:: parameters_vnf_packages.yaml
 
   - operationalState: updated_operational_state
   - userDefinedData: updated_user_defined_data
@@ -358,7 +358,7 @@ Response Codes
 Request Parameters
 ------------------
 
-.. rest_parameters:: parameters.yaml
+.. rest_parameters:: parameters_vnf_packages.yaml
 
   - vnf_package_id: vnf_package_id_path
   - Accept: content_type
@@ -366,7 +366,7 @@ Request Parameters
 Response
 --------
 
-.. rest_parameters:: parameters.yaml
+.. rest_parameters:: parameters_vnf_packages.yaml
 
   - Content-Type: content_type
 
@@ -404,7 +404,7 @@ Response Codes
 Request Parameters
 ------------------
 
-.. rest_parameters:: parameters.yaml
+.. rest_parameters:: parameters_vnf_packages.yaml
 
   - vnf_package_id: vnf_package_id_path
   - Accept: fetch_content_type
@@ -413,7 +413,7 @@ Request Parameters
 Response
 --------
 
-.. rest_parameters:: parameters.yaml
+.. rest_parameters:: parameters_vnf_packages.yaml
 
   - Content-Type: fetch_content_type