MEC010-2_AppPkgMgmt.yaml

      type: object
      required:
        - self
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
    AppPkgSubscriptionLinkList:
      description: >-
        'The data type represents a subscription link list of notification on application package management'
      type: object
      required:
        - _links
      properties:
        _links:
          $ref: '#/components/schemas/AppPkgSubscriptionLinkList.links'
    AppPkgSubscriptionLinkList.links:
      description: >- 
        Links to resources related to this resource.
      type: object
      required:
        - self
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/Subscriptions.AppPkgSubscription'
    Subscriptions.AppPkgSubscription:
      description: >-
        'The data type represents the input parameters of "subscription operation" to notification of application package management for the onboarding, or operational state change of application package.'
      type: object
      required:
        - href
        - subsctiptionType
      properties:
        href:
          $ref: '#/components/schemas/Href'
        subsctiptionType:
          $ref: '#/components/schemas/SubsctiptionType.AppPkg'
    Href:
      description: >-
        The URI referring to the subscription.
      type: string
      format: uri 
    AppPkgSubscription:
      description: >-
        'The data type represents the input parameters of "subscription operation" to notification of application package management for the onboarding, or operational state change of application package.'
      type: object
      required:
        - callbackUri
        - subsctiptionType
      properties:
        callbackUri:
          $ref: '#/components/schemas/CallbackUri'
        subsctiptionType:
          $ref: '#/components/schemas/SubsctiptionType.AppPkg' 
        appPkgFilter:
          type: array
          items:
            $ref: '#/components/schemas/AppPkgFilter'
    SubsctiptionType.AppPkg:
      description: >-
        'Subscribed notification type'
      type: string
      enum:
        - AppPackageOnBoarding
        - AppPacakgeOperationChange
        - AppPackageDeletion
    AppPkgFilter:
      type: string
      description: >-
        The attribute-based filter is to filter application packages on which the query applies.
    ChangeAppInstanceStateOpConfig:
      description: NFV
      type: string
    Checksum:
      description: ''
      properties:
        algorithm:
          $ref: '#/components/schemas/Algorithm'
        hash:
          $ref: '#/components/schemas/Hash'
      required:
      - algorithm
      - hash
      type: object
    CreateAppPkg:
      properties:
        appPkgName:
          description: Name of the application package to be onboarded.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        appPkgPath:
          # description': Address information of the application package. See note.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Uri
          $ref: '#/components/schemas/URI'
        appPkgVersion:
          description: 'Version of the application package to be onboarded.

            The appPkgName with appPkgVersion can be used to uniquely identify the application package.'
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        appProvider:
          description: The provider's name of the application package to be onboarded.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        checksum:
          # description': Checksum of the onboarded application package.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Checksum
          $ref: '#/components/schemas/Checksum'
        userDefinedData:
          #description: User defined data for the application package.
          #type: object
          #x-etsi-mec-cardinality: 0..1
          #x-etsi-mec-origin-type: KeyValuePair
          $ref: '#/components/schemas/KeyValuePairs'
      required:
      - appPkgName
      - appPkgVersion
      - checksum
      - appPkgPath
      type: object
      x-etsi-notes: "NOTE:\tIt is for further study how to convey appPkgPath, and align with ETSI GS NFV-SOL 005 [i.7]."
      x-etsi-ref: 6.2.3.2
    DNSRuleDescriptor:
      properties:
        dnsRuleId:
          description: Identifies the DNS Rule
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        domainName:
          description: FQDN of the DNS rule
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        ipAddress:
          description: IP address given by the DNS rule
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        ipAddressType:
          #description: 'Specifies the IP address type, value: IP_V6, IP_V4'
          #type: string
          #x-etsi-mec-cardinality: '1'
          $ref: '#/components/schemas/IpAddressType'
        ttl:
          description: Time-to-live value
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Int
      required:
      - dnsRuleId
      - domainName
      - ipAddressType
      - ipAddress
      type: object
      x-etsi-ref: 6.2.1.13
    IpAddressType:
      description: 'Specifies the IP address type'
      type: string
      enum:
        - IP_V6
        - IP_V4      
    FeatureDependency:
      properties:
        featureName:
          description: The name of the feature, for example, UserApps, UEIdentity, etc.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        version:
          description: The version of the feature.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - featureName
      - version
      type: object
      x-etsi-ref: 6.2.1.8
    Hash:
      description: '''String 1 The hexadecimal value of the checksum'''
      type: string
    InterfaceDescriptor:
      properties:
        dstIPAddress:
          description: If the interface type is IP, the destination address identifies the IP address of the destination. Only used for dstInterface.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        dstMACAddress:
          description: If the interface type is MAC, the destination address identifies the MAC address of the destination. Only used for dstInterface.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        interfaceType:
          #description: 'Type of interface: TUNNEL, MAC, IP, etc.'
          $ref: '#/components/schemas/InterfaceType'
          #x-etsi-mec-cardinality: '1'
        srcMACAddress:
          description: If the interface type is MAC, the source address identifies the MAC address of the interface.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        tunnelInfo:
          # description': Included only if the destination address type is tunnel.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TunnelInfo
          $ref: '#/components/schemas/TunnelInfo'
      required:
      - interfaceType
      type: object
      x-etsi-ref: 6.2.1.11
    InterfaceType:
      description: 'Type of interface.'
      type: string
      enum:
        - TUNNEL
        - MAC
        - IP      
    LatencyDescriptor:
      properties:
        maxLatency:
          description: The value of the maximum latency in nano seconds tolerated by the MEC application. See note.
          format: Uint32
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
      required:
      - maxLatency
      type: object
      x-etsi-notes: "NOTE:\tThe latency is considered to be the one way end-to-end latency between the client application (e.g. in a device) and the service (i.e. the MEC Application instance)."
      x-etsi-ref: 6.2.1.14
    LinkType:
      properties:
        href:
          description: URI referring to a resource
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
      required:
      - href
      type: object
      x-etsi-ref: 6.5.2
    ProblemDetails:
      properties:
        detail:
          description: A human-readable explanation specific to this occurrence of the problem
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        instance:
          description: A URI reference that identifies the specific occurrence of the problem
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        status:
          description: The HTTP status code for this occurrence of the problem
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        title:
          description: A short, human-readable summary of the problem type
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        type:
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
      type: object
    SerializerTypes:
      type: string
    ServiceDependency:
      properties:
        requestedPermissions:
          description: 'Requested permissions regarding the access of the application to the service. See clause 8.2 of ETSI GS MEC 009 [4].

            The format of this attribute is left for the data model design stage.'
          items:
            $ref: '#/components/schemas/Not_specified'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Not_specified
        serCategory:
          # description': A Category reference of the service.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': CategoryRef
          $ref: '#/components/schemas/CategoryRef'
        serName:
          description: The name of the service, for example, RNIS, LocationService, etc.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        serTransportDependencies:
          description: Indicates transport and serialization format dependencies of consuming the service. Defaults to REST + JSON if absent. See note.
          items:
            $ref: '#/components/schemas/TransportDependency'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: TransportDependency
        version:
          description: The version of the service.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - serName
      - version
      type: object
      x-etsi-notes: "NOTE:\tThis attribute indicates groups of transport bindings that a service-consuming MEC application supports for the consumption of the MEC service defined by this ServiceDependency structure. If at least one of the indicated groups is supported by the service it may be consumed by the application."
      x-etsi-ref: 6.2.1.17
    ServiceDescriptor:
      description: >-
        'The ServiceDescriptor data type describes a MEC service produced by a service-providing MEC application.'
      type: object
      required:
        - serName
        - version
      properties:
        serName:
          $ref: '#/components/schemas/SerName'
        serCategory:
          $ref: '#/components/schemas/CategoryRef'
        version:
          $ref: '#/components/schemas/SerVersion'
        transportsSupported:
          $ref: '#/components/schemas/TransportsSupported'
    SerName:
      description: 'The name of the service, for example, RNIS, LocationService, etc.'
      type: string
    SerVersion:
      description: The version of the service.
      type: string
    TransportsSupported:
      description: >-
        'Indicates transports and serialization formats supported made available to the service-consuming application. Defaults to REST + JSON if absent.'
      type: object
      required:
        - featureName
        - version
      properties:
        transport:
          $ref: '#/components/schemas/TransportDescriptor'
        serializers:
          $ref: '#/components/schemas/Serializers'
    Serializers:
      description: >-
        'Information about the serializers in this binding, as defined in the SerializerTypes type in ETSI GS MEC 011 '
      type: array
      minItems: 1
      items:
          $ref: '#/components/schemas/SerializerTypes'          
    SwImageDescriptor:
      description: Ref NFV
      type: string
    TerminateAppInstanceOpConfig:
      description: NFV
      type: string
      x-etsi-ref: 6.2.2.9
    TimeStamp:
      properties:
        nanoSeconds:
          description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
          format: Uint32
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
        seconds:
          description: "The seconds part of the Time. Time is defined as Unix-time since January\_1, 1970, 00:00:00 UTC."
          format: Uint32
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
      required:
      - seconds
      - nanoSeconds
      type: object
      x-etsi-ref: 6.2.5.4
    TrafficFilter:
      properties:
        dSCP:
          description: Used to match all IPv4 packets that have the same DSCP.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Int
        dstAddress:
          description: 'A IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.'
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        dstPort:
          description: A port or a range of ports.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        dstTunnelPort:
          description: Used for GTP tunnel based traffic rule.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        protocol:
          description: Specify the protocol of the traffic filter.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        qCI:
          description: Used to match all packets that have the same QCI.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Int
        srcAddress:
          description: 'An IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.'
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        srcPort:
          description: A port or a range of ports.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        srcTunnelAddress:
          description: Used for GTP tunnel based traffic rule.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        srcTunnelPort:
          description: Used for GTP tunnel based traffic rule.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        tC:
          description: Used to match all IPv6 packets that have the same TC.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Int
        tag:
          description: Used for tag based traffic rule.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        tgtTunnelAddress:
          description: Used for GTP tunnel based traffic rule.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
      type: object
      x-etsi-ref: 6.2.1.10
    TrafficRuleDescriptor:
      properties:
        action:
          #description: 'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter, the example actions includes: DROP, FORWARD_DECAPSULATED, FORWARD_AS_IS, PASSTHROUGH, DUPLICATED_DECAPSULATED, DUPLICATE_AS_IS.'
         # type: string
          #x-etsi-mec-cardinality: '1'
          $ref: '#/components/schemas/Action'
        dstInterface:
          # description': Describes the destination interface information, if the action is FORWARD. Some applications (e.g. inline/tap) require two interfaces, where the first is on the UE side and the second is on the EPC side.
          # x-etsi-mec-cardinality': 0..2
          # x-etsi-mec-origin-type': InterfaceDescriptor
          type: array
          minItems: 0
          maxItems: 2
          items:
           $ref: '#/components/schemas/InterfaceDescriptor'
        filterType:
          #description: 'Definition of filter type: per FLOW or PACKET If it is per FLOW, the filter matches UE->EPC packets and the reverse packets are handled by the same context.'
          #x-etsi-mec-cardinality: '1'
          $ref: '#/components/schemas/FilterType'
        priority:
          description: Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence.
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Int
        trafficFilter:
          description: The filter used to identify specific flow/packets that need to be handled by the MEC host.
          items:
            $ref: '#/components/schemas/TrafficFilter'
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: TrafficFilter
        trafficRuleId:
          description: Identifies the traffic rule.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - trafficRuleId
      - filterType
      - priority
      - trafficFilter
      - action
      type: object
      x-etsi-ref: 6.2.1.9
    Action:
      description: >-
        'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter.'
      type: string
      enum:
        - DROP
        - FORWARD_DECAPSULATED
        - FORWARD_AS_IS
        - PASSTHROUGH
        - DUPLICATED_DECAPSULATED
        - DUPLICATE_AS_IS      
    FilterType:
      description: 'Definition of filter type: per FLOW or PACKET'
      type: string
      enum:
        - FLOW 
        - PACKET      
    TransportDependency:
      properties:
        labels:
          description: Set of labels that allow to define groups of transport bindings. The mechanism of the grouping is defined below this table.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        serializers:
          description: Information about the serializers in this transport binding, as defined in the SerializerTypes type in ETSI GS MEC 011 [i.4]. Support for at least one of the entries is required in conjunction with the transport.
          items:
            $ref: '#/components/schemas/SerializerTypes'
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: SerializerTypes
        transport:
          # description': Information about the transport in this transport binding.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TransportDescriptor
          $ref: '#/components/schemas/TransportDescriptor'
      required:
      - transport
      - serializers
      - labels
      type: object
      x-etsi-ref: 6.2.1.18
    TransportDescriptor:
      properties:
        protocol:
          description: The name of the protocol used. Shall be set to HTTP for a REST API.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        security:
          # description': Information about the security used by the transport in ETSI GS MEC 011 [i.4].
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': SecurityInfo
          $ref: '#/components/schemas/SecurityInfo'
        type:
          # description': Type of the transport, as defined in the TransportTypes type in ETSI GS MEC 011 [i.4].
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': TransportTypes
          $ref: '#/components/schemas/TransportTypes'
        version:
          description: The version of the protocol used.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - type
      - protocol
      - version
      - security
      type: object
      x-etsi-ref: 6.2.1.19
    TransportTypes:
      type: string
    TunnelInfo:
      properties:
        tunnelDstAddress:
          description: Destination address of the tunnel.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        tunnelSpecificData:
          #description: Parameters specific to the tunnel.
          #type: object
          #x-etsi-mec-cardinality: 0..1
          #x-etsi-mec-origin-type: Not_specified
          $ref: '#/components/schemas/Not_specified'
        tunnelSrcAddress:
          description: Source address of the tunnel.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        tunnelType:
          #description: 'Type of tunnel: GTP-U, GRE, etc.'
          $ref: '#/components/schemas/TunnelType'
          #x-etsi-mec-cardinality: '1'
      required:
      - tunnelType
      - tunnelDstAddress
      - tunnelSrcAddress
      type: object
      x-etsi-ref: 6.2.1.12
    TunnelType:
      description: 'Type of tunnel.'
      type: string
      enum:
        - GTP-U
        - GRE      
    VirtualComputeDescription:
      description: Ref NFV
      type: string
    VirtualNetworkInterfaceRequirements:
      type: string
    VirtualStorageDescriptor:
      description: Ref NFV
      type: string
    SecurityInfo: 
      description: 'See MEC011'    
    CategoryRef:
      description: 'See MEC011'
    URI:
      type: string
    Not_specified:
      type: string
      
  responses:
    204:
      description: No Content
    206:
      description: Partial content    
    400:
      description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
      content:
        application/json:
          schema:
           $ref: '#/components/schemas/ProblemDetails'
    401:
      description: 'Unauthorized :  used when the client did not submit credentials.'
      content:
        application/json:
          schema:
           $ref: '#/components/schemas/ProblemDetails'
    403:
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
        application/json:
          schema:
           $ref: '#/components/schemas/ProblemDetails'
    404:
      description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
        application/json:
          schema:
           $ref: '#/components/schemas/ProblemDetails'
    406:
      description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
      content:
        application/json:
          schema:
           $ref: '#/components/schemas/ProblemDetails'
    409:
      description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
      content:
        application/json:
          schema:
           $ref: '#/components/schemas/ProblemDetails'
    412:
      description: 'Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT'
      content:
        application/json:
          schema:
           $ref: '#/components/schemas/ProblemDetails'
    414:
      description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.'
      content:
        application/json:
          schema:
           $ref: '#/components/schemas/ProblemDetails'
    415:
      description: 'Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.'
      content:
        application/json:
          schema:
           $ref: '#/components/schemas/ProblemDetails'
                
    416:
      description: 'Range Not Satisfiable .'               
    422:
      description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.'
      content:
        application/json:
          schema:
           $ref: '#/components/schemas/ProblemDetails'
          example:
            application/problem+json:
              problemDetails:
                type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets'
                title: Too many targets
                status: '422'
                detail: The target area for the request is considered too large
                instance: /meAppClient.example.com/77777/msgs/abc
    429:
      description: 'Too Many Requests : used when a rate limiter has triggered.'
      content:
        application/json:
          schema:
           $ref: '#/components/schemas/ProblemDetails'
    AppPkgContent.200:
      description: The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD.