Merge "Add api-ref for fetch-artifact api"

api-ref/source/v1/parameters_vnf_packages.yaml

@@ -7,6 +7,14 @@ content_type:
   in: header
   required: true
   type: string
+fetch_artifact_content_type:
+  description: |
+    According to the artifact file extension, it is automatically set to
+    the corresponding Mime-Type in the response header. When the
+    corresponding Mime-Type is not found, set as `application/octet-stream`.
+  in: header
+  required: true
+  type: string
 fetch_content_type:
   description: |
     The fetched VNF Package will be returned with Content-Type set
@@ -23,13 +31,18 @@ range:
   type: string
 
 # variables in path
+artifact_path:
+  description: |
+    The artifact file's path in the VNF package.
+  in: path
+  required: true
+  type: string
 vnf_package_id_path:
   description: |
     The UUID of the VNF Package.
   in: path
   required: true
   type: string
-
 # variables in query
 
 # variables in body
@@ -196,4 +209,4 @@ vnfd_version:
     and absent otherwise.
   in: body
   required: true
-  type: string
+  type: string

api-ref/source/v1/vnf_packages.inc

@@ -417,6 +417,54 @@ Response
 
   - Content-Type: fetch_content_type
 
+Fetch an on-boarded VNF package Artifacts with HTTP_RANGE
+=========================================================
+
+.. rest_method::  GET /vnfpkgm/v1/vnf_packages/{vnf_package_id}/artifacts/{artifact_path}
+
+Fetch an on-boarded VNF package Artifacts with HTTP_RANGE.
+
+The GET method fetches the content of an artifact within
+a VNF package.
+
+The 'HTTP_RANGE' header is inspected for a valid value.
+If it is present and valid, then the artifact content within
+the range is fetched. If not present the entire content is
+fetched.
+
+Response Codes
+--------------
+
+.. rest_status_code:: success status.yaml
+
+  - 200
+  - 206
+
+.. rest_status_code:: error status.yaml
+
+  - 401
+  - 403
+  - 404
+  - 409
+  - 416
+
+Request Parameters
+------------------
+
+.. rest_parameters:: parameters_vnf_packages.yaml
+
+  - vnf_package_id: vnf_package_id_path
+  - artifact_path: artifact_path
+  - Accept: fetch_artifact_content_type
+  - Range: range
+
+Response
+--------
+
+.. rest_parameters:: parameters_vnf_packages.yaml
+
+  - Content-Type: fetch_artifact_content_type
+
 Reference
 ---------
 
@@ -433,4 +481,4 @@ checksum during instantiation of VNF. The default ``hashing_algorithm``
 configured in ``Glance`` service is ``sha512`` and an operator can
 override the default with any of these algorithms sha3_384, sha224,
 md5, sha512, blake2b, sha3_512, blake2s, sha384, sha1, shake_256,
-sha256, shake_128 and sha3_256.
+sha256, shake_128 and sha3_256.