Mp1.yaml 44.2 KB
Newer Older
        type: integer
        format: uint32
        description: 'The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC'
        example: 0
  TimingCaps:
    description: This type represents the information provided by the mobile edge platform in response to the Timing capabilities Query message.
    type: object
    properties:
      timeStamp:
        $ref: '#/definitions/TimingCaps.TimeStamp'
      ntpServers:
        description: Available NTP servers
        type: array
        items:
          $ref: '#/definitions/TimingCaps.NtpServers'
      ptpMasters:
        description: Available PTP Masters
        type: array
        items:
          $ref: '#/definitions/TimingCaps.PtpMasters'
  TrafficFilter.Address:
    description: Identify the traffic rule.
    type: string
    example: TrafficRule1
  TrafficFilter.DSCP:
    description: Used to match all IPv4 packets that have the same Differentiated Services Code Point (DSCP)
    type: integer
    format: uint32
    example: 0
  TrafficFilter.Port:
    description: A port
    type: string
    example: '8080'
  TrafficFilter.Protocol:
    description: Protocol of the traffic filter
    type: string
    example: '?'
  TrafficFilter.QCI:
    description: Used to match all packets that have the same Quality Class Indicator (QCI).
    type: integer
    format: uint32
    example: 1
  TrafficFilter.TC:
    description: Used to match all IPv6 packets that have the same Traffic Class.
    type: integer
    format: uint32
    example: 1
  TrafficFilter.Token:
    description: Used for token based traffic rule
    type: string
    example: '?'
  TrafficFilter.TunnelAddress:
    description: Used for GTP tunnel based traffic rule
    type: string
    example: '?'
  TrafficFilter.TunnelPort:
    description: Used for GTP tunnel based traffic rule
    type: string
    example: '?'
  TrafficFilter:
    description: This type represents the traffic filter.
    type: object
    properties:
      srcAddress:
        description: 'An IP address or a range of IP address. 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.'
        type: array
        items:
          $ref: '#/definitions/TrafficFilter.Address'
      dstAddress:
        description: 'An IP address or a range of IP address. 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.'
        type: array
        items:
          $ref: '#/definitions/TrafficFilter.Address'
      srcPort:
        description: A port or a range of ports
        type: array
        items:
          $ref: '#/definitions/TrafficFilter.Port'
      dstPort:
        description: A port or a range of ports
        type: array
        items:
          $ref: '#/definitions/TrafficFilter.Port'
      protocol:
        description: Specify the protocol of the traffic filter
        type: array
        items:
          $ref: '#/definitions/TrafficFilter.Protocol'
      token:
        description: Used for token based traffic rule
        type: array
        items:
          $ref: '#/definitions/TrafficFilter.Token'
      srcTunnelAddress:
        description: Used for GTP tunnel based traffic rule
        type: array
        items:
          $ref: '#/definitions/TrafficFilter.TunnelAddress'
      tgtTunnelAddress:
        description: Used for GTP tunnel based traffic rule
        type: array
        items:
          $ref: '#/definitions/TrafficFilter.TunnelAddress'
      srcTunnelPort:
        description: Used for GTP tunnel based traffic rule
        type: array
        items:
          $ref: '#/definitions/TrafficFilter.TunnelPort'
      dstTunnelPort:
        description: Used for GTP tunnel based traffic rule
        type: array
        items:
          $ref: '#/definitions/TrafficFilter.TunnelPort'
      qCI:
        $ref: '#/definitions/TrafficFilter.QCI'
      dSCP:
        $ref: '#/definitions/TrafficFilter.DSCP'
      tC:
        $ref: '#/definitions/TrafficFilter.TC'
  TrafficRule.Action:
    description: The action of the ME host data plane when a packet matches the trafficFilter
    type: string
    enum:
      - DROP
      - FORWARD_DECAPSULATED
      - FORWARD_AS_IS
      - PASSTHROUGH
      - DUPLICATE_DECAPSULATED
      - DUPLICATE_AS_IS
    example: DROP
  TrafficRule.FilterType:
    description: Definition of filter per FLOW or PACKET. If flow the filter match UE->EPC packet and the reverse packet is handled in the same context
    type: string
    enum:
      - FLOW
      - PACKET
    example: FLOW
  TrafficRule.Id:
    description: Identify the traffic rule.
    type: string
    example: TrafficRule1
  TrafficRule.Priority:
    description: 'Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence'
    type: integer
    format: uint32
    example: 1
  TrafficRule.State:
    description: Contains the traffic rule state
    type: string
    enum:
      - ACTIVE
      - INACTIVE
    example: ACTIVE
  TrafficRule:
    description: This type represents the general information of a traffic rule.
    type: object
    required:
      - trafficRuleId
      - filterType
      - priority
      - trafficFilter
      - action
      - state
    properties:
      trafficRuleId:
        $ref: '#/definitions/TrafficRule.Id'
      filterType:
        $ref: '#/definitions/TrafficRule.FilterType'
      priority:
        $ref: '#/definitions/TrafficRule.Priority'
      trafficFilter:
        $ref: '#/definitions/TrafficFilter'
      action:
        $ref: '#/definitions/TrafficRule.Action'
      dstInterface:
        $ref: '#/definitions/DestinationInterface'
      state:
        $ref: '#/definitions/TrafficRule.State'
  TransportInfo.Description:
    description: Human-readable description of this transport
    type: string
    example: REST API
  TransportInfo.Id:
    description: The identifier of this transport
    type: string
    example: TransId12345
  TransportInfo.ImplSpecificInfo:
    description: Additional implementation specific details of the transport
    type: object
  TransportInfo.Name:
    description: The name of this transport
    type: string
    example: REST
  TransportInfo.Protocol:
    description: The name of the protocol used. Shall be set to HTTP for a REST API.
    type: string
    example: HTTP
  TransportInfo.Version:
    description: The version of the protocol used
    type: string
    example: '2.0'
  TransportInfo:
    description: This type represents the general information of a mobile edge service.
    type: object
    required:
      - id
      - name
      - type
      - protocol
      - version
      - endpoint
      - mp1.security
    properties:
      id:
        $ref: '#/definitions/TransportInfo.Id'
      name:
        $ref: '#/definitions/TransportInfo.Name'
      description:
        $ref: '#/definitions/TransportInfo.Description'
      type:
        $ref: '#/definitions/TransportTypes'
      protocol:
        $ref: '#/definitions/TransportInfo.Protocol'
      version:
        $ref: '#/definitions/TransportInfo.Version'
      endpoint:
        $ref: '#/definitions/EndPointInfo'
      mp1.security:
        $ref: '#/definitions/SecurityInfo'
      implSpecificInfo:
        $ref: '#/definitions/TransportInfo.ImplSpecificInfo'
  TransportTypes:
    description: The enumeration TransportTypes represents types of transports
    type: string
    enum:
      - REST_HTTP
      - MB_TOPIC_BASED
      - MB_ROUTING
      - MB_PUBSUB
      - RPC
      - RPC_STREAMING
      - WEBSOCKET
    example: JSON
  TunnelInfo.TunnelDstAddress:
    description: Destination address of the tunnel
    type: string
    example: '?'
  TunnelInfo.TunnelSrcAddress:
    description: Source address of the tunnel
    type: string
    example: '?'
  TunnelInfo.TunnelType:
    description: This type represents the tunnel information.
    type: string
    enum:
      - GTP_U
      - GRE
    example: GTP_U
  TunnelInfo:
    description: This type represents the tunnel information.
    type: object
    required:
      - tunnelType
    properties:
      tunnelType:
        $ref: '#/definitions/TunnelInfo.TunnelType'
      tunnelDstAddress:
        $ref: '#/definitions/TunnelInfo.TunnelDstAddress'
      tunnelSrcAddress:
        $ref: '#/definitions/TunnelInfo.TunnelSrcAddress'