SOL003_def.yaml

# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt

definitions:
  Link:
    description: >
      This type represents a link to a resource using an absolute URI.
    type: object
    required:
      - href
    properties:
      href:
        description: >
          URI of another resource referenced from a resource.
          Shall be an absolute URI (i.e. a UTI that contains {apiRoot}).
        $ref: "#/definitions/Uri"

  NotificationLink:
    description: >
      This type represents a link to a resource in a notification, using an absolute or relative URI.
    type: object
    required:
      - href
    properties:
      href:
        description: >
          URI of a resource referenced from a notification.
          Should be an absolute URI (i.e. a URI that contains
          {apiRoot}), however, may be a relative URI (i.e. a URI
          where the {apiRoot} part is omitted) if the {apiRoot}
          information is not available.
        $ref: "#/definitions/Uri"

  KeyValuePairs:
    description: >
      This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON,
      a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4
      of IETF RFC 8259. In the following example, a list of key-value pairs with four keys ("aString", "aNumber",
      "anArray" and "anObject") is provided to illustrate that the values associated with different keys can be of
      different type.
    type: object

  ApiVersionInformation:
    description: >
      This type represents API version information.
    type: object
    required:
      - uriPrefix
      - apiVersions
    properties:
      uriPrefix:
        description: >
          Specifies the URI prefix for the API, in the following
          form {apiRoot}/{apiName}/{apiMajorVersion}/.
        type: string
      apiVersions:
        description: >
          Version(s) supported for the API signaled by the
          uriPrefix attribute.
        type: array
        items:
          type: object
          required:
            - version
          properties:
            version:
              description: >
                Identifies a supported version. The value of the
                version attribute shall be a version identifier as
                specified in clause 9.1 (SOL013).
              type: string
            isDeprecated:
              description: >
                If such information is available, this attribute indicates
                whether use of the version signaled by the version
                attribute is deprecated (true) or not (false).

                A deprecated version is still supported by the API producer but is recommended
                not to be used any longer.
                When a version is no longer supported, it does not appear in the response body.
              type: boolean
            retirementDate:
              description: >
                The date and time after which the API version will no
                longer be supported.
                This attribute may be included if the value of the
                isDeprecated attribute is set to true and shall be
                absent otherwise.
              $ref: "#/definitions/DateTime"

  VnfInstanceSubscriptionFilter:
    description: >
      This type represents subscription filter criteria to match VNF
      instances.
      * NOTE 1:	The attributes "vnfdIds" and "vnfProductsFromProviders" are alternatives to reference to VNF instances
                that are based on certain VNFDs in a filter. They should not be used both in the same filter instance,
                but one alternative should be chosen.
        NOTE 2:	The attributes "vnfInstanceIds" and "vnfInstanceNames" are alternatives to reference to particular VNF
                instances in a filter. They should not be used both in the same filter instance, but one alternative
                should be chosen.
    type: object
    anyOf:
      - oneOf:
        - required:
            - vnfdId
        - required:
            - vnfProductsFromProviders
      - oneOf:
        - required:
            - vnfInstanceIds
        - required:
            - vnfInstanceNames
    properties:
      vnfdIds:
        description: >
          If present, match VNF instances that were created based on a VNFD
          identified by one of the vnfdId values listed in this attribute. See note 1.
        type: array
        items:
          $ref: "#/definitions/Identifier"
      vnfProductsFromProviders:
        description: >
          If present, match VNF instances that belong to VNF products from
          certain providers. See note 1.
        type: array
        items:
          type: object
          required:
            - vnfProvider
          properties:
            vnfProvider:
              description: >
                Name of the VNF provider to match.
              type: string
            vnfProducts:
              description: >
                If present, match VNF instances that belong to VNF products
                with certain product names, from one particular provider.
              type: array
              items:
                type: object
                required:
                  - vnfProductName
                properties:
                  vnfProductName:
                    description: >
                      Name of the VNF product to match.
                    type: string
                  versions:
                    description: >
                      If present, match VNF instances that belong to VNF
                      products with certain versions and a certain product
                      name, from one particular provider.
                    type: array
                    items:
                      type: object
                      required:
                        - vnfSoftwareVersion
                      properties:
                        vnfSoftwareVersion:
                          description: >
                            Software version to match.
                          $ref: "#/definitions/Version"
                        vnfdVersions:
                          description: >
                            If present, match VNF instances that belong to VNF
                            products with certain VNFD versions, a certain
                            software version and a certain product name, from
                            one particular provider.
                          type: array
                          items:
                            $ref: "#/definitions/Version"
      vnfInstanceIds:
        description: >
          If present, match VNF instances with an instance identifier listed
          in this attribute. See note 2.
        type: array
        items:
          $ref: "#/definitions/Identifier"
      vnfInstanceNames:
        description: >
          If present, match VNF instances with a VNF Instance Name listed in
          this attribute. See note 2.
        type: array
        items:
          type: string

  VimConnectionInfo:
    description: >
      This type represents parameters to connect to a VIM for managing the resources of a VNF instance.

      This structure is used to convey VIM-related parameters over the Or-Vnfm interface. Additional parameters 
      for a VIM may be configured into the VNFM by means outside the scope of the present document and bound to 
      the identifier of that VIM.

      * NOTE 1:	If applicable, this attribute also provides information about the resourceGroupIds
                that are accessible using a particular set of credentials. See definition of "resourceGroupId" 
                in clause 9.5.3.3.
      * NOTE 2:	Once the connectivity between VNFM and VIM is provided through a secure connection over HTTP 
                Secure (HTTP over SSL/TLS), and the connection might also be established through a VPN 
                (for example TLS-based VPN tunnelling) for site-to-site connection, the "accessInfo" JSON data 
                structure, and the sensitive data related information ("username"/"password" as required properties 
                for authentication purpose), will be transmitted as plain text through a TLS tunnel without additional 
                encoding/encryption before transmitting it, making the sensitive data visible to the endpoint. The 
                base64 encoded certificates are only used by the VNFM to verify the authenticity of the interface 
                endpoint of the VIM.
    type: object
    required:
      - vimType
    properties:
      vimId:
        description: >
          The identifier of the VIM instance. This identifier is managed by the NFVO.
          Shall be present to address additional information about the VIM if such information has been configured 
          into the VNFM by means outside the scope of the present document and should be absent otherwise.
        $ref: "#/definitions/Identifier"
      vimType:
        description: >
          Discriminator for the different types of the VIM information.
          The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" 
          attributes, based on the type of the VIM.
          The set of permitted values is expected to change over time as new types or versions of VIMs become 
          available.
          The ETSI NFV registry of VIM-related information [i.3] provides access to information about 
          VimConnectionInfo definitions for various VIM types. The structure of the registry is defined in
          annex C.
        type: string
      interfaceInfo:
        description: >
          Information about the interface or interfaces to the VIM, if applicable, such as the URI of an 
          interface endpoint to communicate with the VIM. The applicable keys are dependent on the content of 
          vimType.
          Alternatively, such information may have been configured into the VNFM and bound to the vimId.
        $ref: "#/definitions/KeyValuePairs"
      accessInfo:
        description: >
          Authentication credentials for accessing the VIM and other access-related information such as tenants 
          or infrastructure resource groups (see note 1). The applicable keys are dependent on the content of 
          vimType.
          If the VimConnectionInfo structure is part of an HTTP response message content, sensitive attributes 
          that are children of this attributes (such as passwords) shall not be included.
          If the VimConnectionInfo structure is part of an HTTP request message content, sensitive attributes 
          that are children of this attribute (such as passwords) shall be present if they have not been 
          provisioned out of band.
          See note 2.
        $ref: "#/definitions/KeyValuePairs"
      extra:
        description: >
          VIM type specific additional information. The applicable structure, and whether or not this attribute 
          is available, is dependent on the content of vimType.
        $ref: "#/definitions/KeyValuePairs"

  ResourceHandle:
    required:
      - resourceId
    type: object
    description: >
      This type represents the information that allows addressing a virtualised resource that is used by a VNF instance.
      Information about the resource is available from the VIM.

      * NOTE: The value set of the "vimLevelResourceType" attribute is within the scope of the VIM or the resource 
              provider and can be used as information that complements the ResourceHandle. This value set is different from 
              the value set of the "type" attribute in the ResourceDefinition (refer to clause 9.5.3.2).

    properties:
      vimConnectionId:
        description: >
          Identifier of the VIM connection to manage the resource.
          This attribute shall only be supported and present if VNF-related resource management in direct mode is applicable.
          The applicable "VimConnectionInfo" structure, which is referenced by vimConnectionId, can be obtained from the 
          "vimConnectionInfo" attribute of the "VnfInstance" structure.
        $ref: "#/definitions/Identifier"
      resourceProviderId:
        description: >
          Identifier of the entity responsible for the management of the
          resource. This attribute shall only be supported and present when
          VNF-related resource management in indirect mode is applicable. The
          identification scheme is outside the scope of the present document.
        $ref: "#/definitions/Identifier"
      resourceId:
        description: >
          Identifier of the resource in the scope of the VIM or the resource provider.
        $ref: "#/definitions/IdentifierInVim"
      vimLevelResourceType:
        description: >
          Type of the resource in the scope of the VIM or the resource provider. See note.
        type: string

  VnfExtCpData:
    description: >
      This type represents configuration information for external CPs created.
      * NOTE 1: 	In case this identifier refers to a CPD with trunking enabled, the external CP instances created
                  from this CPD will represent ports in a trunk.
      * NOTE 2: 	Within one VNF instance, all VNFC instances created from a particular VDU have the same external
                  connectivity. Thus, given a particular value of the "cpdId" attribute, there shall be one
                  "cpConfig" entry for each VNFC instance that has been or can be created from a VDU which includes
                  a CPD identified by the "cpdId" attribute. If the cpConfig represents a subport in a trunk,
                  all "cpConfig" entries in this list shall have the same segmentationId, which means they are
                  connected to the same set of external VLs via the trunk.
      * NOTE 3: 	The map entry value shall be set to "null" in order to delete a "VnfExtCpConfig" entry identified
                  by a particular key value from the map, i.e. for the disconnection of an existing external
                  CP instance addressed by cpInstanceId in the deleted map entry from a particular external
                  virtual link, and deletion of that instance in case it represents a subport. Deleting the
                  last key from the map removes the affected instance of the "VnfExtCpData" structure from
                  its parent data structure.
      * NOTE 4:   If, as defined by the input parameters of a "ChangeVnfFlavour", "ChangeExtVnfConnectivity" or
                  "ChangeCurrentVnfPkg" operation or as part of the Grant response for any of these operations, a cpConfig
                  map entry identified by a particular map key value is moved into another "ExtVirtualLinkData" or
                  "VnfExtCpData" structure, this particular cpConfig map entry may be used by an external CP instance
                  different than the one that has used it before the operation, or by no external CP instance at all.
                  Renaming a CPD identifier during the "changeCurrentVnfPkg" operation does not count as moving the related
                  "cpConfig" map entries to a new "extCpData" structure.
    type: object
    required:
      - cpdId
    properties:
      cpdId:
        description: >
          The identifier of the CPD in the VNFD. See note 1.
        $ref: "#/definitions/IdentifierInVnfd"
      cpConfig:
        description: >
          Map of instance data that need to be configured on the CP instances
          created from the respective CPD.
          The key of the map which identifies the individual VnfExtCpConfig entries is of type "IdentifierInVnf"
          and is managed by the NFVO.
          The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396).
          See notes 2, 3 and 4.
        type: object
        additionalProperties:
          $ref: "#/definitions/VnfExtCpConfig"

  VnfExtCpConfig:
    description: >
      This type represents an externally provided link port or network address information per instance of an external connection 
      point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external 
      VL. In case a link port is not provided, the VNFM shall create a link port on the external VL and use that link port to connect 
      the external CP to the external VL.

      * NOTE: The following conditions apply to the attributes "linkPortId" and "cpProtocolData":
              1) Void.
              2) At least one of the "linkPortId" and "cpProtocolData" attributes shall be present for an external CP instance
              representing a subport that is to be created, or an external CP instance that is to be created by creating the
              corresponding VNFC or VNF instance during the current or a subsequent LCM operation, or for an existing
              external CP instance that is to be re-configured or added to a particular external virtual link.
              3) If the "linkPortId" attribute is absent, the VNFM shall create a link port.
              4) If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided referencing a
              precreated link port, and the VNFM can use means outside the scope of the present document to obtain the
              pre-configured address information for the connection point from the resource representing the link port.
              5) If both "cpProtocolData" and "linkportId" are provided, the NFVO shall ensure that the
              cpProtocolData can be used with the pre-created link port referenced by "linkPortId".

    anyOf:
      - required:
        - linkPortId
      - required:
        - cpProtocolData
      - required:
        - netAttDefResourceId
    type: object
    properties:
      parentCpConfigId:
        description: >
          Value of the key that identifies the  "VnfExtCpConfig" map entry which corresponds to the parent port of the
          trunk. Reference to the "VnfExtCpConfig" entry that corresponds to the parent port of the trunk. Only present
          in "VnfExtCpConfig" structures that provide configuration information for a CP which represents a sub-port in
          a trunk, and if parent ports are supported.
        $ref: "#/definitions/IdentifierInVnf"
      
      linkPortId:
        description: >
          Identifier of a pre-configured link port to which the external CP
          will be associated. See notes.
        $ref: "#/definitions/Identifier"

      createExtLinkPort:
        description: >
          Indicates to the VNFM the need to create a dedicated link port for the external CP.
          If set to True, the VNFM shall create a link port.
          If set to False, the VNFM shall not create a link port.
          This attribute is only applicable for external CP instances without a floating IP address that expose a VIP CP
          instance for which a dedicated IP address is allocated. It shall be present in that case and shall be absent otherwise.
        type: boolean
      
      cpProtocolData:
        description: >
          Parameters for configuring the network protocols on the link port that connects the CP to a VL. See note.
        type: array
        items:
          $ref: "#/definitions/CpProtocolData"

  CpProtocolData:
    description: >
      This type represents network protocol data.
      * NOTE:	This attribute allows to signal the addition of further types of layer and protocol
                in future versions of the present document in a backwards-compatible way. In the current
                version of the present document, only IP over Ethernet is supported.
    type: object
    required:
      - layerProtocol
    properties:
      layerProtocol:
        description: >
          Identifier of layer(s) and protocol(s).
          Permitted values: IP_OVER_ETHERNET.
          See note
        type: string
        enum:
          - IP_OVER_ETHERNET
          - IP_FOR_VIRTUAL_CP
      ipOverEthernet:
        description: >
          Network address data for IP over Ethernet to assign to the external CP
          instance. Shall be present if layerProtocol is equal to
          "IP_OVER_ETHERNET", and shall be absent otherwise.
        $ref: "#/definitions/IpOverEthernetAddressData"

  IpOverEthernetAddressData:
    description: >
      This type represents network address data for IP over Ethernet.
      * NOTE 1:	At least one of "macAddress" or "ipAddresses" shall be present.
      * NOTE 2:	Exactly one of "fixedAddresses", "numDynamicAddresses" or "ipAddressRange" shall be present.
      * NOTE 3:	If the CP instance represents a subport in a trunk, segmentationId shall be present.
                Otherwise it shall not be present.
      * NOTE 4:	Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual
                network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header
                of the packets or it may be an identifier used between the application and the NFVI networking
                infrastructure to identify the network sub-interface of the trunk port in question. In the latter
                case the NFVI infrastructure will map this local segmentationId to whatever segmentationId is
                actually used by the NFVI’s transport technology.
    type: object
    anyOf:
      - required:
          - macAddress
      - required:
          - ipAddresses
    oneOf:
      - required:
          - fixedAddresses
      - required:
          - numDynamicAddresses
      - required:
          - ipAddressRange
    properties:
      macAddress:
        description: >
          MAC address. If this attribute is not present, it shall be chosen by
          the VIM. See note 1.
        $ref: "#/definitions/MacAddress"
      segmentationType:
        description: >
          Specifies the encapsulation type for the traffics coming in and out of the trunk subport.
          Permitted values:
          -	VLAN: the subport uses VLAN as encapsulation type.
          -	INHERIT: the subport gets its segmentation type from the network it’s connected to.
          This attribute may be present for CP instances that represent subports in a trunk and shall be
          absent otherwise. If this attribute is not present for a subport CP instance, default value VLAN shall be used.
        type: string
        enum:
            - VLAN
            - INHERIT

      segmentationId:
        description: >
          Identification of the network segment to which the CP instance connects to. See note 3 and note 4.
        type: string
      ipAddresses:
        description: >
          List of IP addresses to assign to the CP instance. Each entry
          represents IP address data for fixed or dynamic IP address
          assignment per subnet.
          If this attribute is not present, no IP address shall be assigned. See note 1.
        type: array
        items:
          type: object
          required:
            - type
          properties:
            type:
              description: >
                The type of the IP addresses.
                Permitted values: IPV4, IPV6.
              type: string
              enum:
                - IPV4
                - IPV6
            fixedAddresses:
              description: >
                Fixed addresses to assign (from the subnet defined by
                "subnetId" if provided). See note 2.
              type: array
              items:
                $ref: "#/definitions/IpAddress"
            numDynamicAddresses:
              description: >
                Number of dynamic addresses to assign (from the subnet defined
                by "subnetId" if provided). See note 2.
              type: integer
            addressRange:
              description: >
                An IP address range to be used, e.g. in case of egress
                connections.
                In case this attribute is present, IP addresses from the range
                will be used. See note 2.
              type: object
              required:
                - minAddress
                - maxAddress
              properties:
                minAddress:
                  description: >
                    Lowest IP address belonging to the range.
                  $ref: "#/definitions/IpAddress"
                maxAddress:
                  description: >
                    Highest IP address belonging to the range.
                  $ref: "#/definitions/IpAddress"
            subnetId:
              description: >
                Subnet defined by the identifier of the subnet resource in the
                VIM.
                In case this attribute is present, IP addresses from that
                subnet will be assigned; otherwise, IP addresses not bound to
                a subnet will be assigned.
              $ref: "#/definitions/IdentifierInVim"

  ExtVirtualLinkData:
    description: >
      This type represents an external VL.

      * NOTE 1:	A link port is not needed for an external CP instance that exposes a VIP CP in the following cases:
                1)  For a VIP CP directly exposed as an extCP:
                    1.1)  No dedicated IP address is allocated as VIP address, as indicated in the VNFD.
                    1.2)  A dedicated IP address is allocated as VIP address, but the NFVO indicates that no port is needed
                          (createExtLinkPort in VnfExtCpConfig set to false).
                2)  For a VIP CP exposed as an extCP via a floating IP address:
                    2.1)  No dedicated IP address is allocated as VIP address, as indicated in the VNFD, and the VNFC CP
                          associated to the VIP CP is also exposed via a floating IP address.
    type: object
    required:
      - id
      - resourceId
      - extCps
    properties:
      id:
        description: >
          The identifier of the external VL instance. The identifier is
          assigned by the NFV-MANO entity that manages this VL instance.
        $ref: "#/definitions/Identifier"
      vimConnectionId:
        description: >
          Identifier of the VIM connection to manage this resource. This
          attribute shall only be supported and present if VNF-related
          resource management in direct mode is applicable. See note 1.
        $ref: "#/definitions/Identifier"
      resourceProviderId:
        description: >
          Identifies the entity responsible for the management of this
          resource. This attribute shall only be supported and present
          if VNF-related resource management in indirect mode is applicable.
          The identification scheme is outside the scope of the present
          document.
        $ref: "#/definitions/Identifier"
      resourceId:
        description: >
          The identifier of the resource in the scope of the VIM or the
          resource provider.
        $ref: "#/definitions/IdentifierInVim"
      extCps:
        description: >
          External CPs of the VNF to be connected to this external VL. Entries in the list of external
          CP data that are unchanged need not be supplied if the ExtVirtualLinkData structure is part
          of a request or response that modifies the external connectivity.
        type: array
        items:
          $ref: "#/definitions/VnfExtCpData"
      extLinkPorts:
        description: >
          Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is 
          not present, the VNFM shall create the link ports on the external VL unless the extCp exposes a VIP CP and a link port is 
          not needed for it based on the conditions defined below. See note.
        type: array
        items:
          $ref: "#/definitions/ExtLinkPortData"

  ScaleInfo:
    description: >
      This type represents the scale level of a VNF instance related to a scaling aspect.
    type: object
    required:
      - aspectId
      - scaleLevel
    properties:
      aspectId:
        description: >
          Identifier of the scaling aspect.
        $ref: "#/definitions/IdentifierInVnfd"
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId
          attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final
          failure).
        $ref: "#/definitions/Identifier"
      scaleToLevel:
        description: >
          Indicates the scale level. The minimum value shall be 0
          and the maximum value shall be ≤ maxScaleLevel as
          described in the VNFD.
        $ref: "#/definitions/Identifier"

  Identifier:
    description: >
      An identifier with the intention of being globally unique.
    type: string

  DateTime:
    description: >
      Date-time stamp.
      Representation: String formatted according to IETF RFC 3339.
    type: string
    format: date-time

  Uri:
    description: >
      String formatted according to IETF RFC 3986.
    type: string

  Boolean:
    description: >
      The Boolean is a data type having two values (true and false).
    type: boolean

  MacAddress:
    description: >
      A MAC address. Representation: string that consists of groups of two hexadecimal digits,
      separated by hyphens or colons.
    type: string
    format: MAC

  IpAddress:
    description: >
      An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal
      integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that
      consists of groups of zero to four hexadecimal digits, separated by colons.
    type: string
    format: IP

  Version:
    description: >
      A version.
    type: string

  String:
    description: >
      A string defined in IETF RFC 8259.
    type: string

  Number:
    description: >
      A number defined in IETF RFC 8259.
    type: number

  UnsignedInt:
    description: >
      Unsigned integer number
    type: integer
    minimum: 0

  IdentifierInVnfd:
    description: >
      An identifier that is unique within a VNF descriptor.
    type: string

  IdentifierInVim:
    description: >
      An identifier maintained by the VIM  or the CISM or other resource provider. It is
      expected to be unique within the VIM instance.
    type: string

  IdentifierInVnf:
    description: >
      An identifier that is unique for the respective type within a VNF
      instance, but may not be globally unique.
    type: string

  IdentifierLocal:
    description: >
      An identifier that is unique within a limited local scope other than above listed identifiers,
      such as within a complex data structure or within a request-response pair.
      Representation: string of variable length.
    type: string

  Checksum: #no definition found
    description: >
      Cheksum description
    type: string

  VnfLinkPortData:
    description: >
      This type represents an externally provided link port to be used to connect a VNFC connection point 
      to an exernally managed VL.
    type: object
    required:
    - vnfLinkPortId
    - resourceHandle
    properties:
      vnfLinkPortId:
        description: >
          Identifier of this link port as provided by the entity that has created the link port.
        $ref: "#/definitions/Identifier"
      resourceHandle:
        description: >
          Resource handle of the virtualised resource that realizes the link port.
        $ref: "#/definitions/ResourceHandle"

  ExtLinkPortData:
    description: >
      This type represents an externally provided link port to be used to
      connect an external connection point to an external VL.
      * NOTE:	The value of "trunkResourceId" is scoped by the value of "vimConnectionId" in the "resourceHandle" attribute.
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
        description: >
          Identifier of this link port as provided by the entity that has
          created the link port.
        $ref: "#/definitions/Identifier"
      resourceHandle:
        description: >
          Reference to the virtualised resource realizing this link port.
        $ref: "#/definitions/ResourceHandle"

      trunkResourceId:
        description: >
          Identifier of the trunk resource in the VIM.
          Shall be present if the present link port corresponds to the parent
          port that the trunk resource is associated with. See note.
        $ref: "#/definitions/IdentifierInVim"

  GrantedLcmOperationType:
    description: >
      The enumeration GrantedLcmOperationType defines the permitted values 
      to represent VNF lifecycle operation types in grant requests.
      Value | Description
      ------|------------
      INSTANTIATE | Represents the "Instantiate VNF" LCM operation.
      SCALE | Represents the "Scale VNF" LCM operation.
      SCALE_TO_LEVEL | Represents the "Scale VNF to Level" LCM operation.
      CHANGE_FLAVOUR | Represents the "Change VNF Flavour" LCM operation.
      TERMINATE | Represents the "Terminate VNF" LCM operation.
      HEAL | Represents the "Heal VNF" LCM operation.
      OPERATE | Represents the "Operate VNF" LCM operation.
      CHANGE_EXT_CONN | Represents the "Change external VNF connectivity" LCM operation.     
      CHANGE_VNFPKG | Represents the "Change current VNF package" LCM operation.
      CREATE_SNAPSHOT | Represents the "Create VNF snapshot" LCM operation.
      REVERT_TO_SNAPSHOT | Represents the "Revert to VNF snapshot" LCM operation.
    type: string
    enum:
      - INSTANTIATE
      - SCALE
      - SCALE_TO_LEVEL
      - CHANGE_FLAVOUR
      - TERMINATE
      - HEAL
      - OPERATE
      - CHANGE_EXT_CONN
      - CHANGE_VNFPKG
      - CREATE_SNAPSHOT
      - REVERT_TO_SNAPSHOT

  LcmOperationType:
    description: >
      The enumeration LcmOpType defines the permitted values to represent 
      VNF lifecycle operation types in VNF lifecycle management operation 
      occurrence resources and VNF lifecycle management operation occurrence 
      notifications.

      Value | Description
      ------|------------
      INSTANTIATE | Represents the "Instantiate VNF" LCM operation.   
      SCALE | Represents the "Scale VNF" LCM operation.
      SCALE_TO_LEVEL | Represents the "Scale VNF to Level" LCM operation.
      CHANGE_FLAVOUR | Represents the "Change VNF Flavour" LCM operation.
      TERMINATE | Represents the "Terminate VNF" LCM operation.
      HEAL | Represents the "Heal VNF" LCM operation.
      OPERATE | Represents the "Operate VNF" LCM operation.
      CHANGE_EXT_CONN | Represents the "Change external VNF connectivity" LCM operation.
      MODIFY_INFO | Represents the "Modify VNF Information" LCM operation.
      CREATE_SNAPSHOT | Represents the "Create VNF Snapshot" LCM operation.
      REVERT_TO_SNAPSHOT | Represents the “Revert-To VNF Snapshot" LCM operation.
      CHANGE_VNFPKG | Represents the "Change current VNF package" LCM operation.
    type: string
    enum:
      - INSTANTIATE
      - SCALE
      - SCALE_TO_LEVEL
      - CHANGE_FLAVOUR
      - TERMINATE
      - HEAL
      - OPERATE
      - CHANGE_EXT_CONN
      - MODIFY_INFO
      - CREATE_SNAPSHOT
      - REVERT_TO_SNAPSHOT
      - CHANGE_VNFPKG

  ProblemDetails:
    #SOL003 location: 4.3.5.3
    description: >
      The definition of the general "ProblemDetails" data structure from
      IETF RFC 7807 is reproduced inthis structure. Compared to the
      general framework defined in IETF RFC 7807, the "status" and
      "detail" attributes are mandated to be included by the present document,
      to ensure that the response contains additional textual information about
      an error. IETF RFC 7807 foresees extensibility of the
      "ProblemDetails" type. It is possible that particular APIs in the present
      document, or particular implementations, define extensions to define
      additional attributes that provide more information about the error.
      The description column only provides some explanation of the meaning to
      Facilitate understanding of the design. For a full description, see
      IETF RFC 7807.
    type: object
    required:
      - status
      - detail
    properties:
      type:
        description: >
          A URI reference according to IETF RFC 3986 that identifies the
          problem type. It is encouraged that the URI provides human-readable
          documentation for the problem (e.g. using HTML) when dereferenced.
          When this member is not present, its value is assumed to be
          "about:blank".
        type: string
        format: URI
      title:
        description: >
          A short, human-readable summary of the problem type. It should not
          change from occurrence to occurrence of the problem, except for
          purposes of localization. If type is given and other than
          "about:blank", this attribute shall also be provided.
          A short, human-readable summary of the problem
          type.  It SHOULD NOT change from occurrence to occurrence of the
          problem, except for purposes of localization (e.g., using
          proactive content negotiation; see [RFC7231], Section 3.4).
        type: string
      status:
        description: >
          The HTTP status code for this occurrence of the problem.
          The HTTP status code ([RFC7231], Section 6) generated by the origin
          server for this occurrence of the problem.
        type: integer
      detail:
        description: >
          A human-readable explanation specific to this occurrence of the
          problem.
        type: string
      instance:
        description: >
          A URI reference that identifies the specific occurrence of the
          problem. It may yield further information if dereferenced.
        type: string
        format: URI
      #TODO: How to express "any additional attributes"?

  SubscriptionAuthentication:
    description: >
      * NOTE: The clientId and clientPassword passed in a subscription shall not be the same as the clientId and
              clientPassword that are used to obtain authorization for API requests. Client credentials may differ between
              subscriptions. The value of clientPassword should be generated by a random process
    type: object
    required:
      - authType
    properties:
      authType:
        description: >
          Defines the types of Authentication / Authorization which the API
          consumer is willing to accept when receiving a notification.
          Permitted values:
          * BASIC: In every HTTP request to the notification endpoint, use
            HTTP Basic authentication with the client credentials. 
          * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the
            notification endpoint, use an OAuth 2.0 Bearer token, obtained
            using the client credentials grant type.
          * TLS_CERT: Every HTTP request to the notification endpoint is sent
            over a mutually authenticated TLS session, i.e. not only the
            server is authenticated, but also the client is authenticated
            during the TLS tunnel setup.
        type: array
        items:
          type: string
          enum:
            - BASIC
            - OAUTH2_CLIENT_CREDENTIALS
            - TLS_CERT
      paramsBasic:
        description: >
          Parameters for authentication/authorization using BASIC.
          Shall be present if authType is "BASIC" and the contained
          information has not been provisioned out of band.
          Shall be absent otherwise.
        type: object
        properties:
          userName:
            description: >
              Username to be used in HTTP Basic authentication. Shall be
              present if it has not been provisioned out of band.
            type: string
          password:
            description: >
              Password to be used in HTTP Basic authentication. Shall be
              present if it has not been provisioned out of band.
            type: string
      paramsOauth2ClientCredentials:
        description: >
          Parameters for authentication/authorization using
          OAUTH2_CLIENT_CREDENTIALS.
          Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the
          contained information has not been provisioned out of band.
          Shall be absent otherwise.
        type: object
        properties:
          clientId:
            description: >
              Client identifier to be used in the access token request of the
              OAuth 2.0 client credentials grant type. 
              Shall be present if it has not been provisioned out of band. See note.
            type: string
          clientPassword:
            description: >
              Client password to be used in the access token request of the
              OAuth 2.0 client credentials grant type. 
              Shall be present if it has not been provisioned out of band. See note.
            type: string
          tokenEndpoint:
            description: >
              The token endpoint from which the access token can be obtained.
              Shall be present if it has not been provisioned out of band.
            $ref: "#/definitions/Uri"
  
  LcmCoordResultType:
    description: >
      The enumeration LcmCoordResultType defines the permitted values
      to represent the result of executing an LCM coordination action.
      The coordination result also implies the action to be performed by
      the VNFM as the follow-up to this coordination.
      Value | Description
      ------|------------
      CONTINUE | The related LCM operation shall be continued, staying in the state "PROCESSING".
      ABORT | The related LCM operation shall be aborted by transitioning into the state "FAILED_TEMP".
      CANCELLED | The coordination action has been cancelled upon request of the API consumer, i.e. the VNFM.
      The related LCM operation shall be aborted by transitioning into the state "FAILED_TEMP".
    type: string
    enum:
      - CONTINUE
      - ABORT
      - CANCELLED

  LcmOperationForCoordType:
    description: >
      The enumeration LcmOperationForCoordType defines the permitted values to
      represent VNF lifecycle operation types in VNF LCM operation coordination actions.
      * INSTANTIATE: Represents the "Instantiate VNF" LCM operation.
      * SCALE: Represents the "Scale VNF" LCM operation.
      * SCALE_TO_LEVEL: Represents the "Scale VNF to Level" LCM operation.
      * CHANGE_FLAVOUR: Represents the "Change VNF Flavour" LCM operation.
      * TERMINATE: Represents the "Terminate VNF" LCM operation.
      * HEAL: Represents the "Heal VNF" LCM operation.
      * OPERATE: Represents the "Operate VNF" LCM operation.
      * CHANGE_EXT_CONN: Represents the "Change external VNF connectivity" LCM operation.
      * MODIFY_INFO: Represents the "Modify VNF Information" LCM operation.
      * CREATE_SNAPSHOT: Represents the "Create VNF Snapshot" LCM operation.
      * REVERT_TO_SNAPSHOT: Represents the "Revert To VNF Snapshot" LCM operation.
      * CHANGE_VNFPKG: Represents the "Change current VNF package" LCM operation.
    type: string
    enum:
      - INSTANTIATE
      - SCALE
      - SCALE_TO_LEVEL
      - CHANGE_FLAVOUR
      - TERMINATE
      - HEAL
      - OPERATE
      - CHANGE_EXT_CONN
      - MODIFY_INFO
      - CREATE_SNAPSHOT
      - REVERT_TO_SNAPSHOT
      - CHANGE_VNFPKG