MecAppSupportApi.json 81.7 KB
Newer Older
1
{
piscione's avatar
piscione committed
2
  "openapi": "3.1.0",
3
  "info": {
Walter Featherstone's avatar
Walter Featherstone committed
4
    "title": "MEC Application Support API",
5
    "version": "2.2.1",
Walter Featherstone's avatar
Walter Featherstone committed
6
    "description": "The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI",
7
    "license": {
ETSI CTI's avatar
ETSI CTI committed
8
9
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
10
11
12
    },
    "contact": {
      "email": "cti_support@etsi.org"
13
14
15
    }
  },
  "externalDocs": {
16
17
    "description": "ETSI GS MEC011 Application Enablement API, V2.2.1",
    "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.02.01_60/gs_MEC011v020201p.pdf"
18
  },
19
20
  "tags": [
    {
Walter Featherstone's avatar
Walter Featherstone committed
21
      "name": "appTrafficRules"
22
    },
23
    {
Walter Featherstone's avatar
Walter Featherstone committed
24
      "name": "appDnsRules"
25
    },
26
    {
Walter Featherstone's avatar
Walter Featherstone committed
27
      "name": "appSubscriptions"
28
    },
29
    {
Walter Featherstone's avatar
Walter Featherstone committed
30
      "name": "appConfirmTermination"
31
    },
32
    {
Walter Featherstone's avatar
Walter Featherstone committed
33
      "name": "appConfirmReady"
34
    },
35
    {
Walter Featherstone's avatar
Walter Featherstone committed
36
      "name": "timing"
37
    },
38
39
    {
      "name": "callbacks"
40
    }
41
  ],
piscione's avatar
piscione committed
42
43
44
45
  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
  "servers": [
    {
      "url": "http://127.0.0.1:8081/mec_app_support/v1",
Elian Kraja's avatar
Elian Kraja committed
46
47
      "variables": {
      }
piscione's avatar
piscione committed
48
49
50
    },
    {
      "url": "https://127.0.0.1:8081/mec_app_support/v1",
Elian Kraja's avatar
Elian Kraja committed
51
52
      "variables": {
      }
piscione's avatar
piscione committed
53
54
    }
  ],
55
  "paths": {
Walter Featherstone's avatar
Walter Featherstone committed
56
    "/applications/{appInstanceId}/traffic_rules": {
57
      "get": {
58
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
59
          "appTrafficRules"
60
        ],
Elian Kraja's avatar
Elian Kraja committed
61
        "summary": "get traffic rules",
piscione's avatar
piscione committed
62
63
64
65
66
67
68
69
70
71
72
73
74
75
        "description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
        "operationId": "ApplicationsTrafficRules_GET",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
76
77
        "responses": {
          "200": {
piscione's avatar
piscione committed
78
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
Elian Kraja's avatar
Elian Kraja committed
79
80
            "headers": {
            },
piscione's avatar
piscione committed
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/TrafficRule"
                  },
                  "description": "",
                  "examples": [
                    [
                      {
                        "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",
piscione's avatar
piscione committed
111
112
113
114
115
116
117
118
119
120
121
122
                        "dstInterface": [
                          {
                            "dstInterface0": null,
                            "interfaceType": "IP",
                            "dstIpAddress": "20.1.1.1"
                          },
                          {
                            "dstInterface1": null,
                            "interfaceType": "IP",
                            "dstIpAddress": "20.1.1.2"
                          }
                        ],
piscione's avatar
piscione committed
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
                        "state": "ACTIVE"
                      }
                    ]
                  ],
                  "contentMediaType": "application/json"
                },
                "examples": {
                  "TrafficRules": {
                    "value": [
                      {
                        "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",
piscione's avatar
piscione committed
152
153
154
155
156
157
158
                        "dstInterface": [
                          {
                            "dstInterface0": null,
                            "interfaceType": "IP",
                            "dstIpAddress": "20.1.1.1"
                          }
                        ],
piscione's avatar
piscione committed
159
160
161
162
163
164
165
                        "state": "ACTIVE"
                      }
                    ]
                  }
                }
              }
            }
166
167
          },
          "400": {
piscione's avatar
piscione committed
168
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
Elian Kraja's avatar
Elian Kraja committed
169
170
            "headers": {
            },
piscione's avatar
piscione committed
171
172
173
174
175
176
177
178
179
180
181
182
183
184
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
185
186
          },
          "403": {
piscione's avatar
piscione committed
187
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
Elian Kraja's avatar
Elian Kraja committed
188
189
            "headers": {
            },
piscione's avatar
piscione committed
190
191
192
193
194
195
196
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
197
198
          },
          "404": {
piscione's avatar
piscione committed
199
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
Elian Kraja's avatar
Elian Kraja committed
200
201
            "headers": {
            },
piscione's avatar
piscione committed
202
203
204
205
206
207
208
209
210
211
212
213
214
215
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
216
          }
piscione's avatar
piscione committed
217
218
219
        },
        "deprecated": false
      },
Elian Kraja's avatar
Elian Kraja committed
220
221
222
      "parameters": [

      ]
223
    },
Walter Featherstone's avatar
Walter Featherstone committed
224
    "/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
225
      "get": {
226
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
227
          "appTrafficRules"
228
        ],
Elian Kraja's avatar
Elian Kraja committed
229
        "summary": "Get traffic rule",
piscione's avatar
piscione committed
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
        "description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
        "operationId": "ApplicationsTrafficRule_GET",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "trafficRuleId",
            "in": "path",
            "description": "Represents a traffic rule.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
254
255
        "responses": {
          "200": {
piscione's avatar
piscione committed
256
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
Elian Kraja's avatar
Elian Kraja committed
257
258
            "headers": {
            },
piscione's avatar
piscione committed
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
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrafficRule"
                },
                "examples": {
                  "TrafficRule": {
                    "value": {
                      "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",
piscione's avatar
piscione committed
286
287
288
289
290
291
292
                      "dstInterface": [
                        {
                          "dstInterface0": null,
                          "interfaceType": "IP",
                          "dstIpAddress": "20.1.1.1"
                        }
                      ],
piscione's avatar
piscione committed
293
294
295
296
297
298
                      "state": "ACTIVE"
                    }
                  }
                }
              }
            }
299
300
          },
          "400": {
piscione's avatar
piscione committed
301
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
Elian Kraja's avatar
Elian Kraja committed
302
303
            "headers": {
            },
piscione's avatar
piscione committed
304
305
306
307
308
309
310
311
312
313
314
315
316
317
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
318
319
          },
          "403": {
piscione's avatar
piscione committed
320
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
Elian Kraja's avatar
Elian Kraja committed
321
322
            "headers": {
            },
piscione's avatar
piscione committed
323
324
325
326
327
328
329
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
330
331
          },
          "404": {
piscione's avatar
piscione committed
332
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
Elian Kraja's avatar
Elian Kraja committed
333
334
            "headers": {
            },
piscione's avatar
piscione committed
335
336
337
338
339
340
341
342
343
344
345
346
347
348
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
349
          }
piscione's avatar
piscione committed
350
351
        },
        "deprecated": false
352
353
      },
      "put": {
354
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
355
          "appTrafficRules"
356
        ],
Elian Kraja's avatar
Elian Kraja committed
357
        "summary": "Update traffic rule",
piscione's avatar
piscione committed
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
        "description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
        "operationId": "ApplicationsTrafficRule_PUT",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "trafficRuleId",
            "in": "path",
            "description": "Represents a traffic rule.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "One or more updated attributes that are allowed to be changed",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TrafficRule"
              }
            }
          },
          "required": true
        },
393
394
        "responses": {
          "200": {
piscione's avatar
piscione committed
395
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
Elian Kraja's avatar
Elian Kraja committed
396
397
            "headers": {
            },
piscione's avatar
piscione committed
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
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrafficRule"
                },
                "examples": {
                  "TrafficRule": {
                    "value": {
                      "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",
piscione's avatar
piscione committed
425
426
427
428
429
430
431
                      "dstInterface": [
                        {
                          "dstInterface0": null,
                          "interfaceType": "IP",
                          "dstIpAddress": "20.1.1.1"
                        }
                      ],
piscione's avatar
piscione committed
432
433
434
435
436
437
                      "state": "ACTIVE"
                    }
                  }
                }
              }
            }
438
439
          },
          "400": {
piscione's avatar
piscione committed
440
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
Elian Kraja's avatar
Elian Kraja committed
441
442
            "headers": {
            },
piscione's avatar
piscione committed
443
444
445
446
447
448
449
450
451
452
453
454
455
456
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
457
458
          },
          "403": {
piscione's avatar
piscione committed
459
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
Elian Kraja's avatar
Elian Kraja committed
460
461
            "headers": {
            },
piscione's avatar
piscione committed
462
463
464
465
466
467
468
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
469
470
          },
          "404": {
piscione's avatar
piscione committed
471
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
Elian Kraja's avatar
Elian Kraja committed
472
473
            "headers": {
            },
piscione's avatar
piscione committed
474
475
476
477
478
479
480
481
482
483
484
485
486
487
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
488
489
          },
          "412": {
piscione's avatar
piscione committed
490
            "description": "Precondition Failed. It is used when a condition has failed during conditional requests,  e.g. when using ETags to avoid write conflicts.",
Elian Kraja's avatar
Elian Kraja committed
491
492
            "headers": {
            },
piscione's avatar
piscione committed
493
494
495
496
497
498
499
500
501
502
503
504
505
506
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
507
          }
508
        },
piscione's avatar
piscione committed
509
510
        "deprecated": false
      },
Elian Kraja's avatar
Elian Kraja committed
511
512
513
      "parameters": [

      ]
514
    },
Walter Featherstone's avatar
Walter Featherstone committed
515
    "/applications/{appInstanceId}/dns_rules": {
516
      "get": {
517
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
518
          "appDnsRules"
519
        ],
Elian Kraja's avatar
Elian Kraja committed
520
        "summary": "Get DNS rules",
piscione's avatar
piscione committed
521
522
523
524
525
526
527
528
529
530
531
532
533
534
        "description": "This method retrieves information about all the DNS rules associated with a MEC application instance.",
        "operationId": "ApplicationsDnsRules_GET",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
535
536
        "responses": {
          "200": {
piscione's avatar
piscione committed
537
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
Elian Kraja's avatar
Elian Kraja committed
538
539
            "headers": {
            },
piscione's avatar
piscione committed
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
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/DnsRule"
                  },
                  "description": "",
                  "examples": [
                    [
                      {
                        "dnsRuleId": "DnsRule1",
                        "domainName": "www.example.com",
                        "ipAddressType": "IP_V4",
                        "ipAddress": "146.241.7.3",
                        "ttl": 300,
                        "state": "ACTIVE"
                      },
                      {
                        "dnsRuleId": "DnsRule2",
                        "domainName": "www.example.com",
                        "ipAddressType": "IP_V4",
                        "ipAddress": "146.241.7.4",
                        "ttl": 300,
                        "state": "INACTIVE"
                      }
                    ]
                  ],
                  "contentMediaType": "application/json"
                },
                "examples": {
                  "DnsRules": {
                    "value": [
                      {
                        "dnsRuleId": "DnsRule1",
                        "domainName": "www.example.com",
                        "ipAddressType": "IP_V4",
                        "ipAddress": "146.241.7.3",
                        "ttl": 300,
                        "state": "ACTIVE"
                      },
                      {
                        "dnsRuleId": "DnsRule2",
                        "domainName": "www.example.com",
                        "ipAddressType": "IP_V4",
                        "ipAddress": "146.241.7.4",
                        "ttl": 300,
                        "state": "INACTIVE"
                      }
                    ]
                  }
                }
              }
            }
594
595
          },
          "400": {
piscione's avatar
piscione committed
596
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
Elian Kraja's avatar
Elian Kraja committed
597
598
            "headers": {
            },
piscione's avatar
piscione committed
599
600
601
602
603
604
605
606
607
608
609
610
611
612
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
613
614
          },
          "403": {
piscione's avatar
piscione committed
615
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
Elian Kraja's avatar
Elian Kraja committed
616
617
            "headers": {
            },
piscione's avatar
piscione committed
618
619
620
621
622
623
624
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
625
626
          },
          "404": {
piscione's avatar
piscione committed
627
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
Elian Kraja's avatar
Elian Kraja committed
628
629
            "headers": {
            },
piscione's avatar
piscione committed
630
631
632
633
634
635
636
637
638
639
640
641
642
643
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
644
          }
piscione's avatar
piscione committed
645
646
647
        },
        "deprecated": false
      },
Elian Kraja's avatar
Elian Kraja committed
648
649
650
      "parameters": [

      ]
651
    },
Walter Featherstone's avatar
Walter Featherstone committed
652
    "/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
653
      "get": {
654
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
655
          "appDnsRules"
656
        ],
Elian Kraja's avatar
Elian Kraja committed
657
        "summary": "Get DNS rule",
piscione's avatar
piscione committed
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
        "description": "This method retrieves information about a DNS rule associated with a MEC application instance.",
        "operationId": "ApplicationsDnsRule_GET",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "dnsRuleId",
            "in": "path",
            "description": "Represents a DNS rule.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
682
683
        "responses": {
          "200": {
piscione's avatar
piscione committed
684
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
Elian Kraja's avatar
Elian Kraja committed
685
686
            "headers": {
            },
piscione's avatar
piscione committed
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DnsRule"
                },
                "examples": {
                  "DnsRule": {
                    "value": {
                      "dnsRuleId": "DnsRule1",
                      "domainName": "www.example.com",
                      "ipAddressType": "IP_V4",
                      "ipAddress": "146.241.7.3",
                      "ttl": 300,
                      "state": "ACTIVE"
                    }
                  }
                }
              }
            }
706
707
          },
          "400": {
piscione's avatar
piscione committed
708
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
Elian Kraja's avatar
Elian Kraja committed
709
710
            "headers": {
            },
piscione's avatar
piscione committed
711
712
713
714
715
716
717
718
719
720
721
722
723
724
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
725
726
          },
          "403": {
piscione's avatar
piscione committed
727
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
Elian Kraja's avatar
Elian Kraja committed
728
729
            "headers": {
            },
piscione's avatar
piscione committed
730
731
732
733
734
735
736
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
737
738
          },
          "404": {
piscione's avatar
piscione committed
739
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
Elian Kraja's avatar
Elian Kraja committed
740
741
            "headers": {
            },
piscione's avatar
piscione committed
742
743
744
745
746
747
748
749
750
751
752
753
754
755
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
756
          }
piscione's avatar
piscione committed
757
758
        },
        "deprecated": false
759
      },
Walter Featherstone's avatar
Walter Featherstone committed
760
      "put": {
761
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
762
          "appDnsRules"
763
        ],
Elian Kraja's avatar
Elian Kraja committed
764
        "summary": "Update DNS rule",
piscione's avatar
piscione committed
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
        "description": "This method activates, de-activates or updates a traffic rule.",
        "operationId": "ApplicationsDnsRule_PUT",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "dnsRuleId",
            "in": "path",
            "description": "Represents a DNS rule.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "The updated state is included in the entity body of the request.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DnsRule"
              }
            }
          },
          "required": true
        },
800
801
        "responses": {
          "200": {
piscione's avatar
piscione committed
802
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
Elian Kraja's avatar
Elian Kraja committed
803
804
            "headers": {
            },
piscione's avatar
piscione committed
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DnsRule"
                },
                "examples": {
                  "DnsRule": {
                    "value": {
                      "dnsRuleId": "DnsRule1",
                      "domainName": "www.example.com",
                      "ipAddressType": "IP_V4",
                      "ipAddress": "146.241.7.3",
                      "ttl": 300,
                      "state": "ACTIVE"
                    }
                  }
                }
              }
            }
824
825
          },
          "400": {
piscione's avatar
piscione committed
826
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
Elian Kraja's avatar
Elian Kraja committed
827
828
            "headers": {
            },
piscione's avatar
piscione committed
829
830
831
832
833
834
835
836
837
838
839
840
841
842
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
843
844
          },
          "403": {
piscione's avatar
piscione committed
845
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
Elian Kraja's avatar
Elian Kraja committed
846
847
            "headers": {
            },
piscione's avatar
piscione committed
848
849
850
851
852
853
854
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
855
856
          },
          "404": {
piscione's avatar
piscione committed
857
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
Elian Kraja's avatar
Elian Kraja committed
858
859
            "headers": {
            },
piscione's avatar
piscione committed
860
861
862
863
864
865
866
867
868
869
870
871
872
873
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
Walter Featherstone's avatar
Walter Featherstone committed
874
875
          },
          "412": {
piscione's avatar
piscione committed
876
            "description": "Precondition Failed. It is used when a condition has failed during conditional requests,  e.g. when using ETags to avoid write conflicts.",
Elian Kraja's avatar
Elian Kraja committed
877
878
            "headers": {
            },
piscione's avatar
piscione committed
879
880
881
882
883
884
885
886
887
888
889
890
891
892
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
893
          }
Walter Featherstone's avatar
Walter Featherstone committed
894
        },
piscione's avatar
piscione committed
895
896
        "deprecated": false
      },
Elian Kraja's avatar
Elian Kraja committed
897
898
899
      "parameters": [

      ]
900
    },
Walter Featherstone's avatar
Walter Featherstone committed
901
    "/applications/{appInstanceId}/subscriptions": {
902
      "get": {
903
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
904
          "appSubscriptions"
905
        ],
Elian Kraja's avatar
Elian Kraja committed
906
        "summary": "Get subscriptions",
piscione's avatar
piscione committed
907
908
909
910
911
912
913
914
915
916
917
918
919
920
        "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",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
921
922
        "responses": {
          "200": {
piscione's avatar
piscione committed
923
            "description": "Upon success, a response body containing the list of links to the requested subscriptions is returned.",
Elian Kraja's avatar
Elian Kraja committed
924
925
            "headers": {
            },
piscione's avatar
piscione committed
926
927
928
929
930
931
932
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList"
                }
              }
            }
933
934
          },
          "400": {
piscione's avatar
piscione committed
935
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
Elian Kraja's avatar
Elian Kraja committed
936
937
            "headers": {
            },
piscione's avatar
piscione committed
938
939
940
941
942
943
944
945
946
947
948
949
950
951
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
952
953
          },
          "403": {
piscione's avatar
piscione committed
954
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
Elian Kraja's avatar
Elian Kraja committed
955
956
            "headers": {
            },
piscione's avatar
piscione committed
957
958
959
960
961
962
963
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
964
965
          },
          "404": {
piscione's avatar
piscione committed
966
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
Elian Kraja's avatar
Elian Kraja committed
967
968
            "headers": {
            },
piscione's avatar
piscione committed
969
970
971
972
973
974
975
976
977
978
979
980
981
982
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
983
          }
piscione's avatar
piscione committed
984
985
        },
        "deprecated": false
986
      },
Walter Featherstone's avatar
Walter Featherstone committed
987
      "post": {
988
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
989
          "appSubscriptions"
990
        ],
Elian Kraja's avatar
Elian Kraja committed
991
        "summary": "Create subscription",
piscione's avatar
piscione committed
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
        "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",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Entity body in the request contains a subscription to the MEC application termination notifications that is to be created.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppTerminationNotificationSubscription"
              }
            }
          },
          "required": true
        },
1017
        "responses": {
Walter Featherstone's avatar
Walter Featherstone committed
1018
          "201": {
piscione's avatar
piscione committed
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
            "description": "Entity body in the request contains a subscription to the  MEC service availability notifications that is to be created.",
            "headers": {
              "location": {
                "description": "The resource URI of the created resource",
                "content": {
                  "text/plain": {
                    "schema": {
                      "type": "string",
                      "description": "The resource URI of the created resource",
                      "contentMediaType": "text/plain"
                    }
                  }
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppTerminationNotificationSubscription"
                }
              }
            }
1041
1042
          },
          "400": {
piscione's avatar
piscione committed
1043
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
Elian Kraja's avatar
Elian Kraja committed
1044
1045
            "headers": {
            },
piscione's avatar
piscione committed
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
1060
1061
          },
          "403": {
piscione's avatar
piscione committed
1062
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
Elian Kraja's avatar
Elian Kraja committed
1063
1064
            "headers": {
            },
piscione's avatar
piscione committed
1065
1066
1067
1068
1069
1070
1071
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
1072
1073
          },
          "404": {
piscione's avatar
piscione committed
1074
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
Elian Kraja's avatar
Elian Kraja committed
1075
1076
            "headers": {
            },
piscione's avatar
piscione committed
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
1091
          }
1092
        },
piscione's avatar
piscione committed
1093
        "deprecated": false,
Walter Featherstone's avatar
Walter Featherstone committed
1094
        "callbacks": {
piscione's avatar
piscione committed
1095
1096
1097
1098
1099
1100
1101
1102
          "AppTerminationNotification": {
            "{$request.body#/callbackUri}": {
              "post": {
                "description": "Represents the information that the MEP notifies the subscribed application instance about the corresponding application instance termination/stop'",
                "operationId": "AppTerminationNotification_POST",
                "tags": [
                  "callbacks"
                ],
Elian Kraja's avatar
Elian Kraja committed
1103
                "summary": "Create callback",
piscione's avatar
piscione committed
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
                "requestBody": {
                  "$ref": "#/components/requestBodies/AppTerminationNotification"
                },
                "responses": {
                  "200": {
                    "description": "Expected responses from callback consumer, if it accepts the callback"
                  }
                }
              }
            }
Walter Featherstone's avatar
Walter Featherstone committed
1114
          }
1115
        }
piscione's avatar
piscione committed
1116
      },
Elian Kraja's avatar
Elian Kraja committed
1117
1118
1119
      "parameters": [

      ]
1120
    },
Walter Featherstone's avatar
Walter Featherstone committed
1121
    "/applications/{appInstanceId}/subscriptions/{subscriptionId}": {
1122
      "get": {
1123
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
1124
          "appSubscriptions"
1125
        ],
Elian Kraja's avatar
Elian Kraja committed
1126
        "summary": "Get subscription",
piscione's avatar
piscione committed
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
        "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",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Represents a subscription to the notifications from the MEC platform.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
1151
1152
        "responses": {
          "200": {
piscione's avatar
piscione committed
1153
            "description": "Upon success, a response body containing the requested subscription is returned.",
Elian Kraja's avatar
Elian Kraja committed
1154
1155
            "headers": {
            },
piscione's avatar
piscione committed
1156
1157
1158
1159
1160
1161
1162
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppTerminationNotificationSubscription"
                }
              }
            }
1163
1164
          },
          "400": {
piscione's avatar
piscione committed
1165
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
Elian Kraja's avatar
Elian Kraja committed
1166
1167
            "headers": {
            },
piscione's avatar
piscione committed
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
1182
1183
          },
          "403": {
piscione's avatar
piscione committed
1184
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
Elian Kraja's avatar
Elian Kraja committed
1185
1186
            "headers": {
            },
piscione's avatar
piscione committed
1187
1188
1189
1190
1191
1192
1193
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
1194
1195
          },
          "404": {
piscione's avatar
piscione committed
1196
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
Elian Kraja's avatar
Elian Kraja committed
1197
1198
            "headers": {
            },
piscione's avatar
piscione committed
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
1213
          }
piscione's avatar
piscione committed
1214
1215
        },
        "deprecated": false
1216
      },
Walter Featherstone's avatar
Walter Featherstone committed
1217
      "delete": {
1218
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
1219
          "appSubscriptions"
1220
        ],
Elian Kraja's avatar
Elian Kraja committed
1221
        "summary": "delete subscription",
piscione's avatar
piscione committed
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
        "description": "This method deletes a mecAppSuptApiSubscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
        "operationId": "ApplicationsSubscription_DELETE",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "subscriptionId",
            "in": "path",
            "description": "Represents a subscription to the notifications from the MEC platform.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
1244
          }
piscione's avatar
piscione committed
1245
1246
1247
1248
        ],
        "responses": {
          "204": {
            "description": "No Content",
Elian Kraja's avatar
Elian Kraja committed
1249
1250
1251
1252
            "headers": {
            },
            "content": {
            }
piscione's avatar
piscione committed
1253
1254
1255
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
Elian Kraja's avatar
Elian Kraja committed
1256
1257
            "headers": {
            },
piscione's avatar
piscione committed
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
Elian Kraja's avatar
Elian Kraja committed
1268
1269
            "headers": {
            },
piscione's avatar
piscione committed
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
Elian Kraja's avatar
Elian Kraja committed
1288
1289
1290
      "parameters": [

      ]
1291
    },
Walter Featherstone's avatar
Walter Featherstone committed
1292
1293
    "/applications/{appInstanceId}/confirm_termination": {
      "post": {
1294
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
1295
          "appConfirmTermination"
1296
        ],
Elian Kraja's avatar
Elian Kraja committed
1297
        "summary": "Confirm termination",
piscione's avatar
piscione committed
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
        "description": "This method is used to confirm the application level termination  of an application instance.",
        "operationId": "ApplicationsConfirmTermination_POST",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AppTerminationConfirmation"
              }
            }
          },
          "required": false
        },
1323
        "responses": {
Walter Featherstone's avatar
Walter Featherstone committed
1324
          "204": {
piscione's avatar
piscione committed
1325
            "description": "No Content",
Elian Kraja's avatar
Elian Kraja committed
1326
1327
1328
1329
            "headers": {
            },
            "content": {
            }
1330
          },
Walter Featherstone's avatar
Walter Featherstone committed
1331
          "401": {
piscione's avatar
piscione committed
1332
            "description": "Unauthorized. It is used when the client did not submit the appropriate credentials.",
Elian Kraja's avatar
Elian Kraja committed
1333
1334
            "headers": {
            },
piscione's avatar
piscione committed
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
1349
1350
          },
          "403": {