MecAppSupportApi.json 79.2 KB
Newer Older
Walter Featherstone's avatar
Walter Featherstone committed
          "self": {
        "description": "Self-referring URI."
      },
      "TimingCaps.NtpServers.AuthenticationOption": {
        "title": "TimingCaps.NtpServers.AuthenticationOption",
        "description": "NTP authentication option",
        "examples": [
          "NONE"
        ]
      },
        "title": "TimingCaps.NtpServers.NtpServerAddrType",
        "description": "Address type of NTP server",
        "examples": [
          "IP_ADDRESS"
        ]
        "title": "TimingCaps.NtpServers",
        "required": [
          "ntpServerAddrType",
          "ntpServerAddr",
          "minPollingInterval",
          "maxPollingInterval",
          "localPriority",
          "authenticationOption",
          "authenticationKeyNum"
        ],
        "type": "object",
        "properties": {
          "ntpServerAddrType": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.NtpServerAddrType"
          },
          "ntpServerAddr": {
            "type": "string",
            "description": "NTP server address",
            "examples": [
              "192.0.2.0"
            ]
            "type": "integer",
            "description": "Minimum poll interval for NTP messages, in seconds as a power of two. Range 3...17",
            "contentEncoding": "int32",
            "examples": [
              3
            ]
            "type": "integer",
            "description": "Maximum poll interval for NTP messages, in seconds as a power of two. Range 3...17",
            "contentEncoding": "int32",
            "examples": [
              17
            ]
            "type": "integer",
            "description": "NTP server local priority",
            "contentEncoding": "int32",
            "examples": [
              1
            ]
          },
          "authenticationOption": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.AuthenticationOption"
          },
          "authenticationKeyNum": {
            "type": "integer",
            "description": "Authentication key number",
            "contentEncoding": "int32",
            "examples": [
              1
            ]
        },
        "description": "NTP server detail."
      "TimingCaps_PtpMasters": {
        "title": "TimingCaps_PtpMasters",
        "required": [
          "ptpMasterIpAddress",
          "ptpMasterLocalPriority",
          "delayReqMaxRate"
        ],
        "type": "object",
            "type": "string",
            "description": "PTP Master IP Address",
            "examples": [
              "192.0.2.0"
            ]
            "type": "integer",
            "description": "PTP Master local priority",
            "contentEncoding": "int32",
            "examples": [
              1
            ]
            "type": "integer",
            "description": "Acceptable maximum rate of the Delay_Req messages in packets per second",
            "contentEncoding": "int32",
            "examples": [
              10
            ]
        },
        "description": "NTP server detail."
        "title": "TimingCaps.TimeStamp",
          "seconds",
          "nanoSeconds"
        "type": "object",
        "properties": {
          "seconds": {
            "type": "integer",
            "description": "The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
            "contentEncoding": "int32",
            "examples": [
              1577836800
            ]
          },
          "nanoSeconds": {
            "type": "integer",
            "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
            "contentEncoding": "int32",
            "examples": [
              0
            ]
        },
        "description": "time"
        "title": "TimingCaps",
        "type": "object",
        "properties": {
          "timeStamp": {
            "$ref": "#/components/schemas/TimingCaps.TimeStamp"
          },
          "ntpServers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TimingCaps.NtpServers"
            },
            "description": "Available NTP servers"
              "$ref": "#/components/schemas/TimingCaps_PtpMasters"
            },
            "description": "Available PTP Masters"
        },
        "description": "This type represents the information provided by the MEC platform in response to the Timing capabilities Query message."
        "title": "TrafficFilter",
        "type": "object",
        "properties": {
          "srcAddress": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "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": "string"
            },
            "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": "string"
            },
            "description": "A port or a range of ports"
              "type": "string"
            },
            "description": "A port or a range of ports"
              "type": "string"
            },
            "description": "Specify the protocol of the traffic filter"
              "type": "string"
            },
            "description": "Used for token based traffic rule"
              "type": "string"
            },
            "description": "Used for GTP tunnel based traffic rule"
              "type": "string"
            },
            "description": "Used for GTP tunnel based traffic rule"
              "type": "string"
            },
            "description": "Used for GTP tunnel based traffic rule"
              "type": "string"
            },
            "description": "Used for GTP tunnel based traffic rule"
            "type": "integer",
            "description": "Used to match all packets that have the same Quality Class Indicator (QCI).",
            "contentEncoding": "int32",
            "examples": [
              1
            ]
            "type": "integer",
            "description": "Used to match all IPv4 packets that have the same Differentiated Services Code Point (DSCP)",
            "contentEncoding": "int32",
            "examples": [
              0
            ]
            "type": "integer",
            "description": "Used to match all IPv6 packets that have the same Traffic Class.",
            "contentEncoding": "int32",
            "examples": [
              1
            ]
        },
        "description": "This type represents the traffic filter."
        "title": "TrafficRule.Action",
Walter Featherstone's avatar
Walter Featherstone committed
          "FORWARD_ENCAPSULATED",
Walter Featherstone's avatar
Walter Featherstone committed
          "DUPLICATE_ENCAPSULATED"
        "type": "string",
        "description": "The action of the MEC host data plane when a packet matches the trafficFilter",
        "examples": [
          "DROP"
        ]
        "title": "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",
        "examples": [
          "FLOW"
        ]
        "title": "TrafficRule.State",
        "type": "string",
        "description": "Contains the traffic rule state. This attribute may be updated using HTTP PUT method",
        "examples": [
          "ACTIVE"
        ]
        "title": "TrafficRule",
        "required": [
          "trafficRuleId",
          "filterType",
          "priority",
          "trafficFilter",
          "action",
          "state"
        ],
        "type": "object",
            "type": "string",
            "description": "Identify the traffic rule.",
            "examples": [
              "TrafficRule1"
            ]
          },
          "filterType": {
            "$ref": "#/components/schemas/TrafficRule.FilterType"
          },
          "priority": {
            "type": "integer",
            "description": "Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence",
            "contentEncoding": "int32",
            "examples": [
              1
            ]
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter"
            },
            "description": ""
          },
          "action": {
            "$ref": "#/components/schemas/TrafficRule.Action"
          },
          "dstInterface": {
            "$ref": "#/components/schemas/DestinationInterface"
          },
          "state": {
            "$ref": "#/components/schemas/TrafficRule.State"
          }
        },
        "description": "This type represents the general information of a traffic rule."
        "title": "TunnelInfo.TunnelType",
        "type": "string",
        "description": "This type represents the tunnel information.",
        "examples": [
          "GTP_U"
        ]
        "title": "TunnelInfo",
        "type": "object",
        "properties": {
          "tunnelType": {
            "$ref": "#/components/schemas/TunnelInfo.TunnelType"
          },
          "tunnelDstAddress": {
            "type": "string",
            "description": "Destination address of the tunnel",
            "examples": [
              "?"
            ]
            "type": "string",
            "description": "Source address of the tunnel",
            "examples": [
              "?"
            ]
        "description": "This type represents the tunnel information."
      "TimeSourceStatus": {
        "title": "TimeSourceStatus",
        "enum": [
          "TRACEABLE",
          "NONTRACEABLE"
        ],
        "type": "string",
        "description": "Platform Time Source status. 1 = TRACEABLE - time source is locked to the UTC time source. 2 = NONTRACEABLE - time source is not locked to the UTC time source",
        "examples": [
          "TRACEABLE"
        ]
      }
    },
    "requestBodies": {
      "AppTerminationNotification": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AppTerminationNotification"
            }
          }
Walter Featherstone's avatar
Walter Featherstone committed
        },
        "required": true
  },
  "security": [
    {}
  ]