MecAppSupportApi.json 58.7 KB
Newer Older
1
{
2
  "openapi": "3.0.2",
3 4
  "servers": [
    {
Walter Featherstone's avatar
Walter Featherstone committed
5
      "url": "http://127.0.0.1:8081/mec_app_support/v1"
6 7
    },
    {
Walter Featherstone's avatar
Walter Featherstone committed
8
      "url": "https://127.0.0.1:8081/mec_app_support/v1"
9 10
    }
  ],
11
  "info": {
Walter Featherstone's avatar
Walter Featherstone committed
12 13 14
    "title": "MEC Application Support API",
    "version": "2.1.1",
    "description": "The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI",
15
    "license": {
ETSI CTI's avatar
ETSI CTI committed
16 17
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
18 19 20
    },
    "contact": {
      "email": "cti_support@etsi.org"
21 22 23
    }
  },
  "externalDocs": {
Walter Featherstone's avatar
Walter Featherstone committed
24 25
    "description": "ETSI GS MEC011 Application Enablement API, V2.1.1",
    "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf"
26
  },
27 28
  "tags": [
    {
Walter Featherstone's avatar
Walter Featherstone committed
29
      "name": "appTrafficRules"
30
    },
31
    {
Walter Featherstone's avatar
Walter Featherstone committed
32
      "name": "appDnsRules"
33
    },
34
    {
Walter Featherstone's avatar
Walter Featherstone committed
35
      "name": "appSubscriptions"
36
    },
37
    {
Walter Featherstone's avatar
Walter Featherstone committed
38
      "name": "appConfirmTermination"
39
    },
40
    {
Walter Featherstone's avatar
Walter Featherstone committed
41
      "name": "appConfirmReady"
42
    },
43
    {
Walter Featherstone's avatar
Walter Featherstone committed
44
      "name": "timing"
45
    },
46 47
    {
      "name": "callbacks"
48
    }
49
  ],
50
  "paths": {
Walter Featherstone's avatar
Walter Featherstone committed
51
    "/applications/{appInstanceId}/traffic_rules": {
52 53
      "parameters": [
        {
54
          "$ref": "#/components/parameters/Path.AppInstanceId"
55 56 57
        }
      ],
      "get": {
Walter Featherstone's avatar
Walter Featherstone committed
58 59
        "description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
        "operationId": "ApplicationsTrafficRules_GET",
60
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
61
          "appTrafficRules"
62 63 64
        ],
        "responses": {
          "200": {
Walter Featherstone's avatar
Walter Featherstone committed
65
            "$ref": "#/components/responses/ApplicationsTrafficRules.200"
66 67
          },
          "400": {
68
            "$ref": "#/components/responses/Error.400"
69 70
          },
          "403": {
71
            "$ref": "#/components/responses/Error.403"
72 73
          },
          "404": {
74
            "$ref": "#/components/responses/Error.404"
75 76 77 78
          }
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
79
    "/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
80 81
      "parameters": [
        {
82
          "$ref": "#/components/parameters/Path.AppInstanceId"
83 84
        },
        {
Walter Featherstone's avatar
Walter Featherstone committed
85
          "$ref": "#/components/parameters/Path.TrafficRuleId"
86 87 88
        }
      ],
      "get": {
Walter Featherstone's avatar
Walter Featherstone committed
89 90
        "description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
        "operationId": "ApplicationsTrafficRule_GET",
91
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
92
          "appTrafficRules"
93 94 95
        ],
        "responses": {
          "200": {
Walter Featherstone's avatar
Walter Featherstone committed
96
            "$ref": "#/components/responses/ApplicationsTrafficRule.200"
97 98
          },
          "400": {
99
            "$ref": "#/components/responses/Error.400"
100 101
          },
          "403": {
102
            "$ref": "#/components/responses/Error.403"
103 104
          },
          "404": {
105
            "$ref": "#/components/responses/Error.404"
106 107 108 109
          }
        }
      },
      "put": {
Walter Featherstone's avatar
Walter Featherstone committed
110 111
        "description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
        "operationId": "ApplicationsTrafficRule_PUT",
112
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
113
          "appTrafficRules"
114 115 116
        ],
        "responses": {
          "200": {
Walter Featherstone's avatar
Walter Featherstone committed
117
            "$ref": "#/components/responses/ApplicationsTrafficRule.200"
118 119
          },
          "400": {
120
            "$ref": "#/components/responses/Error.400"
121 122
          },
          "403": {
123
            "$ref": "#/components/responses/Error.403"
124 125
          },
          "404": {
126
            "$ref": "#/components/responses/Error.404"
127 128
          },
          "412": {
129
            "$ref": "#/components/responses/Error.412"
130
          }
131 132
        },
        "requestBody": {
Walter Featherstone's avatar
Walter Featherstone committed
133
          "$ref": "#/components/requestBodies/ApplicationsTrafficRule"
134 135 136
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
137
    "/applications/{appInstanceId}/dns_rules": {
138 139
      "parameters": [
        {
140
          "$ref": "#/components/parameters/Path.AppInstanceId"
141 142 143
        }
      ],
      "get": {
Walter Featherstone's avatar
Walter Featherstone committed
144 145
        "description": "This method retrieves information about all the DNS rules associated with a MEC application instance.",
        "operationId": "ApplicationsDnsRules_GET",
146
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
147
          "appDnsRules"
148 149 150
        ],
        "responses": {
          "200": {
Walter Featherstone's avatar
Walter Featherstone committed
151
            "$ref": "#/components/responses/ApplicationsDnsRules.200"
152 153
          },
          "400": {
154
            "$ref": "#/components/responses/Error.400"
155 156
          },
          "403": {
157
            "$ref": "#/components/responses/Error.403"
158 159
          },
          "404": {
160
            "$ref": "#/components/responses/Error.404"
161 162
          }
        }
163 164
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
165
    "/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
166 167
      "parameters": [
        {
168
          "$ref": "#/components/parameters/Path.AppInstanceId"
169 170
        },
        {
Walter Featherstone's avatar
Walter Featherstone committed
171
          "$ref": "#/components/parameters/Path.DnsRuleId"
172 173 174
        }
      ],
      "get": {
Walter Featherstone's avatar
Walter Featherstone committed
175 176
        "description": "This method retrieves information about a DNS rule associated with a MEC application instance.",
        "operationId": "ApplicationsDnsRule_GET",
177
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
178
          "appDnsRules"
179 180 181
        ],
        "responses": {
          "200": {
Walter Featherstone's avatar
Walter Featherstone committed
182
            "$ref": "#/components/responses/ApplicationsDnsRule.200"
183 184
          },
          "400": {
185
            "$ref": "#/components/responses/Error.400"
186 187
          },
          "403": {
188
            "$ref": "#/components/responses/Error.403"
189 190
          },
          "404": {
191
            "$ref": "#/components/responses/Error.404"
192 193 194
          }
        }
      },
Walter Featherstone's avatar
Walter Featherstone committed
195 196 197
      "put": {
        "description": "This method activates, de-activates or updates a traffic rule.",
        "operationId": "ApplicationsDnsRule_PUT",
198
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
199
          "appDnsRules"
200 201 202
        ],
        "responses": {
          "200": {
Walter Featherstone's avatar
Walter Featherstone committed
203
            "$ref": "#/components/responses/ApplicationsDnsRule.200"
204 205
          },
          "400": {
206
            "$ref": "#/components/responses/Error.400"
207 208
          },
          "403": {
209
            "$ref": "#/components/responses/Error.403"
210 211
          },
          "404": {
212
            "$ref": "#/components/responses/Error.404"
Walter Featherstone's avatar
Walter Featherstone committed
213 214 215
          },
          "412": {
            "$ref": "#/components/responses/Error.412"
216
          }
Walter Featherstone's avatar
Walter Featherstone committed
217 218 219
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ApplicationsDnsRule"
220 221 222
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
223
    "/applications/{appInstanceId}/subscriptions": {
224 225
      "parameters": [
        {
226
          "$ref": "#/components/parameters/Path.AppInstanceId"
227 228 229
        }
      ],
      "get": {
Walter Featherstone's avatar
Walter Featherstone committed
230 231
        "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",
232
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
233
          "appSubscriptions"
234 235 236
        ],
        "responses": {
          "200": {
Walter Featherstone's avatar
Walter Featherstone committed
237
            "$ref": "#/components/responses/ApplicationsSubscriptions.200"
238 239
          },
          "400": {
240
            "$ref": "#/components/responses/Error.400"
241 242
          },
          "403": {
243
            "$ref": "#/components/responses/Error.403"
244 245
          },
          "404": {
246
            "$ref": "#/components/responses/Error.404"
247 248 249
          }
        }
      },
Walter Featherstone's avatar
Walter Featherstone committed
250 251 252
      "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 MEC service availability notifications. Upon success, the response contains entity body describing the created subscription.",
        "operationId": "ApplicationsSubscriptions_POST",
253
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
254
          "appSubscriptions"
255 256
        ],
        "responses": {
Walter Featherstone's avatar
Walter Featherstone committed
257 258
          "201": {
            "$ref": "#/components/responses/ApplicationsSubscriptions.201"
259 260
          },
          "400": {
261
            "$ref": "#/components/responses/Error.400"
262 263
          },
          "403": {
264
            "$ref": "#/components/responses/Error.403"
265 266
          },
          "404": {
267
            "$ref": "#/components/responses/Error.404"
268
          }
269 270
        },
        "requestBody": {
Walter Featherstone's avatar
Walter Featherstone committed
271 272 273 274 275 276
          "$ref": "#/components/requestBodies/ApplicationsSubscriptions"
        },
        "callbacks": {
          "appTerminationNotification": {
            "$ref": "#/components/callbacks/AppTerminationNotification"
          }
277 278 279
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
280 281 282 283 284 285 286 287 288
    "/applications/{appInstanceId}/subscriptions/{subscriptionId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Path.AppInstanceId"
        },
        {
          "$ref": "#/components/parameters/Path.SubscriptionId"
        }
      ],
289
      "get": {
Walter Featherstone's avatar
Walter Featherstone committed
290 291
        "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",
292
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
293
          "appSubscriptions"
294 295 296
        ],
        "responses": {
          "200": {
Walter Featherstone's avatar
Walter Featherstone committed
297
            "$ref": "#/components/responses/ApplicationsSubscription.200"
298 299
          },
          "400": {
300
            "$ref": "#/components/responses/Error.400"
301 302
          },
          "403": {
303
            "$ref": "#/components/responses/Error.403"
304 305
          },
          "404": {
306
            "$ref": "#/components/responses/Error.404"
307 308 309
          }
        }
      },
Walter Featherstone's avatar
Walter Featherstone committed
310 311 312
      "delete": {
        "description": "This method deletes a mecAppSuptApiSubscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
        "operationId": "ApplicationsSubscription_DELETE",
313
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
314
          "appSubscriptions"
315 316
        ],
        "responses": {
Walter Featherstone's avatar
Walter Featherstone committed
317 318
          "204": {
            "description": "No Content"
319 320
          },
          "403": {
321
            "$ref": "#/components/responses/Error.403"
322 323
          },
          "404": {
324
            "$ref": "#/components/responses/Error.404"
325 326 327 328
          }
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
329
    "/applications/{appInstanceId}/confirm_termination": {
330 331
      "parameters": [
        {
Walter Featherstone's avatar
Walter Featherstone committed
332
          "$ref": "#/components/parameters/Path.AppInstanceId"
333 334
        }
      ],
Walter Featherstone's avatar
Walter Featherstone committed
335 336 337
      "post": {
        "description": "This method is used to confirm the application level termination  of an application instance.",
        "operationId": "ApplicationsConfirmTermination_POST",
338
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
339
          "appConfirmTermination"
340 341
        ],
        "responses": {
Walter Featherstone's avatar
Walter Featherstone committed
342 343
          "204": {
            "description": "No Content"
344
          },
Walter Featherstone's avatar
Walter Featherstone committed
345 346
          "401": {
            "$ref": "#/components/responses/Error.401"
347 348
          },
          "403": {
349
            "$ref": "#/components/responses/Error.403"
350 351
          },
          "404": {
352
            "$ref": "#/components/responses/Error.404"
353
          },
Walter Featherstone's avatar
Walter Featherstone committed
354 355
          "409": {
            "$ref": "#/components/responses/Error.409"
356
          },
Walter Featherstone's avatar
Walter Featherstone committed
357 358
          "429": {
            "$ref": "#/components/responses/Error.429"
359
          }
360 361
        },
        "requestBody": {
Walter Featherstone's avatar
Walter Featherstone committed
362
          "$ref": "#/components/requestBodies/ApplicationsConfirmTermination"
363 364 365
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
366 367 368 369 370 371 372 373 374
    "/applications/{appInstanceId}/confirm_ready": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Path.AppInstanceId"
        }
      ],
      "post": {
        "description": "This method may be used by the MEC application instance to notify the MEC platform that it is up and running. ",
        "operationId": "ApplicationsConfirmReady_POST",
375
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
376
          "appConfirmReady"
377 378
        ],
        "responses": {
Walter Featherstone's avatar
Walter Featherstone committed
379 380
          "204": {
            "description": "No Content"
381
          },
Walter Featherstone's avatar
Walter Featherstone committed
382 383
          "401": {
            "$ref": "#/components/responses/Error.401"
384 385
          },
          "403": {
386
            "$ref": "#/components/responses/Error.403"
387 388
          },
          "404": {
389
            "$ref": "#/components/responses/Error.404"
Walter Featherstone's avatar
Walter Featherstone committed
390 391 392 393 394 395
          },
          "409": {
            "$ref": "#/components/responses/Error.409"
          },
          "429": {
            "$ref": "#/components/responses/Error.429"
396
          }
Walter Featherstone's avatar
Walter Featherstone committed
397 398 399
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ApplicationsConfirmReady"
400 401 402 403 404 405
        }
      }
    },
    "/timing/timing_caps": {
      "get": {
        "description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query",
406
        "operationId": "TimingCaps_GET",
407 408
        "tags": [
          "timing"
409 410 411
        ],
        "responses": {
          "200": {
412
            "$ref": "#/components/responses/TimingCaps.200"
413 414
          },
          "400": {
415
            "$ref": "#/components/responses/Error.400"
416 417
          },
          "403": {
418
            "$ref": "#/components/responses/Error.403"
419 420
          },
          "404": {
421
            "$ref": "#/components/responses/Error.404"
422 423 424 425
          }
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
426
    "/timing/current_time": {
427
      "get": {
Walter Featherstone's avatar
Walter Featherstone committed
428 429
        "description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure",
        "operationId": "TimingCurrentTime_GET",
430
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
431
          "timing"
432 433 434
        ],
        "responses": {
          "200": {
Walter Featherstone's avatar
Walter Featherstone committed
435
            "$ref": "#/components/responses/TimingCurrentTime.200"
436 437
          },
          "400": {
438
            "$ref": "#/components/responses/Error.400"
439 440
          },
          "403": {
441
            "$ref": "#/components/responses/Error.403"
442 443
          },
          "404": {
444
            "$ref": "#/components/responses/Error.404"
445 446 447 448 449
          }
        }
      }
    }
  },
450 451 452 453 454
  "components": {
    "schemas": {
      "Empty": {
        "description": "Empty schema"
      },
Walter Featherstone's avatar
Walter Featherstone committed
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
      "AppReadyConfirmation": {
        "description": "This type represents the information that the MEC application instance indicates to the MEC platform that it is up and running.",
        "type": "object",
        "required": [
          "indication"
        ],
        "properties": {
          "indication": {
            "$ref": "#/components/schemas/ReadyIndicationType"
          }
        }
      },
      "AppTerminationConfirmation": {
        "description": "This type represents the information that the MEC application instance provides to the MEC platform when informing it that the application has completed its application level related terminate/stop actions, e.g. retention of application state in the case of stop.",
        "type": "object",
        "required": [
          "operationAction"
        ],
        "properties": {
          "operationAction": {
            "$ref": "#/components/schemas/OperationActionType"
          }
        }
      },
      "AppTerminationNotification.Links": {
        "description": "Object containing hyperlinks related to the resource.",
        "type": "object",
        "required": [
          "subscription"
        ],
        "properties": {
          "subscription": {
            "$ref": "#/components/schemas/LinkType"
          },
          "confirmTermination": {
            "$ref": "#/components/schemas/LinkType.ConfirmTermination"
          }
        }
      },
494 495
      "AppTerminationNotification.MaxGracefulTimeout": {
        "description": "Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.",
496
        "type": "integer",
497 498 499 500 501 502 503 504 505
        "format": "uint32",
        "example": 10
      },
      "AppTerminationNotification.NotificationType": {
        "description": "Shall be set to AppTerminationNotification.",
        "type": "string",
        "example": "AppTerminationNotification"
      },
      "AppTerminationNotification": {
Walter Featherstone's avatar
Walter Featherstone committed
506
        "description": "This type represents the information that the MEC platform notifies the subscribed application instance about  the corresponding application instance termination/stop.",
507 508 509
        "type": "object",
        "required": [
          "notificationType",
Walter Featherstone's avatar
Walter Featherstone committed
510
          "operationAction",
511 512 513 514 515 516 517
          "maxGracefulTimeout",
          "_links"
        ],
        "properties": {
          "notificationType": {
            "$ref": "#/components/schemas/AppTerminationNotification.NotificationType"
          },
Walter Featherstone's avatar
Walter Featherstone committed
518 519 520
          "operationAction": {
            "$ref": "#/components/schemas/OperationActionType"
          },
521 522 523 524
          "maxGracefulTimeout": {
            "$ref": "#/components/schemas/AppTerminationNotification.MaxGracefulTimeout"
          },
          "_links": {
Walter Featherstone's avatar
Walter Featherstone committed
525
            "$ref": "#/components/schemas/AppTerminationNotification.Links"
526
          }
527
        }
528 529 530 531 532 533 534
      },
      "AppTerminationNotificationSubscription.AppInstanceId": {
        "description": "It is used as the filtering criterion for the subscribed events.",
        "type": "string",
        "example": "ID1"
      },
      "AppTerminationNotificationSubscription.CallbackReference": {
Walter Featherstone's avatar
Walter Featherstone committed
535
        "description": "URI selected by the MEC application instance to receive notifications on the subscribed MEC application instance management information. This shall be included in both the request and the response.",
536 537 538 539
        "type": "string",
        "format": "uri"
      },
      "AppTerminationNotificationSubscription": {
Walter Featherstone's avatar
Walter Featherstone committed
540
        "description": "This type represents the information that the MEC platform notifies the subscribed application instance about  the corresponding application instance termination/stop.",
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
        "type": "object",
        "required": [
          "subscriptionType",
          "callbackReference",
          "_links",
          "appInstanceId"
        ],
        "properties": {
          "subscriptionType": {
            "$ref": "#/components/schemas/AppTerminationNotificationSubscription.SubscriptionType"
          },
          "callbackReference": {
            "$ref": "#/components/schemas/AppTerminationNotificationSubscription.CallbackReference"
          },
          "_links": {
            "$ref": "#/components/schemas/Self"
          },
          "appInstanceId": {
            "$ref": "#/components/schemas/AppTerminationNotificationSubscription.AppInstanceId"
          }
561
        }
562 563 564 565 566 567 568
      },
      "AppTerminationNotificationSubscription.SubscriptionType": {
        "description": "Shall be set to AppTerminationNotificationSubscription.",
        "type": "string",
        "example": "AppTerminationNotificationSubscription"
      },
      "CurrentTime": {
Walter Featherstone's avatar
Walter Featherstone committed
569
        "description": "This type represents the information provided by the MEC platform in response to the Get Platform Time Request message.",
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
        "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"
          }
598
        }
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
      },
      "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": {
Walter Featherstone's avatar
Walter Featherstone committed
621
        "description": "This type represents the destination interface. If the action is FORWARD_DECAPSULATED, FORWARD_ENCAPSULATED or PASSTHROUGH one value shall be provided. If the action is DUPLICATE_DECAPSULATED or DUPLICATE_ENCAPSULATED, two values shall be provided. If the action is DROP, no value shall be provided.",
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
        "type": "object",
        "required": [
          "interfaceType"
        ],
        "properties": {
          "interfaceType": {
            "$ref": "#/components/schemas/DestinationInterface.InterfaceType"
          },
          "tunnelInfo": {
            "$ref": "#/components/schemas/TunnelInfo"
          },
          "srcMacAddress": {
            "$ref": "#/components/schemas/DestinationInterface.MacAddress"
          },
          "dstMacAddress": {
            "$ref": "#/components/schemas/DestinationInterface.MacAddress"
          },
          "dstIpAddress": {
            "$ref": "#/components/schemas/DestinationInterface.IpAddress"
          }
642
        }
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
      },
      "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": {
Walter Featherstone's avatar
Walter Featherstone committed
669
        "description": "DNS rule state. This attribute may be updated using HTTP PUT method",
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
        "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": "#/components/schemas/DnsRule.Id"
          },
          "domainName": {
            "$ref": "#/components/schemas/DnsRule.DomainName"
          },
          "ipAddressType": {
            "$ref": "#/components/schemas/DnsRule.IpAddressType"
          },
          "ipAddress": {
            "$ref": "#/components/schemas/DnsRule.IpAddress"
          },
          "ttl": {
            "$ref": "#/components/schemas/DnsRule.Ttl"
          },
          "state": {
            "$ref": "#/components/schemas/DnsRule.State"
          }
712
        }
713
      },
Walter Featherstone's avatar
Walter Featherstone committed
714 715
      "LinkType": {
        "description": "This type represents a type of link and may be referenced from data structures",
716 717
        "type": "object",
        "properties": {
Walter Featherstone's avatar
Walter Featherstone committed
718 719
          "href": {
            "$ref": "#/components/schemas/Href"
720
          }
721 722
        }
      },
Walter Featherstone's avatar
Walter Featherstone committed
723 724
      "LinkType.ConfirmTermination": {
        "description": "Link to the task resource where to confirm termination in case the  application is ready to be terminated before expiry of the timeout.",
725 726 727 728 729 730 731 732 733 734 735
        "type": "object",
        "properties": {
          "href": {
            "$ref": "#/components/schemas/Href"
          }
        }
      },
      "Href": {
        "description": "URI referring to a resource",
        "type": "string",
        "format": "uri",
Walter Featherstone's avatar
Walter Featherstone committed
736
        "example": "/mecAppSuptApi/example"
737
      },
Walter Featherstone's avatar
Walter Featherstone committed
738
      "MecAppSuptApiSubscriptionLinkList.Links": {
739 740 741 742 743 744 745 746 747
        "description": "Self-referring URI.",
        "type": "object",
        "required": [
          "self"
        ],
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          },
Walter Featherstone's avatar
Walter Featherstone committed
748 749
          "subscriptions": {
            "description": "The MEC application instance's subscriptions",
750 751
            "type": "array",
            "items": {
Walter Featherstone's avatar
Walter Featherstone committed
752
              "$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList.Subscription"
753 754 755 756
            }
          }
        }
      },
Walter Featherstone's avatar
Walter Featherstone committed
757
      "MecAppSuptApiSubscriptionLinkList.Subscription": {
758 759 760 761 762 763 764 765 766 767 768
        "description": "A link to a subscription.",
        "type": "object",
        "required": [
          "href",
          "rel"
        ],
        "properties": {
          "href": {
            "$ref": "#/components/schemas/Href"
          },
          "rel": {
Walter Featherstone's avatar
Walter Featherstone committed
769 770
            "description": "The values shall be set to AppTerminationNotificationSubscription.",
            "type": "string"
771 772 773
          }
        }
      },
Walter Featherstone's avatar
Walter Featherstone committed
774 775
      "MecAppSuptApiSubscriptionLinkList": {
        "description": "This type represents a list of links related to currently existing subscriptions for a MEC application instance. This information is returned when sending a request to receive current subscriptions.",
776 777 778 779 780 781
        "type": "object",
        "required": [
          "_links"
        ],
        "properties": {
          "_links": {
Walter Featherstone's avatar
Walter Featherstone committed
782
            "$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList.Links"
783 784 785
          }
        }
      },
Walter Featherstone's avatar
Walter Featherstone committed
786 787 788 789 790 791 792 793 794
      "OperationActionType": {
        "description": "Operation that is being performed on the MEC application instance.",
        "type": "string",
        "enum": [
          "STOPPING",
          "TERMINATING"
        ],
        "example": "TERMINATING"
      },
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "$ref": "#/components/schemas/Problem.type"
          },
          "title": {
            "$ref": "#/components/schemas/Problem.title"
          },
          "status": {
            "$ref": "#/components/schemas/Problem.status"
          },
          "detail": {
            "$ref": "#/components/schemas/Problem.detail"
          },
          "instance": {
            "$ref": "#/components/schemas/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",
Walter Featherstone's avatar
Walter Featherstone committed
835 836
        "format": "uri",
        "description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
837
      },
Walter Featherstone's avatar
Walter Featherstone committed
838 839 840 841 842
      "ReadyIndicationType": {
        "description": "Indication about the MEC application instance.",
        "type": "string",
        "enum": [
          "READY"
843
        ],
Walter Featherstone's avatar
Walter Featherstone committed
844
        "example": "READY"
845
      },
Walter Featherstone's avatar
Walter Featherstone committed
846 847
      "Self": {
        "description": "Self-referring URI.",
848 849
        "type": "object",
        "required": [
Walter Featherstone's avatar
Walter Featherstone committed
850
          "self"
851 852
        ],
        "properties": {
Walter Featherstone's avatar
Walter Featherstone committed
853
          "self": {
854 855
            "$ref": "#/components/schemas/LinkType"
          }
Walter Featherstone's avatar
Walter Featherstone committed
856 857
        },
        "readOnly": true
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
      },
      "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"
      },
913
      "TimingCaps.NtpServers_PtpMasterIpAddress": {
914 915 916 917
        "description": "PTP Master IP Address",
        "type": "string",
        "example": "192.0.2.0"
      },
918
      "TimingCaps.NtpServers_PtpMasterLocalPriority": {
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
        "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": "#/components/schemas/TimingCaps.NtpServers.NtpServerAddrType"
          },
          "ntpServerAddr": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.NtpServerAddr"
          },
          "minPollingInterval": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.MinPollingInterval"
          },
          "maxPollingInterval": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.MaxPollingInterval"
          },
          "localPriority": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.LocalPriority"
          },
          "authenticationOption": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.AuthenticationOption"
          },
          "authenticationKeyNum": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.AuthenticationKeyNum"
          }
        }
      },
960
      "TimingCaps_PtpMasters": {
961 962 963 964 965 966 967 968 969
        "description": "NTP server detail.",
        "type": "object",
        "required": [
          "ptpMasterIpAddress",
          "ptpMasterLocalPriority",
          "delayReqMaxRate"
        ],
        "properties": {
          "ptpMasterIpAddress": {
970
            "$ref": "#/components/schemas/TimingCaps.NtpServers_PtpMasterIpAddress"
971 972
          },
          "ptpMasterLocalPriority": {
973
            "$ref": "#/components/schemas/TimingCaps.NtpServers_PtpMasterLocalPriority"
974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
          },
          "delayReqMaxRate": {
            "$ref": "#/components/schemas/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": {
Walter Featherstone's avatar
Walter Featherstone committed
1003
        "description": "This type represents the information provided by the MEC platform in response to the Timing capabilities Query message.",
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
        "type": "object",
        "properties": {
          "timeStamp": {
            "$ref": "#/components/schemas/TimingCaps.TimeStamp"
          },
          "ntpServers": {
            "description": "Available NTP servers",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TimingCaps.NtpServers"
            }
          },
          "ptpMasters": {
            "description": "Available PTP Masters",
            "type": "array",
            "items": {
1020
              "$ref": "#/components/schemas/TimingCaps_PtpMasters"
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
            }
          }
        }
      },
      "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": "#/components/schemas/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": "#/components/schemas/TrafficFilter.Address"
            }
          },
          "srcPort": {
            "description": "A port or a range of ports",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.Port"
            }
          },
          "dstPort": {
            "description": "A port or a range of ports",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.Port"
            }
          },
          "protocol": {
            "description": "Specify the protocol of the traffic filter",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.Protocol"
            }
          },
          "token": {
            "description": "Used for token based traffic rule",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.Token"
            }
          },
          "srcTunnelAddress": {
            "description": "Used for GTP tunnel based traffic rule",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.TunnelAddress"
            }
          },
          "tgtTunnelAddress": {
            "description": "Used for GTP tunnel based traffic rule",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.TunnelAddress"
            }
          },
          "srcTunnelPort": {
            "description": "Used for GTP tunnel based traffic rule",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.TunnelPort"
            }
          },
          "dstTunnelPort": {
            "description": "Used for GTP tunnel based traffic rule",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.TunnelPort"
            }
          },
          "qCI": {
            "$ref": "#/components/schemas/TrafficFilter.QCI"
          },
          "dSCP": {
            "$ref": "#/components/schemas/TrafficFilter.DSCP"
          },
          "tC": {
            "$ref": "#/components/schemas/TrafficFilter.TC"
          }
        }
      },
      "TrafficRule.Action": {
Walter Featherstone's avatar
Walter Featherstone committed
1159
        "description": "The action of the MEC host data plane when a packet matches the trafficFilter\n   ",
1160 1161 1162 1163
        "type": "string",
        "enum": [
          "DROP",
          "FORWARD_DECAPSULATED",
Walter Featherstone's avatar
Walter Featherstone committed
1164
          "FORWARD_ENCAPSULATED",
1165 1166
          "PASSTHROUGH",
          "DUPLICATE_DECAPSULATED",
Walter Featherstone's avatar
Walter Featherstone committed
1167
          "DUPLICATE_ENCAPSULATED"
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
        ],
        "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"
      },
1185
      "TrafficRule_Priority": {
1186 1187 1188 1189 1190 1191
        "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": {
Walter Featherstone's avatar
Walter Featherstone committed
1192
        "description": "Contains the traffic rule state. This attribute may be updated using HTTP PUT method",
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
        "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": "#/components/schemas/TrafficRule.Id"
          },
          "filterType": {
            "$ref": "#/components/schemas/TrafficRule.FilterType"
          },
          "priority": {
1219
            "$ref": "#/components/schemas/TrafficRule_Priority"
1220 1221
          },
          "trafficFilter": {
1222 1223 1224 1225
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter"
            }
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
          },
          "action": {
            "$ref": "#/components/schemas/TrafficRule.Action"
          },
          "dstInterface": {
            "$ref": "#/components/schemas/DestinationInterface"
          },
          "state": {
            "$ref": "#/components/schemas/TrafficRule.State"
          }
        }
      },
      "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": "#/components/schemas/TunnelInfo.TunnelType"
          },
          "tunnelDstAddress": {
            "$ref": "#/components/schemas/TunnelInfo.TunnelDstAddress"
          },
          "tunnelSrcAddress": {
            "$ref": "#/components/schemas/TunnelInfo.TunnelSrcAddress"
1272 1273 1274 1275
          }
        }
      }
    },
1276 1277 1278
    "parameters": {
      "Path.AppInstanceId": {
        "name": "appInstanceId",
Walter Featherstone's avatar
Walter Featherstone committed
1279
        "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
1280 1281 1282
        "in": "path",
        "required": true,
        "schema": {
1283 1284
          "type": "string"
        }
1285 1286 1287 1288 1289 1290 1291
      },
      "Path.DnsRuleId": {
        "name": "dnsRuleId",
        "description": "Represents a DNS rule.",
        "in": "path",
        "required": true,
        "schema": {
1292
          "type": "string"
1293
        }
1294 1295 1296
      },
      "Path.SubscriptionId": {
        "name": "subscriptionId",
Walter Featherstone's avatar
Walter Featherstone committed
1297
        "description": "Represents a subscription to the notifications from the MEC platform.",
1298 1299 1300
        "in": "path",
        "required": true,
        "schema": {
1301
          "type": "string"
1302
        }
1303 1304 1305 1306 1307 1308 1309
      },
      "Path.TrafficRuleId": {
        "name": "trafficRuleId",
        "description": "Represents a traffic rule.",
        "in": "path",
        "required": true,
        "schema": {
1310
          "type": "string"
1311 1312 1313
        }
      }
    },
1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
    "responses": {
      "ApplicationsDnsRules.200": {
        "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
        "content": {
          "application/json": {
            "schema": {
              "type": "array",
              "minItems": 0,
              "items": {
                "$ref": "#/components/schemas/DnsRule"
              }
            },
            "examples": {
              "DnsRules": {
                "$ref": "#/components/examples/DnsRules"
              }
            }
          }
1332
        },
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
        "links": {
          "getIndividualMeDNSRule": {
            "$ref": "#/components/links/GetIndividualMeDNSRule"
          },
          "putIndividualMeDNSRule": {
            "$ref": "#/components/links/PutIndividualMeDNSRule"
          }
        }
      },
      "ApplicationsDnsRule.200": {
        "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/DnsRule"
            },
            "examples": {
              "DnsRule": {
                "$ref": "#/components/examples/DnsRule"
              }
            }
          }
        }
      },
      "ApplicationsSubscriptions.200": {
        "description": "Upon success, a response body containing the list of links to the requested subscriptions is returned.",
        "content": {
          "application/json": {
            "schema": {
Walter Featherstone's avatar
Walter Featherstone committed
1362
              "$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList"
1363 1364
            }
          }
1365
        },
1366
        "links": {
Walter Featherstone's avatar
Walter Featherstone committed
1367 1368
          "getIndividualmecAppSuptApiSubscriptionLinkList": {
            "$ref": "#/components/links/GetIndividualmecAppSuptApiSubscriptionLinkList"
1369
          },
Walter Featherstone's avatar
Walter Featherstone committed
1370 1371
          "delIndividualmecAppSuptApiSubscriptionLinkList": {
            "$ref": "#/components/links/DelIndividualmecAppSuptApiSubscriptionLinkList"
1372 1373 1374 1375
          }
        }
      },
      "ApplicationsSubscriptions.201": {
Walter Featherstone's avatar
Walter Featherstone committed
1376
        "description": "Entity body in the request contains a subscription to the  MEC service availability notifications that is to be created.",
1377 1378 1379 1380 1381 1382 1383 1384
        "headers": {
          "location": {
            "description": "The resource URI of the created resource",
            "schema": {
              "type": "string",
              "format": "uri"
            }
          }
1385
        },
1386 1387 1388
        "content": {
          "application/json": {
            "schema": {
Walter Featherstone's avatar
Walter Featherstone committed
1389
              "$ref": "#/components/schemas/AppTerminationNotificationSubscription"
1390 1391
            }
          }
1392
        },
1393
        "links": {
Walter Featherstone's avatar
Walter Featherstone committed
1394 1395
          "getIndividualmecAppSuptApiSubscription": {
            "$ref": "#/components/links/GetIndividualmecAppSuptApiSubscription"
1396
          },
Walter Featherstone's avatar
Walter Featherstone committed
1397 1398
          "delIndividualmecAppSuptApiSubscription": {
            "$ref": "#/components/links/DelIndividualmecAppSuptApiSubscription"
1399 1400 1401 1402 1403 1404 1405 1406
          }
        }
      },
      "ApplicationsSubscription.200": {
        "description": "Upon success, a response body containing the requested subscription is returned.",
        "content": {
          "application/json": {
            "schema": {
Walter Featherstone's avatar
Walter Featherstone committed
1407
              "$ref": "#/components/schemas/AppTerminationNotificationSubscription"
1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428
            }
          }
        }
      },
      "ApplicationsTrafficRules.200": {
        "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
        "content": {
          "application/json": {
            "schema": {
              "type": "array",
              "minItems": 0,
              "items": {
                "$ref": "#/components/schemas/TrafficRule"
              }
            },
            "examples": {
              "TrafficRules": {
                "$ref": "#/components/examples/TrafficRules"
              }
            }
          }
1429
        },
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453
        "links": {
          "getIndividualMeTrafficRule": {
            "$ref": "#/components/links/GetIndividualMeTrafficRule"
          },
          "putIndividualMeTrafficRule": {
            "$ref": "#/components/links/PutIndividualMeTrafficRule"
          }
        }
      },
      "ApplicationsTrafficRule.200": {
        "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/TrafficRule"
            },
            "examples": {
              "TrafficRule": {
                "$ref": "#/components/examples/TrafficRule"
              }
            }
          }
        }
      },
Walter Featherstone's avatar
Walter Featherstone committed
1454
      "TimingCurrentTime.200": {
1455 1456 1457 1458
        "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
        "content": {
          "application/json": {
            "schema": {
Walter Featherstone's avatar
Walter Featherstone committed
1459
              "$ref": "#/components/schemas/CurrentTime"
1460 1461
            }
          }
1462
        }
1463
      },
Walter Featherstone's avatar
Walter Featherstone committed
1464 1465
      "TimingCaps.200": {
        "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
1466 1467 1468
        "content": {
          "application/json": {
            "schema": {
Walter Featherstone's avatar
Walter Featherstone committed
1469
              "$ref": "#/components/schemas/TimingCaps"
1470 1471
            }
          }
1472
        }
1473
      },
Walter Featherstone's avatar
Walter Featherstone committed
1474 1475
      "Error.400": {
        "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
1476
        "content": {
Walter Featherstone's avatar
Walter Featherstone committed
1477
          "application/problem+json": {
1478
            "schema": {
Walter Featherstone's avatar
Walter Featherstone committed
1479
              "$ref": "#/components/schemas/ProblemDetails"
1480
            }
Walter Featherstone's avatar
Walter Featherstone committed
1481 1482
          },
          "text/plain": {
1483
            "schema": {
Walter Featherstone's avatar
Walter Featherstone committed
1484
              "$ref": "#/components/schemas/Empty"
1485
            }
1486
          }
1487 1488
        }
      },
Walter Featherstone's avatar
Walter Featherstone committed
1489 1490
      "Error.401": {
        "description": "Unauthorized. It is used when the client did not submit the appropriate credentials.",
1491
        "content": {
Walter Featherstone's avatar
Walter Featherstone committed
1492
          "application/problem+json": {
1493
            "schema": {
Walter Featherstone's avatar
Walter Featherstone committed
1494 1495 1496 1497 1498 1499
              "$ref": "#/components/schemas/ProblemDetails"
            }
          },
          "text/plain": {
            "schema": {
              "$ref": "#/components/schemas/Empty"
1500
            }
1501 1502
          }
        }
1503
      },
Walter Featherstone's avatar
Walter Featherstone committed
1504 1505
      "Error.403": {
        "description": "Forbidden. The operation is not allowed given the current status of the resource. ",
1506
        "content": {
Walter Featherstone's avatar
Walter Featherstone committed
1507
          "application/problem+json": {
1508
            "schema": {
Walter Featherstone's avatar
Walter Featherstone committed
1509
              "$ref": "#/components/schemas/ProblemDetails"
1510
            }
1511
          }
Walter Featherstone's avatar