Merge Request issue.

Re committing VNFPM files.

src/SOL005/VNFPackageManagement/definitions/SOL005VNFPMManagement_def.yaml

@@ -37,20 +37,20 @@ definitions:
           This information is copied from the VNFD.
           It shall be present after the VNF package
           content has been on-boarded and absent otherwise.
-        $ref: "#/definitions/Version"
+        $ref: "SOL005_def.yaml#/definitions/Version"
       vnfdVersion:
         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.
-        $ref: "#/definitions/Version"        
+        $ref: "SOL005_def.yaml#/definitions/Version"        
       checksum:
         description: >
           Checksum of the on-boarded VNF
           package. It shall be present after the VNF
           package content has been on-boarded and absent otherwise.
-        $ref: "#/definitions/Checksum"
+        $ref: "SOL005_def.yaml#/definitions/Checksum"
       softwareImages:
         description: >
           Information about VNF package artifacts that are software images.
@@ -60,34 +60,80 @@ definitions:
         type: "array"
         items:        
           $ref: "#/definitions/VnfPackageSoftwareImageInfo"
-
-  Version:
+      additionalArtifacts:
+        description: >
+          Information about VNF package artifacts
+          contained in the VNF package that are not software images.
+          This attribute shall not be present before
+          the VNF package content is on-boarded.
+          Otherwise, this attribute shall be present if
+          the VNF package contains additional artifacts.
+        type: "array"
+        items:        
+          $ref: "#/definitions/VnfPackageArtifactInfo"          
+      onboardingState:
         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.
-    type: string
+          On-boarding state of the VNF package.
+        $ref: "#/definitions/PackageOnboardingStateType" 
+      operationalState:
+        description: >
+          Operational state of the VNF package.
+        $ref: "#/definitions/PackageOperationalStateType" 
+      usageState:
+        description: >
+          Usage state of the VNF package.
+        $ref: "#/definitions/PackageUsageStateType"         
+      userDefinedData:
+        description: >
+          Usage state of the VNF package.
+        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"  
+      _links:
+        type: object
+        description: >
+          Links to resources related to this resource.
+        required:
+          - self
+          - packageContent          
+        properties:
+          self:
+            description: >
+              URI of this resource.
+            $ref: "SOL005_def.yaml#/definitions/Link"
+          vnfd:
+            description: >
+              Link to the VNFD resource. This link shall
+              be present after the VNF package content
+              is on-boarded.
+            $ref: "SOL005_def.yaml#/definitions/Link"             
+          packageContent:
+            description: >
+              Link to the "VNF package content" resource.
+            $ref: "SOL005_def.yaml#/definitions/Link"        
         
-  Checksum:
+  VnfPackageArtifactInfo:
     description: >
-      This type represents the checksum of a VNF package or an artifact file.  
+      This type represents an artifact other than a software image which is contained in a VNF package. 
+      It shall comply with provisions defined in Table 9.5.3.3-1.
     required:
-      - algorithm
-      - hash
+      - artifactPath
+      - checksum
     type: object
     properties:
-      algorithm:
+      artifactPath:
         description: >
-          Name of the algorithm used to generate the checksum,
-          as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512.
-        type: string
-      hash:
+          Path in the VNF package, which identifies the artifact
+          and also allows to access a copy of the artifact.
+        $ref: "SOL005_def.yaml#/definitions/String" 
+      checksum:
         description: >
-          The hexadecimal value of the checksum.
-        type: string
+          Checksum of the artifact file.
+        $ref: "SOL005_def.yaml#/definitions/Checksum"
+      metadata:
+        description: >
+          The metadata of the artifact that are available in the
+          VNF package, such as Content type, size, creation date, etc.
+        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"         
+        
   PkgmLinks:
     description: >
       This type represents the links to resources that a VNF package management notification can contain.  
@@ -99,13 +145,14 @@ definitions:
       vnfPackage:
         description: >
           Link to the resource representing the VNF package to
-          which the notified change applies, i.e. the individual onboarded
+          which the notified change applies, i.e. the individual on boarded
           VNF package resource that represents the VNF package.
         $ref: "SOL005_def.yaml#/definitions/Link" 
       subscription:
         description: >
           Link to the related subscription.
         $ref: "SOL005_def.yaml#/definitions/Link"   
+        
   VnfPackageSoftwareImageInfo:
     description: >
       This type represents an artifact contained in a VNF package which represents a software image.  
@@ -140,23 +187,22 @@ definitions:
       version:
         description: >
           Version of the software image.
-        $ref: "#/definitions/Version" 
+        $ref: "SOL005_def.yaml#/definitions/Version" 
       checksum:
         description: >
           Checksum of the software image file.
-        $ref: "#/definitions/Checksum" 
+        $ref: "SOL005_def.yaml#/definitions/Checksum" 
       containerFormat:
         description: >
           Container format indicates whether the software image
-          is in a file format that also contains metadata about the actual software.
+          is in a file format that also contains meta-data about the actual software.
           Permitted values:
           - AKI: a kernel image format
           - AMI: a machine image format
-          - ARI: a ramdisk image format
-          - BARE: the image does not have a container or
-          metadata envelope
+          - ARI: a ram disk image format
+          - BARE: the image does not have a container or meta-data envelope
           - DOCKER: docker container format
-          - OVA: OVF package in a tarfile
+          - OVA: OVF package in a tar file
           - OVF: OVF container format
         type: string
         enum:
@@ -244,7 +290,20 @@ definitions:
     enum:
     - "ENABLED"
     - "DISABLED"      
-    
+  PackageOnboardingStateType:
+    description: >
+      The enumeration PackageOnboardingStateType shall comply with the provisions defined in Table 9.5.4.3-1.
+      Permitted values:
+      - CREATED: The VNF package resource has been created.
+      - UPLOADING: The associated VNF package content is being uploaded.
+      - PROCESSING: The associated VNF package content is being processed, e.g. validation.
+      - ONBOARDED: The associated VNF package content is successfully on-boarded.
+    type: string
+    enum:
+      - CREATED
+      - UPLOADING
+      - PROCESSING
+      - ONBOARDED    
   PackageUsageStateType:
     type: "string"
     description: >  
@@ -262,10 +321,8 @@ definitions:
       userDefinedData:
         $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"    
     description: >  
-      "This type represents the request parameters for creating
-      a new individual VNF package resource. It shall comply with
-      the provisions defined in Table 9.5.2.2-1."
-      
+      IndividualVNF package resource creation parameters, as defined
+      in clause 9.5.2.2.      
   VnfPkgInfoModifications:
     description: >
       This type represents modifications to the information of a VNF package. 
@@ -328,7 +385,8 @@ definitions:
             
   PkgmSubscriptionRequest:
     description: >
-      This type represents a subscription request related to VNF package management notifications about VNF package on boarding or changes.
+      This type represents a subscription request related to VNF package management 
+      notifications about VNF package on boarding or changes.
     type: object
     required:
       - callbackUri
@@ -414,7 +472,7 @@ definitions:
                         vnfSoftwareVersion:
                           description: >
                             VNF software version to match
-                          $ref: "#/definitions/Version"
+                          $ref: "SOL005_def.yaml#/definitions/Version"
                         vnfdVersions:
                           description: >
                             If present, match VNF packages that contain
@@ -423,7 +481,7 @@ definitions:
                             name, from one particular provider.
                           type: array    
                           items:
-                            $ref: "#/definitions/Version"                           
+                            $ref: "SOL005_def.yaml#/definitions/Version"                           
                 
             vnfdId:
               description: >
@@ -464,3 +522,137 @@ definitions:
               type: array
               items:
                 $ref: "#/definitions/PackageUsageStateType"
+                
+  VnfPackageOnboardingNotification:
+    description: >
+      This type represents a VNF package management notification, which informs the receiver that the on boarding process
+      of a VNF package incomplete and the package is ready for use. A change of the on-boarding state before the VNF
+      package is on-boarded is not reported. It shall comply with the provisions defined in Table 9.5.2.8-1. The support of this
+      notification is mandatory. The notification shall be triggered by the NFVO when the value of the "onboardingState"
+      attribute of a new VNF package has changed to "ONBOARDED".
+    type: object
+    required:
+      - id
+      - notificationType
+      - timeStamp
+      - vnfPkgId
+      - vnfdId      
+      - _links
+    properties:
+      id:
+        description: >
+          Identifier of this notification. If a notification is sent
+          multiple times due to multiple subscriptions, the "id"
+          attribute of all these notifications shall have the same value.
+        $ref: "SOL005_def.yaml#/definitions/Identifier"
+      notificationType:
+        description: >
+          Discriminator for the different notification types.
+          Shall be set to "VnfPackageOnboardingNotification" for
+          this notification type.
+        type: string
+      subscriptionId:
+        description: >
+          Identifier of the subscription that this notification relates to.
+        $ref: "SOL005_def.yaml#/definitions/Identifier"
+      timeStamp:
+        description: >
+          Date and time of the generation of the notification.
+        $ref: "SOL005_def.yaml#/definitions/DateTime"
+      vnfPkgId:
+        description: >
+          Identifier of the on-boarded VNF package. This identifier
+          is allocated by the NFVO.
+          Its value is the same as the value of the "id" attribute of
+          the related "Individual VNF package" resource.
+        $ref: "SOL005_def.yaml#/definitions/Identifier"
+      vnfdId:
+        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 on-boarded VNF package.
+        $ref: "SOL005_def.yaml#/definitions/Identifier"         
+      _links:
+        description: >
+          Links to resources related to this notification.
+        $ref: "#/definitions/PkgmLinks"     
+
+  VnfPackageChangeNotification:
+    description: >
+      This type represents a VNF package management notification, which informs the receiver of a change of the status in an
+      on-boarded VNF package. Only changes in the "operationalState" attribute of an on-boarded VNF package and the
+      deletion of the VNF package will be reported. Change in the "usageState" and "onboardingState" attributes are not
+      reported. The notification shall comply with the provisions defined in Table 9.5.2.9-1. The support of this notification is
+      mandatory. The notification shall be triggered by the NFVO when there is a change in the status of an onboarded VNF
+      package, as follows.
+      • The "operationalState" attribute of a VNF package has changed, and the "onboardingState" attribute of the
+      package has the value "ONBOARDED".
+      • The on-boarded VNF package has been deleted.
+    type: object
+    required:
+      - id
+      - notificationType
+      - timeStamp
+      - vnfPkgId
+      - vnfdId   
+      - changeType      
+      - _links
+    properties:
+      id:
+        description: >
+          Identifier of this notification. If a notification is sent
+          multiple times due to multiple subscriptions, the "id"
+          attribute of all these notifications shall have the same value.
+        $ref: "SOL005_def.yaml#/definitions/Identifier"
+      notificationType:
+        description: >
+          Discriminator for the different notification types.
+          Shall be set to "VnfPackageChangeNotification" for this
+          notification type.
+        type: string
+      subscriptionId:
+        description: >
+          Identifier of the subscription that this notification relates to.
+        $ref: "SOL005_def.yaml#/definitions/Identifier"
+      timeStamp:
+        description: >
+          Date and time of the generation of the notification.
+        $ref: "SOL005_def.yaml#/definitions/DateTime"
+      vnfPkgId:
+        description: >
+          Identifier of the on-boarded VNF package. This identifier
+          is allocated by the NFVO.
+          Its value is the same as the value of the "id" attribute of
+          the related "Individual VNF package" resource.
+        $ref: "SOL005_def.yaml#/definitions/Identifier"
+      vnfdId:
+        description: >
+          Identifier of the VNFD contained in the VNF package,
+          which also identifies the VNF package. This identifier is
+          allocated by the VNF provider and copied from the VNFD.
+        $ref: "SOL005_def.yaml#/definitions/Identifier"
+      changeType:
+        description: >
+          The type of change of the VNF package.
+        $ref: "#/definitions/PackageChangeType"
+      operationalState:
+        description: >
+          New operational state of the VNF package.
+          Only present when changeType is OP_STATE_CHANGE.
+        $ref: "#/definitions/PackageOperationalStateType"         
+      _links:
+        description: >
+          Links to resources related to this notification.
+        $ref: "#/definitions/PkgmLinks"
+
+  PackageChangeType:
+    type: "string"
+    description: >  
+      The enumeration PackageChangeType shall comply with the provisions defined in Table 9.5.4.6-1.
+      Permitted Values: 
+      - OP_STATE_CHANGE: The "operationalState" attribute has been changed.
+      - PKG_DELETE: The VNF package has been deleted.
+    enum:
+    - "OP_STATE_CHANGE"
+    - "PKG_DELETE"        
\ No newline at end of file

src/SOL005/VNFPackageManagement/definitions/SOL005_def.yaml

@@ -42,7 +42,6 @@
      type: object
           
    ProblemDetails:
-     #SOL005 location: 4.3.5.3-1
      description: >
        The definition of the general "ProblemDetails" data structure from
        IETF RFC 7807 [19] is reproduced inthis structure. Compared to the
@@ -106,6 +105,32 @@
      description: >
        String formatted according to IETF RFC 3986.
      type: string     
+   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.
+     type: string
+   Checksum:
+     description: >
+       This type represents the checksum of a VNF package or an artifact file.  
+     required:
+       - algorithm
+       - hash
+     type: object
+     properties:
+       algorithm:
+         description: >
+           Name of the algorithm used to generate the checksum,
+           as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512.
+         type: string
+       hash:
+         description: >
+           The hexadecimal value of the checksum.
+         type: string 
          
    SubscriptionAuthentication:
      type: object

src/SOL005/VNFPackageManagement/responses/SOL005_resp.yaml

@@ -49,7 +49,7 @@
          minimum: 0
    206:
      description: >
-       Partial Content
+       Partial Content.
        
        On success, if the NFVO supports range requests, a
        single consecutive byte range from the content of the

src/SOL005/VNFPackageManagement/responses/VNFPackageManagement_resp.yaml

@@ -74,7 +74,7 @@
        $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"             
    409:
      description: >
-       Conflict
+       Conflict.
  
        Error: The operation cannot be executed
        currently, due to a conflict with the state of
@@ -110,7 +110,7 @@
        
    409-another-nsd-operation-ongoing:
      description: >
-       Conflict
+       Conflict.
  
        The operation cannot be executed currently, due to a conflict with the
        state of the NS instance resource.
@@ -136,7 +136,7 @@
        $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
    409-inconsistent-state:
      description: >
-       Conflict
+       Conflict.
  
        Another request is in progress that prohibits the fulfilment of
        the current request, or the current resource state is inconsistent
@@ -159,7 +159,7 @@
        $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
    409-state-conflict-INSTANTIATED:
      description: >
-       Conflict
+       Conflict.
  
        The operation cannot be executed currently, due to a conflict with the
        state of the NS instance resource.
@@ -210,7 +210,7 @@
        $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
    409-state-conflict-NOT-INSTANTIATED:
      description: >
-       Conflict
+       Conflict.
  
        The operation cannot be executed currently, due to a conflict with the
        state of the NS instance resource.
@@ -237,7 +237,7 @@
        $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
    409-state-conflict-ONBOARDING:
      description: >
-       Conflict
+       Conflict.
  
        Error: The operation cannot be executed currently,
        due to a conflict with the state of the resource.
@@ -264,11 +264,11 @@
        $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
    409-state-conflict-ONBOARDING-NOT-CREATED:
      description: >
-       Conflict
+       Conflict.
  
        Error: The operation cannot be executed currently,
        due to a conflict with the state of the resource.
-       Typically, this is due to the fact that the onboarding
+       Typically, this is due to the fact that the on boarding
        state of the VNF package resource is not CREATED .