Mp1.json 80.4 KB
Newer Older
{
  "swagger": "2.0",
  "info": {
    "title": "Mp1 API",
    "version": "1.1.1",
    "description": "The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI",
    "license": {
      "name": "ETSI Forge copyright notice",
      "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
    }
  },
  "externalDocs": {
    "description": "ETSI GS MEC011 Application Enablement API, V1.1.1",
    "url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf"
  },
  "host": "127.0.0.1:8081",
  "basePath": "/exampleAPI/mp1/v1/",
  "schemes": [
    "http",
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "parameters": {
    "Body.AppTerminationNotificationSubscription": {
      "name": "AppTerminationNotificationSubscription",
      "description": "Entity body in the request contains a subscription to the mobile edge application termination notifications that is to be created.",
      "in": "body",
      "required": true,
      "schema": {
        "$ref": "#/definitions/AppTerminationNotificationSubscription"
      }
    },
    "Body.DnsRule": {
      "name": "DnsRule",
      "description": "The updated state is included in the entity body of the request.",
      "in": "body",
      "required": true,
      "schema": {
        "$ref": "#/definitions/DnsRule"
      }
    },
    "Body.SerAvailabilityNotificationSubscription": {
      "name": "SerAvailabilityNotificationSubscription",
      "description": "Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created.",
      "in": "body",
      "required": true,
      "schema": {
        "$ref": "#/definitions/SerAvailabilityNotificationSubscription"
      }
    },
    "Body.ServiceInfo": {
      "name": "ServiceInfo",
      "description": "New ServiceInfo with updated \"state\" is included as entity body of the request",
      "in": "body",
      "required": true,
      "schema": {
        "$ref": "#/definitions/ServiceInfo"
      }
    },
    "Body.TrafficRule": {
      "name": "TrafficRule",
      "description": "One or more updated attributes that are allowed to be changed",
      "in": "body",
      "required": true,
      "schema": {
        "$ref": "#/definitions/TrafficRule"
      }
    },
    "Path.AppInstanceId": {
      "name": "appInstanceId",
      "description": "Represents a mobile edge application instance. Note that the appInstanceId is allocated by the mobile edge platform manager.",
      "in": "path",
      "required": true,
      "type": "string",
      "format": "uri"
    },
    "Path.DnsRuleId": {
      "name": "dnsRuleId",
      "description": "Represents a DNS rule.",
      "in": "path",
      "required": true,
      "type": "string",
      "format": "uri"
    },
    "Path.SubscriptionId": {
      "name": "subscriptionId",
      "description": "Represents a subscription to the notifications from the mobile edge platform.",
      "in": "path",
      "required": true,
      "type": "string",
      "format": "uri"
    },
    "Path.SubscriptionType": {
      "name": "subscriptionType",
      "description": "Represents a subscription type to the notifications from the mobile edge platform.",
      "in": "path",
      "required": true,
      "type": "string",
      "format": "uri"
    },
    "Path.ServiceId": {
      "name": "serviceId",
      "description": "Represents a mobile edge service instance.",
      "in": "path",
      "required": true,
      "type": "string",
      "format": "uri"
    },
    "Path.TrafficRuleId": {
      "name": "trafficRuleId",
      "description": "Represents a traffic rule.",
      "in": "path",
      "required": true,
      "type": "string",
      "format": "uri"
    },
    "Query.Ser_category_id": {
      "name": "ser_category_id",
      "description": "A mobile edge application instance may use ser_category_id as an input parameter to query the availability of a list of mobile edge service instances in a serCategory. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.",
      "in": "query",
      "required": false,
      "type": "string"
    },
    "Query.Ser_instance_id": {
      "name": "ser_instance_id",
      "description": "A mobile edge application instance may use multiple ser_instance_ids as an input parameter to query the availability of a list of mobile edge service instances. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.",
      "in": "query",
      "required": false,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "Query.Ser_name": {
      "name": "ser_name",
      "description": "A mobile edge application instance may use multiple ser_names as an input parameter to query the availability of a list of mobile edge service instances. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.",
      "in": "query",
      "required": false,
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "paths": {
    "/applications/{appInstanceId}/dns_rules": {
      "parameters": [
        {
          "$ref": "#/parameters/Path.AppInstanceId"
        }
      ],
      "get": {
        "description": "This method retrieves information about all the DNS rules associated with a mobile edge application instance.",
        "operationId": "ApplicationsDnsRules.GET",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "schema": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "DnsRule": {
                    "$ref": "#/definitions/DnsRule"
                  }
                }
              }
            },
            "examples": {
              "application/json": [
                {
                  "DnsRule": {
                    "dnsRuleId": "DnsRule1",
                    "domainName": "www.example.com",
                    "ipAddressType": "IP_V4",
                    "ipAddress": "146.241.7.3",
                    "ttl": 300,
                    "state": "ACTIVE"
                  }
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      }
    },
    "/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
      "parameters": [
        {
          "$ref": "#/parameters/Path.AppInstanceId"
        },
        {
          "$ref": "#/parameters/Path.DnsRuleId"
        }
      ],
      "get": {
        "description": "This method retrieves information about a DNS rule associated with a mobile edge application instance.",
        "operationId": "ApplicationsDnsRule.GET",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "schema": {
              "type": "object",
              "properties": {
                "DnsRule": {
                  "$ref": "#/definitions/DnsRule"
                }
              }
            },
            "examples": {
              "application/json": {
                "DnsRule": {
                  "dnsRuleId": "DnsRule1",
                  "domainName": "www.example.com",
                  "ipAddressType": "IP_V4",
                  "ipAddress": "146.241.7.3",
                  "ttl": 300,
                  "state": "ACTIVE"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      },
      "put": {
        "description": "This method activates, de-activates or updates a traffic rule.",
        "operationId": "ApplicationsDnsRule.PUT",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Body.DnsRule"
          }
        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "schema": {
              "type": "object",
              "properties": {
                "DnsRule": {
                  "$ref": "#/definitions/DnsRule"
                }
              }
            },
            "examples": {
              "application/json": {
                "DnsRule": {
                  "dnsRuleId": "DnsRule1",
                  "domainName": "www.example.com",
                  "ipAddressType": "IP_V4",
                  "ipAddress": "146.241.7.3",
                  "ttl": 300,
                  "state": "ACTIVE"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "412": {
            "description": "Precondition Failed",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      }
    },
    "/applications/{appInstanceId}/subscriptions": {
      "parameters": [
        {
          "$ref": "#/parameters/Path.AppInstanceId"
        }
      ],
      "get": {
        "description": "The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains entity body with all the subscriptions for the requestor.",
        "operationId": "ApplicationsSubscriptions.GET",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Upon success, a response body containing the list of links to the requested subscriptions is returned.",
            "schema": {
              "type": "object",
              "properties": {
                "Mp1SubscriptionLinkList": {
                  "$ref": "#/definitions/Mp1SubscriptionLinkList"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      },
      "post": {
        "description": "The POST method may be used to create a new subscription. One example use case is to create a new subscription to the mobile edge service availability notifications. Upon success, the response contains entity body describing the created subscription.",
        "operationId": "ApplicationsSubscriptions.POST",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Body.AppTerminationNotificationSubscription"
          }
        ],
        "responses": {
          "201": {
            "description": "Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created.",
            "headers": {
              "location": {
                "description": "The resource URI of the created resource",
                "type": "string",
                "format": "uri"
              }
            },
            "schema": {
              "type": "object",
              "properties": {
                "AppTerminationNotificationSubscription": {
                  "$ref": "#/definitions/AppTerminationNotificationSubscription"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      }
    },
    "/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}": {
      "parameters": [
        {
          "$ref": "#/parameters/Path.AppInstanceId"
        },
        {
          "$ref": "#/parameters/Path.SubscriptionType"
        },
        {
          "$ref": "#/parameters/Path.SubscriptionId"
        }
      ],
      "get": {
        "description": "The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.",
        "operationId": "ApplicationsSubscription.GET",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Upon success, a response body containing the requested subscription is returned.",
            "schema": {
              "type": "object",
              "properties": {
                "SerAvailabilityNotificationSubscription": {
                  "$ref": "#/definitions/SerAvailabilityNotificationSubscription"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      },
      "delete": {
        "description": "This method deletes a meMp1Subscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
        "operationId": "ApplicationsSubscription.DELETE",
        "produces": [
          "application/json"
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      }
    },
    "/applications/{appInstanceId}/traffic_rules": {
      "parameters": [
        {
          "$ref": "#/parameters/Path.AppInstanceId"
        }
      ],
      "get": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
        "operationId": "ApplicationsTrafficRules.GET",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "schema": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "TrafficRule": {
                    "$ref": "#/definitions/TrafficRule"
                  }
                }
              }
            },
            "examples": {
              "application/json": [
                {
                  "TrafficRule": {
                    "trafficRuleId": "TrafficRule123",
                    "serName": "ExampleService",
                    "filterType": "FLOW",
                    "priority": 1,
                    "trafficFilter": [
                      {
                        "srcAddress": [
                          "192.168.2.0/24",
                          "192.168.3.0/24"
                        ],
                        "dstAddress": [
                          "192.127.4.100/32"
                        ],
                        "dstPort": [
                          "80"
                        ]
                      }
                    "action": "FORWARD_DECAPSULATED",
                    "dstInterface": {
                      "interfaceType": "IP",
                      "dstIpAddress": "20.1.1.1"
                    },
                    "state": "ACTIVE"
                  }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      }
    },
    "/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
      "parameters": [
        {
          "$ref": "#/parameters/Path.AppInstanceId"
        },
        {
          "$ref": "#/parameters/Path.TrafficRuleId"
        }
      ],
      "get": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
        "operationId": "ApplicationsTrafficRule.GET",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "schema": {
              "type": "object",
              "properties": {
                "TrafficRule": {
                  "$ref": "#/definitions/TrafficRule"
                }
              }
            },
            "examples": {
              "application/json": {
                "TrafficRule": {
                  "trafficRuleId": "TrafficRule123",
                  "serName": "ExampleService",
                  "filterType": "FLOW",
                  "priority": 1,
                  "trafficFilter": [
                    {
                      "srcAddress": [
                        "192.168.2.0/24",
                        "192.168.3.0/24"
                      ],
                      "dstAddress": [
                        "192.127.4.100/32"
                      ],
                      "dstPort": [
                        "80"
                      ]
                    }
                  ],
                  "action": "FORWARD_DECAPSULATED",
                  "dstInterface": {
                    "interfaceType": "IP",
                    "dstIpAddress": "20.1.1.1"
                  },
                  "state": "ACTIVE"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      },
      "put": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
        "operationId": "ApplicationsTrafficRules.PUT",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Body.TrafficRule"
          }
        ],
        "responses": {
          "200": {
            "description": "Upon success, a response body containing data type describing the updated TrafficRule is returned.",
            "schema": {
              "type": "object",
              "properties": {
                "TrafficRule": {
                  "$ref": "#/definitions/TrafficRule"
                }
              }
            },
            "examples": {
              "application/json": {
                "TrafficRule": {
                  "trafficRuleId": "TrafficRule123",
                  "serName": "ExampleService",
                  "filterType": "FLOW",
                  "priority": 1,
                  "trafficFilter": [
                    {
                      "srcAddress": [
                        "192.168.2.0/24",
                        "192.168.3.0/24"
                      ],
                      "dstAddress": [
                        "192.127.4.100/32"
                      ],
                      "dstPort": [
                        "80"
                      ]
                    }
                  ],
                  "action": "FORWARD_DECAPSULATED",
                  "dstInterface": {
                    "interfaceType": "IP",
                    "dstIpAddress": "20.1.1.1"
                  },
                  "state": "ACTIVE"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "412": {
            "description": "Precondition Failed",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      }
    },
    "/services": {
      "get": {
        "description": "This method retrieves information about a list of meService resources. This method is typically used in \"service availability query\" procedure",
        "operationId": "Services.GET",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Query.Ser_instance_id"
          },
          {
            "$ref": "#/parameters/Query.Ser_name"
          },
          {
            "$ref": "#/parameters/Query.Ser_category_id"
          }
        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "schema": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "ServiceInfo": {
                    "$ref": "#/definitions/ServiceInfo"
                  }
                }
              }
            },
            "examples": {
              "application/json": [
                {
                  "ServiceInfo": {
                    "serInstanceId": "ServiceInstance123",
                    "serName": "ExampleService",
                    "serCategory": {
                      "href": "catItem1",
                      "id": "id12345",
                      "name": "RNI",
                      "version": "version1"
                    "version": "ServiceVersion1",
                    "state": "ACTIVE",
                    "transportId": "Rest1",
                    "transportInfo": {
                      "id": "TransId12345",
                      "name": "REST",
                      "description": "REST API",
                      "type": "JSON",
                      "protocol": "HTTP",
                      "version": "2.0",
                      "endpoint": {
                        "uris": [
                          "/meMp1/service/EntryPoint"
                        ],
                        "addresses": [
                          {
                            "host": "192.0.2.0",
                            "port": 8080
                          }
                        ]
                      },
                      "security": {
                        "oAuth2Info": {
                          "grantTypes": "OAUTH2_CLIENT_CREDENTIALS",
                          "tokenEndpoint": "/meMp1/security/TokenEndPoint"
                        }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      },
      "post": {
        "description": "This method is used to create a meService resource. This method is typically used in \"service availability update and new service registration\" procedure",
        "operationId": "Services.POST",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Body.ServiceInfo"
          }
        ],
        "responses": {
          "201": {
            "description": "Upon success, the HTTP response shall include a Location HTTP header that contains the resource URI of the created resource.",
            "headers": {
              "location": {
                "description": "The resource URI of the created resource",
                "type": "string",
                "format": "uri"
              }
            },
            "schema": {
              "type": "object",
              "properties": {
                "ServiceInfo": {
                  "$ref": "#/definitions/ServiceInfo"
                }
              }
            },
            "examples": {
              "application/json": {
                "ServiceInfo": {
                  "serInstanceId": "ServiceInstance123",
                  "serName": "ExampleService",
                  "serCategory": {
                    "href": "catItem1",
                    "id": "id12345",
                    "name": "RNI",
                    "version": "version1"
                  },
                  "version": "ServiceVersion1",
                  "state": "ACTIVE",
                  "transportId": "Rest1",
                  "transportInfo": {
                    "id": "TransId12345",
                    "name": "REST",
                    "description": "REST API",
                    "protocol": "HTTP",
                    "version": "2.0",
                    "endpoint": {
                      "uris": [
                        "/meMp1/service/EntryPoint"
                      ],
                      "addresses": [
                        {
                          "host": "192.0.2.0",
                        }
                      ]
                    },
                    "security": {
                      "oAuth2Info": {
                        "grantTypes": "OAUTH2_CLIENT_CREDENTIALS",
                        "tokenEndpoint": "/meMp1/security/TokenEndPoint"
                      }
                    }
                  },
                  "serializer": "JSON"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      }
    },
    "/services/{serviceId}": {
      "parameters": [
        {
          "$ref": "#/parameters/Path.ServiceId"
        }
      ],
      "get": {
        "description": "This method retrieves information about a meService resource. This method is typically used in \"service availability query\" procedure",
        "operationId": "ServicesServiceId.GET",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "schema": {
              "type": "object",
              "properties": {
                "ServiceInfo": {
                  "$ref": "#/definitions/ServiceInfo"
                }
              }
            },
            "examples": {
              "application/json": {
                "ServiceInfo": {
                  "serInstanceId": "ServiceInstance123",
                  "serName": "ExampleService",
                  "serCategory": {
                    "href": "catItem1",
                    "id": "id12345",
                    "name": "RNI",
                    "version": "version1"
                  },
                  "version": "ServiceVersion1",
                  "state": "ACTIVE",
                  "transportId": "Rest1",
                  "transportInfo": {
                    "id": "TransId12345",
                    "name": "REST",
                    "description": "REST API",
                    "protocol": "HTTP",
                    "version": "2.0",
                    "endpoint": {
                      "uris": [
                        "/meMp1/service/EntryPoint"
                      ],
                      "addresses": [
                        {
                          "host": "192.0.2.0",
                        }
                      ]
                    },
                    "security": {
                      "oAuth2Info": {
                        "grantTypes": "OAUTH2_CLIENT_CREDENTIALS",
                        "tokenEndpoint": "/meMp1/security/TokenEndPoint"
                      }
                    }
                  },
                  "serializer": "JSON"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      },
      "put": {
        "description": "This method updates the information about a meService resource",
        "operationId": "ServicesServiceId.PUT",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Body.ServiceInfo"
          }
        ],
        "responses": {
          "200": {
            "description": "Upon success, a response body containing data type describing the updated ServiceInfo is returned",
            "schema": {
              "type": "object",
              "properties": {
                "ServiceInfo": {
                  "$ref": "#/definitions/ServiceInfo"
                }
              }
            },
            "examples": {
              "application/json": {
                "ServiceInfo": {
                  "serInstanceId": "ServiceInstance123",
                  "serName": "ExampleService",
                  "serCategory": {
                    "href": "catItem1",
                    "id": "id12345",
                    "name": "RNI",
                    "version": "version1"
                  },
                  "version": "ServiceVersion1",
                  "state": "ACTIVE",
                  "transportId": "Rest1",
                  "transportInfo": {
                    "id": "TransId12345",
                    "name": "REST",
                    "description": "REST API",
                    "protocol": "HTTP",
                    "version": "2.0",
                    "endpoint": {
                      "uris": [
                        "/meMp1/service/EntryPoint"
                      ],
                      "addresses": [
                        {
                          "host": "192.0.2.0",
                        }
                      ]
                    },
                    "security": {
                      "oAuth2Info": {
                        "grantTypes": "OAUTH2_CLIENT_CREDENTIALS",
                        "tokenEndpoint": "/meMp1/security/TokenEndPoint"
                      }
                    }
                  },
                  "serializer": "JSON"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "412": {
            "description": "Precondition Failed",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      }
    },
    "/timing/current_time": {
      "get": {
        "description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure",
        "operationId": "TimingCurrentTime.GET",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "schema": {
              "type": "object",
              "properties": {
                "CurrentTime": {
                  "$ref": "#/definitions/CurrentTime"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      }
    },
    "/timing/timing_caps": {
      "get": {
        "description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query",
        "operationId": "TimingCaps.GET",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "schema": {
              "type": "object",
              "properties": {
                "TimingCaps": {
                  "$ref": "#/definitions/TimingCaps"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      }
    },
    "/transports": {
      "get": {
        "description": "This method retrieves information about a list of available transports. This method is typically used by a service-producing application to discover transports provided by the mobile edge platform in the \"transport information query\" procedure",
        "operationId": "Transports.GET",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "schema": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "TransportInfo": {
                    "$ref": "#/definitions/TransportInfo"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "schema": {
              "type": "object",
              "required": [
                "ProblemDetails"
              ],
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "schema": {
              "type": "object",
              "properties": {
                "ProblemDetails": {
                  "$ref": "#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      }
    }
  },
  "definitions": {
    "AppTerminationNotification.MaxGracefulTimeout": {
      "description": "Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.",
      "format": "uint32",
      "example": 10
    },
    "AppTerminationNotification.NotificationType": {
      "description": "Shall be set to AppTerminationNotification.",
      "type": "string",
      "example": "AppTerminationNotification"
    },
    "AppTerminationNotification": {
      "description": "This type represents the information that the mobile edge platform notifies the subscribed application instance about  the corresponding application instance termination/stop.",
      "type": "object",
      "required": [
        "notificationType",
        "maxGracefulTimeout",
        "_links"
      ],
      "properties": {
        "notificationType": {
          "$ref": "#/definitions/AppTerminationNotification.NotificationType"
        },
        "maxGracefulTimeout": {
          "$ref": "#/definitions/AppTerminationNotification.MaxGracefulTimeout"
        },
        "_links": {
          "$ref": "#/definitions/Subscription"
        }
      }
    },
    "AppTerminationNotificationSubscription.AppInstanceId": {
      "description": "It is used as the filtering criterion for the subscribed events.",
      "type": "string",
      "example": "ID1"
    },
    "AppTerminationNotificationSubscription.CallbackReference": {
      "description": "URI selected by the mobile edge application instance to receive notifications on the subscribed mobile edge application instance management information. This shall be included in both the request and the response.",
      "type": "string",
      "format": "uri"
    },
    "AppTerminationNotificationSubscription": {
      "description": "This type represents the information that the mobile edge platform notifies the subscribed application instance about  the corresponding application instance termination/stop.",
      "type": "object",
      "required": [
        "subscriptionType",
        "callbackReference",
        "_links",
        "appInstanceId"
      ],
      "properties": {
        "subscriptionType": {
          "$ref": "#/definitions/AppTerminationNotificationSubscription.SubscriptionType"
        },
        "callbackReference": {
          "$ref": "#/definitions/AppTerminationNotificationSubscription.CallbackReference"
        },
        "_links": {
          "$ref": "#/definitions/Self"
        },
        "appInstanceId": {
          "$ref": "#/definitions/AppTerminationNotificationSubscription.AppInstanceId"
        }
      }
    },
    "AppTerminationNotificationSubscription.SubscriptionType": {
      "description": "Shall be set to AppTerminationNotificationSubscription.",
      "type": "string",
      "example": "AppTerminationNotificationSubscription"
    },
    "CategoryRef.Href": {
      "description": "Reference of the catalogue",
      "type": "string",
      "example": "catItem1"
    },
    "CategoryRef.Id": {
      "description": "Unique identifier of the category",
      "type": "string",
      "example": "id12345"
    },
    "CategoryRef.Name": {
      "description": "Name of the category",
      "type": "string",
      "example": "RNI"
    },
    "CategoryRef.Version": {
      "description": "Category version",
      "type": "string",
      "example": "version1"
    },
    "CategoryRef": {
      "description": "This type represents the category reference",
      "type": "object",
      "required": [
        "href",
        "id",
        "name",
        "version"
      ],
      "properties": {
        "href": {
          "$ref": "#/definitions/CategoryRef.Href"
        },
        "id": {
          "$ref": "#/definitions/CategoryRef.Id"
        },
        "name": {
          "$ref": "#/definitions/CategoryRef.Name"
        },
        "version": {
          "$ref": "#/definitions/CategoryRef.Version"
        }
      }
    },
    "CurrentTime": {
      "description": "This type represents the information provided by the mobile edge platform in response to the Get Platform Time Request message.",
      "type": "object",
      "required": [
        "nanoSeconds",
        "seconds",
        "timeSourceStatus"
      ],
      "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
        },
        "timeSourceStatus": {
          "type": "string",
          "enum": [
            "TRACEABLE",
            "NONTRACEABLE"
          ],
          "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",
          "example": "TRACEABLE"
        }
      }
    },
    "DestinationInterface.InterfaceType": {
      "description": "Type of the interface",
      "type": "string",
      "enum": [
        "TUNNEL",
        "MAC",
        "IP"
      ],
      "example": "TUNNEL"
    },
    "DestinationInterface.IpAddress": {
      "description": "IP address of the remote destination",
      "type": "string",
      "example": "192.0.2.0"
    },
    "DestinationInterface.MacAddress": {
      "description": "Source address identifies the MAC address of the interface",
      "type": "string",
      "example": "02-00-00-00-00-00"
    },
    "DestinationInterface": {
      "description": "This type represents the destination interface.",
      "type": "object",
      "required": [
        "interfaceType"
      ],
      "properties": {
        "interfaceType": {
          "$ref": "#/definitions/DestinationInterface.InterfaceType"
        },
        "tunnelInfo": {
          "$ref": "#/definitions/TunnelInfo"
        },
        "srcMacAddress": {
          "$ref": "#/definitions/DestinationInterface.MacAddress"
        },
        "dstMacAddress": {
          "$ref": "#/definitions/DestinationInterface.MacAddress"
        },
        "dstIpAddress": {
          "$ref": "#/definitions/DestinationInterface.IpAddress"
        }
      }
    },
    "DnsRule.DomainName": {
      "description": "FQDN resolved by the DNS rule",
      "type": "string",
      "example": "www.example.com"
    },
    "DnsRule.Id": {
      "description": "Identifies the DNS Rule",
      "type": "string",
      "example": "dnsRule1"
    },
    "DnsRule.IpAddress": {
      "description": "IP address associated with the FQDN resolved by the DNS rule",
      "type": "string",
      "example": "192.0.2.0"
    },
    "DnsRule.IpAddressType": {
      "description": "IP address type",
      "type": "string",
      "enum": [
        "IP_V6",
        "IP_V4"
      ],
      "example": "IP_V6"
    },
    "DnsRule.State": {
      "description": "DNS rule state",
      "type": "string",
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "example": "ACTIVE"
    },
    "DnsRule.Ttl": {
      "description": "Time to live value",
      "type": "integer",
      "format": "uint32",
      "example": "?"
    },
    "DnsRule": {
      "description": "This type represents the general information of a DNS rule.",
      "type": "object",
      "required": [
        "dnsRuleId",
        "domainName",
        "ipAddressType",
        "ipAddress",
        "state"
      ],
      "properties": {
        "dnsRuleId": {
          "$ref": "#/definitions/DnsRule.Id"
        },
        "domainName": {
          "$ref": "#/definitions/DnsRule.DomainName"
        },
        "ipAddressType": {
          "$ref": "#/definitions/DnsRule.IpAddressType"
        },
        "ipAddress": {
          "$ref": "#/definitions/DnsRule.IpAddress"
        },
        "ttl": {
          "$ref": "#/definitions/DnsRule.Ttl"
        },
        "state": {
          "$ref": "#/definitions/DnsRule.State"
        }
      }
    },
    "EndPointInfo.Address.Host": {
      "description": "Host portion of the address",
      "type": "string",
      "example": "192.0.2.0"
    },
    "EndPointInfo.Address.Port": {
      "description": "Port portion of the address",
      "type": "integer",
      "format": "uint32",
1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 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
    },
    "EndPointInfo.Address": {
      "description": "A IP address and port pair",
      "type": "object",
      "properties": {
        "host": {
          "$ref": "#/definitions/EndPointInfo.Address.Host"
        },
        "port": {
          "$ref": "#/definitions/EndPointInfo.Address.Port"
        }
      }
    },
    "EndPointInfo.Addresses": {
      "description": "Entry point information of the service as one or more pairs of IP address and port",
      "type": "array",
      "items": {
        "$ref": "#/definitions/EndPointInfo.Address"
      }
    },
    "EndPointInfo.Alternative": {
      "description": "Entry point information of the service in a format defined by an implementation, or in an external specification.",
      "type": "object"
    },
    "EndPointInfo.Uri": {
      "description": "Entry point information of the service",
      "type": "string",
      "format": "uri",
      "example": "/meMp1/service/EntryPoint"
    },
    "EndPointInfo.Uris": {
      "description": "Entry point information of the service as string, formatted according to URI syntax",
      "type": "array",
      "items": {
        "$ref": "#/definitions/EndPointInfo.Uri"
      }
    },
    "EndPointInfo": {
      "description": "This type represents information about a transport endpoint",
      "type": "object",
      "properties": {
        "uris": {
          "$ref": "#/definitions/EndPointInfo.Uris"
        },
        "addresses": {
          "$ref": "#/definitions/EndPointInfo.Addresses"
        },
        "alternative": {
          "$ref": "#/definitions/EndPointInfo.Alternative"
        }
      }
    },
    "LinkType": {
      "description": "URI referring to a resource",
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "example": "/meMp1/example"
    },
    "Mp1SubscriptionLinkList.Links": {
      "description": "Self-referring URI.",
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "$ref": "#/definitions/LinkType"
        },
        "subscription": {
          "description": "Subscription list",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Mp1SubscriptionLinkList.Subscription"
          }
        }
      }
    },
    "Mp1SubscriptionLinkList.Subscription": {
      "description": "A link to a subscription.",
      "type": "object",
      "required": [
        "href",
        "rel"
      ],
      "properties": {
        "href": {
          "description": "The URI referring to the subscription",
          "type": "string",
          "format": "uri"
        },
        "rel": {
          "description": "The values are as defined in the \"subscriptionType\" attribute for each different Mp1 event subscription data type.",
          "type": "string"
        }
      }
    },
    "Mp1SubscriptionLinkList": {
      "description": "This type represents a list of links related to currently existing subscriptions for a mobile edge application instance. This information is returned when sending a request to receive current subscriptions.",
      "type": "object",
      "required": [
        "_links"
      ],
      "properties": {
        "_links": {
          "$ref": "#/definitions/Mp1SubscriptionLinkList.Links"
        }
      }
    },
    "ProblemDetails": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/definitions/Problem.type"
        },
        "title": {
          "$ref": "#/definitions/Problem.title"
        },
        "status": {
          "$ref": "#/definitions/Problem.status"
        },
        "detail": {
          "$ref": "#/definitions/Problem.detail"
        },
        "instance": {
          "$ref": "#/definitions/Problem.instance"
        }
      }
    },
    "Problem.detail": {
      "type": "string",
      "description": "A human-readable explanation specific to this occurrence of the problem"
    },
    "Problem.instance": {
      "type": "string",
      "format": "uri",
      "description": "A URI reference that identifies the specific occurrence of the problem"
    },
    "Problem.status": {
      "type": "integer",
      "format": "uint32",
      "description": "The HTTP status code for this occurrence of the problem"
    },
    "Problem.title": {
      "type": "string",
      "description": "A short, human-readable summary of the problem type"
    },
    "Problem.type": {
      "type": "string",
      "format": "uri",
      "description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
    },
    "SecurityInfo.OAuth2Info.GrantTypes": {
      "description": "List of supported OAuth 2.0 grant types",
      "type": "string",
      "enum": [
        "OAUTH2_AUTHORIZATION_CODE",
        "OAUTH2_IMPLICIT_GRANT",
        "OAUTH2_RESOURCE_OWNER",
        "OAUTH2_CLIENT_CREDENTIALS"
      ],
      "example": "OAUTH2_CLIENT_CREDENTIALS"
    },
    "SecurityInfo.OAuth2Info.TokenEndpoint": {
      "description": "The token endpoint",
      "type": "string",
      "format": "uri",
      "example": "/meMp1/security/TokenEndPoint"
    },
    "SecurityInfo.OAuth2Info": {
      "description": "Parameters related to use of OAuth 2.0",
      "required": [
        "grantTypes",
        "tokenEndpoint"
      ],
      "properties": {
        "grantTypes": {
          "$ref": "#/definitions/SecurityInfo.OAuth2Info.GrantTypes"
        },
        "tokenEndpoint": {
          "$ref": "#/definitions/SecurityInfo.OAuth2Info.TokenEndpoint"
        }
      }
    },
    "SecurityInfo": {
      "description": "This type represents security information related to a transport",
      "type": "object",
      "required": [
        "oAuth2Info"
      ],
      "properties": {
        "oAuth2Info": {
          "$ref": "#/definitions/SecurityInfo.OAuth2Info"
        }
      }
    },
    "Self": {
      "description": "Self-referring URI.",
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "$ref": "#/definitions/LinkType"
        }
      },
      "readOnly": true
    },
    "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": {
      "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": {
          "type": "array",
          "items": {
            "$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",
        "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"
        },
        "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"
      ],
    },
    "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"
        }
      }
    }
  }
}