SOL002_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

  CertificateConfigurationData:
    description: >
      This type provides input information related to certificate management.
    type: object
    properties:
      overridingCertificateProfile:
        description: >
          Overriding certificate profile. This overrides the certificateBaseProfile provided
          in the VNFD, and the CA and CMF can additionally override aspects of this certificateBaseProfile
          at later point in the VNF lifecycle if necessary to meet operator security policy.
        type: array
        items:
          $ref: '#/definitions/CertificateBaseProfile'
      securityPolicy:
        description: >
          Security policy to be satisfied for certificate.
        type: array
        items:
          $ref: '#/definitions/SecurityPolicy'      
      cmfData:
        description: >
          Information for CMF.
        $ref: '#/definitions/CmfData'

  CmfData:
    description: >
      This type provides input information related to CMF for certificate management.
    type: object
    required:
      - endPoint
      - supportedProtocol
    properties:
      endPoint:
        description: >
          End point of CMF instance.
        type: object
        properties:
          ipAddress:
            $ref: '#/definitions/IpAddress'
            description: >
              An IP address of this end point.
          link:
            $ref: '#/definitions/Link'
            description: >
              A link to this end point.
      supportedProtocol:
        description: >
          Supported protocols by CMF instance.
        type: array
        items:
          type: string
          enum:
            - CMP
            - CMPv2
            - EST
            - SCEP

  PaasServiceHandle:
    description: >
      This type provides information enabling the access and use of the PaaS Service by the 
      VNF instance. The type and format of the handle depends on the form that the
      PaaS Service is formed.
    type: object
    required:
      - id
    properties:
      id:
        type: string
        description: >
          Identifier of this PaaS Service handle.
        $ref: "#/definitions/Identifier"
      interfaceInfo:
        description: >
          Information of the interface or interfaces to the PaaS Service
          instance, if applicable, such as the URI of an interface endpoint to communicate
          with the PaaS Service instance.
        $ref: "#/definitions/KeyValuePairs"
      accessInfo:
        description: >
          Authentication credentials for accessing the PaaS Service instance.
          If the PaasServiceHandle structure is part of an HTTP GET response
          payload body, sensitive attributes that are children of this attribute
          (such as passwords) shall not be included.
        $ref: "#/definitions/KeyValuePairs"
      extra:
        description: >
          PaaS Service instance specific additional information. The applicable
          structure, and whether or not this attribute is available, is dependent
          on the type of the PaaS Service.
        $ref: "#/definitions/KeyValuePairs"

  CmfInfo:
    type: object
    required:
      - id
      - endPoint
      - supportedProtocol
    properties:
      id:
        type: string
        description: >
          Identifier of this CMF information.
        $ref: "#/definitions/Identifier"
      endPoint:
        description: >
          End point of CMF instance.
        type: object
        properties:
          ipAddress:
            description: >
              An IP address of this end point.
            $ref: '#/definitions/IpAddress'
          link:
            description: >
              A link to this end point.
            $ref: '#/definitions/Link'
      supportedProtocols:
        description: >
          Supported protocol by CMF instance.
        type: array
        items:
          type: string
          enum:
            - CMP
            - CMPv2
            - EST
            - SCEP
      certificateChain:
        description: >
          Certificate chain that this CMF provides.
        type: array
        items:
          $ref: '#/definitions/KeyValuePairs'

  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: