Mp1.json 165 KB
Newer Older
      ],
      "properties": {
        "oAuth2Info": {
          "$ref": "#/definitions/SecurityInfo.OAuth2Info"
        }
      }
    },
    "Self": {
      "description": "Self-referring URI.",
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "$ref": "#/definitions/LinkType"
        }
    },
    "SerAvailabilityNotificationSubscription.CallbackReference": {
      "description": "URI selected by the mobile edge application instance to receive notifications on the subscribed mobile edge service availability information. This shall be included in both the request and the response.",
      "type": "string",
      "format": "uri"
    },
    "SerAvailabilityNotificationSubscription": {
2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556
      "description": "This type represents a subscription to the notifications from the mobile edge platform regarding the availability of a mobile edge service or a list of mobile edge services.",
      "type": "object",
      "required": [
        "subscriptionType",
        "callbackReference",
        "_links",
        "filteringCriteria"
      ],
      "properties": {
        "subscriptionType": {
          "$ref": "#/definitions/SerAvailabilityNotificationSubscription.SubscriptionType"
        },
        "callbackReference": {
          "$ref": "#/definitions/SerAvailabilityNotificationSubscription.CallbackReference"
        },
        "_links": {
          "$ref": "#/definitions/Self"
        },
        "filteringCriteria": {
          "$ref": "#/definitions/ServiceInfo"
        }
      }
    },
    "SerAvailabilityNotificationSubscription.SubscriptionType": {
      "description": "Shall be set to SerAvailabilityNotificationSubscription.",
      "type": "string",
      "example": "SerAvailabilityNotificationSubscription"
    },
    "SerializerTypes": {
      "description": "The enumeration SerializerTypes represents types of serializers",
      "type": "string",
      "enum": [
        "JSON",
        "XML",
        "PROTOBUF3"
      ],
      "example": "JSON"
    },
    "ServiceInfo.SerInstanceId": {
      "description": "Identifier of the service instance assigned by the MEPM / mobile edge platform.",
      "type": "string",
      "example": "ServiceInstance123"
    },
    "ServiceInfo.SerName": {
      "description": "The name of the service. This is how the service producing mobile edge application identifies the service instance it produces.",
      "type": "string",
      "example": "ExampleService"
    },
    "ServiceInfo.State": {
      "description": "Contains the state",
      "type": "string",
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "example": "ACTIVE"
    },
    "ServiceInfo.TransportId": {
      "description": "Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the \"Transport information query\" procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.",
      "type": "string",
      "example": "Rest1"
    },
    "ServiceInfo.Version": {
      "description": "Service version",
      "type": "string",
      "example": "ServiceVersion1"
    },
    "ServiceInfo": {
      "description": "This type represents the general information of a mobile edge service.",
      "type": "object",
      "required": [
        "serName",
        "version",
        "state",
        "serializer"
      ],
      "properties": {
        "serInstanceId": {
          "$ref": "#/definitions/ServiceInfo.SerInstanceId"
        },
        "serName": {
          "$ref": "#/definitions/ServiceInfo.SerName"
        },
        "serCategory": {
          "$ref": "#/definitions/CategoryRef"
        },
        "version": {
          "$ref": "#/definitions/ServiceInfo.Version"
        },
        "state": {
          "$ref": "#/definitions/ServiceInfo.State"
        },
        "transportId": {
          "$ref": "#/definitions/ServiceInfo.TransportId"
        },
        "transportInfo": {
          "$ref": "#/definitions/TransportInfo"
        },
        "serializer": {
          "$ref": "#/definitions/SerializerTypes"
        }
      }
    },
    "Subscription": {
      "description": "A link to the related subscription",
      "type": "object",
      "required": [
        "subscription"
      ],
      "properties": {
        "subscription": {
          "$ref": "#/definitions/LinkType"
        }
      }
    },
    "TimingCaps.NtpServers.AuthenticationKeyNum": {
      "description": "Authentication key number",
      "type": "integer",
      "format": "uint32",
      "example": 1
    },
    "TimingCaps.NtpServers.AuthenticationOption": {
      "description": "NTP authentication option",
      "type": "string",
      "enum": [
        "NONE",
        "SYMMETRIC_KEY",
        "AUTO_KEY"
      ],
      "example": "NONE"
    },
    "TimingCaps.NtpServers.DelayReqMaxRate": {
      "description": "Acceptable maximum rate of the Delay_Req messages in packets per second",
      "type": "integer",
      "format": "uint32",
      "example": 10
    },
    "TimingCaps.NtpServers.LocalPriority": {
      "description": "NTP server local priority",
      "type": "integer",
      "format": "uint32",
      "example": 1
    },
    "TimingCaps.NtpServers.MaxPollingInterval": {
      "description": "Maximum poll interval for NTP messages, in seconds as a power of two. Range 3...17",
      "type": "integer",
      "format": "uint32",
      "example": 17
    },
    "TimingCaps.NtpServers.MinPollingInterval": {
      "description": "Minimum poll interval for NTP messages, in seconds as a power of two. Range 3...17",
      "type": "integer",
      "format": "uint32",
      "example": 3
    },
    "TimingCaps.NtpServers.NtpServerAddr": {
      "description": "NTP server address",
      "type": "string",
      "example": "192.0.2.0"
    },
    "TimingCaps.NtpServers.NtpServerAddrType": {
      "description": "Address type of NTP server",
      "type": "string",
      "enum": [
        "IP_ADDRESS",
        "DNS_NAME"
      ],
      "example": "IP_ADDRESS"
    },
    "TimingCaps.NtpServers.PtpMasterIpAddress": {
      "description": "PTP Master IP Address",
      "type": "string",
      "example": "192.0.2.0"
    },
    "TimingCaps.NtpServers.PtpMasterLocalPriority": {
      "description": "PTP Master local priority",
      "type": "integer",
      "format": "uint32",
      "example": 1
    },
    "TimingCaps.NtpServers": {
      "description": "NTP server detail.",
      "type": "object",
      "required": [
        "ntpServerAddrType",
        "ntpServerAddr",
        "minPollingInterval",
        "maxPollingInterval",
        "localPriority",
        "authenticationOption",
        "authenticationKeyNum"
      ],
      "properties": {
        "ntpServerAddrType": {
          "$ref": "#/definitions/TimingCaps.NtpServers.NtpServerAddrType"
        },
        "ntpServerAddr": {
          "$ref": "#/definitions/TimingCaps.NtpServers.NtpServerAddr"
        },
        "minPollingInterval": {
          "$ref": "#/definitions/TimingCaps.NtpServers.MinPollingInterval"
        },
        "maxPollingInterval": {
          "$ref": "#/definitions/TimingCaps.NtpServers.MaxPollingInterval"
        },
        "localPriority": {
          "$ref": "#/definitions/TimingCaps.NtpServers.LocalPriority"
        },
        "authenticationOption": {
          "$ref": "#/definitions/TimingCaps.NtpServers.AuthenticationOption"
        },
        "authenticationKeyNum": {
          "$ref": "#/definitions/TimingCaps.NtpServers.AuthenticationKeyNum"
        }
      }
    },
    "TimingCaps.PtpMasters": {
      "description": "NTP server detail.",
      "type": "object",
      "required": [
        "ptpMasterIpAddress",
        "ptpMasterLocalPriority",
        "delayReqMaxRate"
      ],
      "properties": {
        "ptpMasterIpAddress": {
          "$ref": "#/definitions/TimingCaps.NtpServers.PtpMasterIpAddress"
        },
        "ptpMasterLocalPriority": {
          "$ref": "#/definitions/TimingCaps.NtpServers.PtpMasterLocalPriority"
        },
        "delayReqMaxRate": {
          "$ref": "#/definitions/TimingCaps.NtpServers.DelayReqMaxRate"
        }
      }
    },
    "TimingCaps.TimeStamp": {
      "description": "time",
      "type": "object",
      "required": [
        "nanoSeconds",
        "seconds"
      ],
      "properties": {
        "seconds": {
          "type": "integer",
          "format": "uint32",
          "description": "The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
          "example": 1577836800
        },
        "nanoSeconds": {
          "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 ip address.",
      "type": "string",
      "example": "192.168.1.1"
    },
    "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",
      ],
      "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"
        },
          "$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"
        }
      }
    }
  }