SOL005_102 to SOL005_110

src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml

@@ -208,7 +208,9 @@ definitions:
       All attributes shall match in order for the filter
       to match (logical "and" between different filter attributes). 
       If an attribute is an array, the attribute shall match if at least
-      one of the values in the array matches (logical "or" between the values of one filter attribute)..
+      one of the values in the array matches (logical "or" between the values of one filter attribute).
+      NOTE:	The permitted values of the "notificationTypes" attribute are spelled exactly as the names
+      of the notification types to facilitate automated code generation systems.
     type: object
     properties:
       nsInstanceSubscriptionFilter:
@@ -222,6 +224,7 @@ definitions:
           - AlarmNotification
           - AlarmClearedNotification
           - AlarmListRebuiltNotification.
+          See note.
         type: array
         items:
           type: string
@@ -361,19 +364,19 @@ definitions:
   FaultyComponentInfo:
     description: >
       This type represents the faulty component that has a negative impact on an NS. 
-      It shall comply with the provisions
-      defined in Table 8.5.3.4-1.
+      It shall comply with the provisions defined in Table 8.5.3.4-1.
+      NOTE:	At least one of the attributes shall be present.
     type: object
     properties:
       faultyNestedNsInstanceId:
         description: >
-          Identifier of the faulty nested NS instance.
+          Identifier of the faulty nested NS instance. See note.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
       faultyResourceType:
         description: >
-          Identifier of the faulty NS virtual link instance.
+          Identifier of the faulty NS virtual link instance. See note.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
       faultyNsVirtualLinkInstanceId:
         description: >
-          Identifier of the faulty VNF instance.
+          Identifier of the faulty VNF instance. See note.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
\ No newline at end of file

src/SOL005/NSPerformanceManagement/definitions/SOL005NSPerformanceManagement_def.yaml

@@ -332,6 +332,14 @@ definitions:
       to the OSS/BSS as a result of collecting
       performance information as part of a PM job.
       The type shall comply with the provisions defined in Table 7.5.2.10-1.
+      NOTE:	The sub-object allows to structure the measured object but is not to be confused with sub-counters which allow to structure the measurement value.
+
+      	EXAMPLE:	Measured object:	VnfInstanceXYZ
+      		Sub-object:		VnfcInstance1
+      		Measurement: 	vCPU_utilization
+      		Sub-counters: 	vCPU utilization of each of the vCPUs of VnfcInstance1
+      						(vCPU_utilization.vCPU1, vCPU_utilization.vCPU2, etc.).
+
     type: object
     required:
       - entries
@@ -367,18 +375,7 @@ definitions:
                 Identifier of the sub-object instance of the measured object
                 instance for which the performance metric is reported.
                 Shall be present if this is required in clause 6.2 of
-                ETSI GS NFV-IFA 027 for the related measured object type.
-
-                The sub-object allows to structure the measured object but is
-                not to be confused with sub-counters which allow to structure
-                the measurement value.
-
-                	EXAMPLE:
-                		Measured object:	VnfInstanceXYZ
-                		Sub-object:		VnfcInstance1
-                		Measurement: 	vCPU_utilization
-                		Sub-counters: 	vCPU utilization of each of the vCPUs of VnfcInstance1
-                						(vCPU utilization.vCPU1, vCPU_utilization.vCPU2, etc.).
+                ETSI GS NFV-IFA 027 for the related measured object type. See note.
               type: array
               items:
                 $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
@@ -419,6 +416,7 @@ definitions:
     description: >
       This type represents modifications to a PM job.
       It shall comply with the provisions defined in Table 7.5.2.12-1.
+      NOTE:	At least one of the attributes defined in this type shall be present in request bodies.
     type: object
     anyOf:
       - required:
@@ -429,7 +427,7 @@ definitions:
       callbackUri:
         description: >
           New value of the "callbackUri" attribute. The value "null" is not permitted.
-          At least one of the attributes defined in this type shall be present in request bodies.
+          See note.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
       authentication:
         description: >
@@ -437,13 +435,14 @@ definitions:
           If present in a request body, these modifications shall be applied according to
           the rules of JSON Merge Patch (see IETF RFC 7396).
           This attribute shall not be present in response bodies.
-          At least one of the attributes defined in this type shall be present in request bodies.
+          See note.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
 
   ThresholdModifications:
     description: >
       This type represents modifications to a threshold.
       It shall comply with the provisions defined in Table 7.5.2.11-1.
+      NOTE:	At least one of the attributes defined in this type shall be present in request bodies.
     type: object
     anyOf:
       - required:
@@ -454,7 +453,7 @@ definitions:
       callbackUri:
         description: >
           New value of the "callbackUri" attribute. The value "null" is not permitted.
-          At least one of the attributes defined in this type shall be present in request bodies.
+          See note.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
       authentication:
         description: >
@@ -463,6 +462,7 @@ definitions:
           the rules of JSON Merge Patch (see IETF RFC 7396).
           This attribute shall not be present in response bodies.
           At least one of the attributes defined in this type shall be present in request bodies.
+          See note.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
 
 #  PmNotificationsFilter:
@@ -501,6 +501,16 @@ definitions:
     description: >
       This type represents collection criteria for PM jobs. 
       It shall comply with the provisions defined in Table 7.5.3.3-1.
+
+      NOTE 1:	At the end of each reportingPeriod, the API producer
+      inform the API consumer about availability of the performance data
+      collected for each completed collection period during this reportingPeriod.
+      The reportingPeriod should be equal to or a multiple of the collectionPeriod.
+      In the latter case, the performance data for the collection periods within one.
+
+      NOTE 2:	In particular when choosing short collection and reporting periods, the number
+      of PM jobs that can be supported depends on the capability of the producing entity.
+      reporting period are reported together.
     type: object
     required:
       - collectionPeriod
@@ -532,16 +542,7 @@ definitions:
         description: >
           Specifies the periodicity at which the API producer
           will collect performance information. The unit
-          shall be seconds.
-          At the end of each reportingPeriod, the API producer will inform 
-          the API consumer about availability of the performance data collected 
-          for each completed collection period during this reportingPeriod. 
-          The reportingPeriod should be equal to or a multiple of the collectionPeriod. 
-          In the latter case, the performance data for the collection periods
-          within one reporting period are reported together.    
-          In particular when choosing short collection and reporting periods, 
-          the number of PM jobs that can be supported depends on the capability 
-          of the producing entity.
+          shall be seconds. See note 1 and note 2.
         type: integer
         minimum: 0
         default: 0
@@ -550,15 +551,7 @@ definitions:
           Specifies the periodicity at which the API producer
           will report to the API consumer.
           about performance information. The unit shall be seconds.
-          At the end of each reportingPeriod, the API producer will inform the 
-          API consumer about availability of the performance data collected for 
-          each completed collection period during this reportingPeriod. 
-          The reportingPeriod should be equal to or a multiple of the collectionPeriod. 
-          In the latter case, the performance data for the collection periods
-          within one reporting period are reported together.    
-          In particular when choosing short collection and reporting periods, 
-          the number of PM jobs that can be supported depends on the capability 
-          of the producing entity.          
+          See note 1 and note 2.
         type: integer
         minimum: 0
         default: 0
@@ -573,6 +566,12 @@ definitions:
   ThresholdCriteria:
     description: >
       This type represents criteria that define a threshold.
+      NOTE 1:	In the present document, simple thresholds are defined.
+      The definition of additional threshold types is left for future specification.
+      NOTE 2:	The hysteresis is defined to prevent storms of threshold
+      crossing notifications. When processing a request to create a threshold,
+      implementations should enforce a suitable minimum value for this attribute
+      (e.g. override the value or reject the request).
     type: object
     required:
       - performanceMetric
@@ -590,9 +589,7 @@ definitions:
           are present in the data structure.
           Permitted values:
           * SIMPLE: Single-valued static threshold
-          In the present document, simple thresholds are defined. The
-          definition of additional threshold types is left for future
-          specification.
+          See note 1.
         type: string
         enum:
           - SIMPLE
@@ -619,9 +616,5 @@ definitions:
               "thresholdValue" + "hysteresis". A notification with crossing
               direction "DOWN" will be generated if the measured value reaches
               or undercuts "thresholdValue" - "hysteresis".
-              The hysteresis is defined to prevent storms of threshold
-              crossing notifications. When processing a request to create a
-              threshold, implementations should enforce a suitable minimum
-              value for this attribute (e.g. override the value or reject the
-              request).
+              See note 2.
             type: integer
\ No newline at end of file

src/SOL005/NSPerformanceManagementNotification/definitions/SOL005NSPerformanceManagementNotification_def.yaml

@@ -96,9 +96,8 @@ definitions:
   ThresholdCrossedNotification:
     description: >
       This type represents a notification that is sent when a threshold has been crossed.
-      NOTE:	The timing of sending this notification is determined by the capability of 
-      the producing entity to evaluate the threshold crossing condition.
-      The notification shall be triggered by the NFVO when a threshold has been crossed.
+      NOTE:	The sub-object allows to structure the measured object but is not to be confused
+      with sub-counters which allow to structure the measurement.
     type: object
     required:
       - id
@@ -117,7 +116,7 @@ definitions:
           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..
+          notifications shall have the same value.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
       notificationType:
         description: >
@@ -153,9 +152,7 @@ definitions:
           the measurement applies. Shall be present if this is required
           in clause 6.2 of ETSI GS NFV IFA 027 for the related measured
           object type.
-          The sub-object allows to structure the measured object but is
-          not to be confused with sub-counters which allow to structure
-          the measurement.
+          See note.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs"
       performanceMetric:
         description: >

src/SOL005/VNFPackageManagement/definitions/SOL005VNFPackageManagement_def.yaml

@@ -459,6 +459,9 @@ definitions:
     description: >
       This type represents modifications to the information of a VNF package. 
       It shall comply with the provisions defined in Table 9.5.2.3-1.
+      NOTE:	At least one of the two parameters shall be present. If the VNF package
+      is not on-boarded, the operation is used only to update existing or add additional
+      user defined data using the userDefinedData attribute.
     anyOf:
       - required:
           - operationalState
@@ -468,11 +471,11 @@ definitions:
       operationalState:
         description: >
           New value of the operational state of the on-boarded
-          instance of the VNF package.
+          instance of the VNF package. See note.
         $ref: "#/definitions/PackageOperationalStateType"
       userDefinedData:
         description: >
-          User defined data to be updated. For existing keys, the value is replaced.
+          User defined data to be updated. For existing keys, the value is replaced. See note.
         $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
 
   UploadVnfPkgFromUriRequest: