Commit f4a988a6 authored by Pietro Piscione's avatar Pietro Piscione
Browse files

Added missing notes to the CreatePolicyRequest, PolicyModifications,... 

Added missing notes to the CreatePolicyRequest, PolicyModifications, PolicyConflictNotification and PolicyNotificationsFilter data types.
parent 376484f3

src/SOL012/PolicyManagement/definitions/PolicyManagement_def.yaml

+12 −0
Original line number Diff line number Diff line
@@ -4,6 +4,12 @@ definitions: 
      description: >

        This type represents request parameters for creating a policy. It shall comply with the provisions defined

        in table 5.6.2.2-1.

        

        NOTE 1: For example, the PF can be a VNFM or VIM when the API producer is an NFVO.

        NOTE 2: The associations refer to identifiers of entities that the PF manages. E.g. if the PF is a VNFM, the policy

                can associate to VNF instances; if the PF is NFVO, the policy can associate to an NS instances.

        NOTE 3: How the PF determines the scope of applicability of the policy when this attribute is absent is outside the

                scope of the present document. 

      type: object

      properties:

        designer:
@@ -195,6 +201,12 @@ definitions: 
        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).



        NOTE 1: The permitted values of the "notificationTypes" attribute are spelled exactly as the names of the notification

                types to facilitate automated code generation systems.

        NOTE 2: For "PolicyConflictNotification", the notification is sent if any of the policies specified in the subscription 

                is impacted by the conflict, as defined in clause 5.6.2.8. 

        

      type: object

      properties:

        notificationTypes:

src/SOL012/PolicyManagementNotification/definitions/PolicyManagementNotification_def.yaml

+3 −0
Original line number Diff line number Diff line
@@ -87,6 +87,9 @@ definitions: 
        This notification shall be triggered by the API producer when a policy conflict is detected,

        and any of the policies specified in an associated notification subscription is impacted

        by the conflict.

        

        NOTE: The policy identifier and the corresponding selected version are mapped by the order 

              in the array. 

      type: object

      properties:

        id:

src/SOL012/definitions/SOL012_def.yaml

+6 −1
Original line number Diff line number Diff line
@@ -303,7 +303,12 @@ definitions: 
    PolicyModifications:

      description: >

        This type represents the parameters for modifying a policy. It shall comply with the provisions

        defined in table 5.6.2.4-1

        defined in table 5.6.2.4-1.

        

        NOTE 1: If "removeAllAssociations" is set to TRUE, neither "addAssociations" nor "removeAssociations" attributes

                shall be present.

        NOTE 2: Once all associations have been removed, how the PF determines the scope of applicability of the policy

                is outside the scope of the present document. 

      type: object

      properties:

        activationStatus: