Mp1.json 86.9 KB
Newer Older
1
{
2
  "openapi": "3.0.2",
3
4
  "servers": [
    {
5
      "url": "http://127.0.0.1:8081/mp1/v1"
6
7
    },
    {
8
      "url": "https://127.0.0.1:8081/mp1/v1"
9
10
    }
  ],
11
12
  "info": {
    "title": "Mp1 API",
Walter Featherstone's avatar
Walter Featherstone committed
13
    "version": "2.0.5",
14
15
16
17
    "description": "The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI",
    "license": {
      "name": "ETSI Forge copyright notice",
      "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
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.0.5",
    "url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv205.zip"
26
  },
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
  "tags": [
    {
      "name": "trafficRules"
    },
    {
      "name": "dnsRules"
    },
    {
      "name": "subscriptions"
    },
    {
      "name": "services"
    },
    {
      "name": "timing"
    },
    {
      "name": "transports"
    },
    {
      "name": "callbacks"
    }
  ],
50
51
52
53
  "paths": {
    "/applications/{appInstanceId}/dns_rules": {
      "parameters": [
        {
54
          "$ref": "#/components/parameters/Path.AppInstanceId"
55
56
57
58
        }
      ],
      "get": {
        "description": "This method retrieves information about all the DNS rules associated with a mobile edge application instance.",
59
        "operationId": "ApplicationsDnsRules_GET",
60
61
62
        "tags": [
          "trafficRules"
        ],
63
64
        "responses": {
          "200": {
65
            "$ref": "#/components/responses/ApplicationsDnsRules.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
79
80
81
          }
        }
      }
    },
    "/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
      "parameters": [
        {
82
          "$ref": "#/components/parameters/Path.AppInstanceId"
83
84
        },
        {
85
          "$ref": "#/components/parameters/Path.DnsRuleId"
86
87
88
89
        }
      ],
      "get": {
        "description": "This method retrieves information about a DNS rule associated with a mobile edge application instance.",
90
        "operationId": "ApplicationsDnsRule_GET",
91
92
93
        "tags": [
          "dnsRules"
        ],
94
95
        "responses": {
          "200": {
96
            "$ref": "#/components/responses/ApplicationsDnsRule.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
110
          }
        }
      },
      "put": {
        "description": "This method activates, de-activates or updates a traffic rule.",
111
        "operationId": "ApplicationsDnsRule_PUT",
112
113
114
        "tags": [
          "dnsRules"
        ],
115
116
        "responses": {
          "200": {
117
            "$ref": "#/components/responses/ApplicationsDnsRule.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
133
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ApplicationsDnsRule"
134
135
136
137
138
139
        }
      }
    },
    "/applications/{appInstanceId}/subscriptions": {
      "parameters": [
        {
140
          "$ref": "#/components/parameters/Path.AppInstanceId"
141
142
143
144
        }
      ],
      "get": {
        "description": "The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains entity body with all the subscriptions for the requestor.",
145
        "operationId": "ApplicationsSubscriptions_GET",
146
147
148
        "tags": [
          "subscriptions"
        ],
149
150
        "responses": {
          "200": {
151
            "$ref": "#/components/responses/ApplicationsSubscriptions.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
165
          }
        }
      },
      "post": {
        "description": "The POST method may be used to create a new subscription. One example use case is to create a new subscription to the mobile edge service availability notifications. Upon success, the response contains entity body describing the created subscription.",
166
        "operationId": "ApplicationsSubscriptions_POST",
167
168
169
        "tags": [
          "subscriptions"
        ],
170
171
        "responses": {
          "201": {
172
            "$ref": "#/components/responses/ApplicationsSubscriptions.201"
173
174
          },
          "400": {
175
            "$ref": "#/components/responses/Error.400"
176
177
          },
          "403": {
178
            "$ref": "#/components/responses/Error.403"
179
180
          },
          "404": {
181
182
183
184
185
186
187
188
189
190
191
192
            "$ref": "#/components/responses/Error.404"
          }
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ApplicationsSubscriptions"
        },
        "callbacks": {
          "appTerminationNotification": {
            "$ref": "#/components/callbacks/AppTerminationNotification"
          },
          "serviceAvailabilityNotification": {
            "$ref": "#/components/callbacks/ServiceAvailabilityNotification"
193
194
195
196
197
198
199
          }
        }
      }
    },
    "/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}": {
      "parameters": [
        {
200
          "$ref": "#/components/parameters/Path.AppInstanceId"
201
202
        },
        {
203
          "$ref": "#/components/parameters/Path.SubscriptionType"
204
205
        },
        {
206
          "$ref": "#/components/parameters/Path.SubscriptionId"
207
208
209
210
        }
      ],
      "get": {
        "description": "The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.",
211
        "operationId": "ApplicationsSubscription_GET",
212
213
214
        "tags": [
          "subscriptions"
        ],
215
216
        "responses": {
          "200": {
217
            "$ref": "#/components/responses/ApplicationsSubscription.200"
218
219
          },
          "400": {
220
            "$ref": "#/components/responses/Error.400"
221
222
          },
          "403": {
223
            "$ref": "#/components/responses/Error.403"
224
225
          },
          "404": {
226
            "$ref": "#/components/responses/Error.404"
227
228
229
230
231
          }
        }
      },
      "delete": {
        "description": "This method deletes a meMp1Subscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
232
        "operationId": "ApplicationsSubscription_DELETE",
233
234
235
        "tags": [
          "subscriptions"
        ],
236
237
238
239
240
        "responses": {
          "204": {
            "description": "No Content"
          },
          "403": {
241
            "$ref": "#/components/responses/Error.403"
242
243
          },
          "404": {
244
            "$ref": "#/components/responses/Error.404"
245
246
247
248
249
250
251
          }
        }
      }
    },
    "/applications/{appInstanceId}/traffic_rules": {
      "parameters": [
        {
252
          "$ref": "#/components/parameters/Path.AppInstanceId"
253
254
255
256
        }
      ],
      "get": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
257
        "operationId": "ApplicationsTrafficRules_GET",
258
259
260
        "tags": [
          "trafficRules"
        ],
261
262
        "responses": {
          "200": {
263
            "$ref": "#/components/responses/ApplicationsTrafficRules.200"
264
265
          },
          "400": {
266
            "$ref": "#/components/responses/Error.400"
267
268
          },
          "403": {
269
            "$ref": "#/components/responses/Error.403"
270
271
          },
          "404": {
272
            "$ref": "#/components/responses/Error.404"
273
274
275
276
277
278
279
          }
        }
      }
    },
    "/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
      "parameters": [
        {
280
          "$ref": "#/components/parameters/Path.AppInstanceId"
281
282
        },
        {
283
          "$ref": "#/components/parameters/Path.TrafficRuleId"
284
285
286
287
        }
      ],
      "get": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
288
        "operationId": "ApplicationsTrafficRule_GET",
289
290
291
        "tags": [
          "trafficRules"
        ],
292
293
        "responses": {
          "200": {
294
            "$ref": "#/components/responses/ApplicationsTrafficRule.200"
295
296
          },
          "400": {
297
            "$ref": "#/components/responses/Error.400"
298
299
          },
          "403": {
300
            "$ref": "#/components/responses/Error.403"
301
302
          },
          "404": {
303
            "$ref": "#/components/responses/Error.404"
304
305
306
307
308
          }
        }
      },
      "put": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
309
        "operationId": "ApplicationsTrafficRule_PUT",
310
311
312
        "tags": [
          "trafficRules"
        ],
313
314
        "responses": {
          "200": {
315
            "$ref": "#/components/responses/ApplicationsTrafficRule.200"
316
317
          },
          "400": {
318
            "$ref": "#/components/responses/Error.400"
319
320
          },
          "403": {
321
            "$ref": "#/components/responses/Error.403"
322
323
          },
          "404": {
324
            "$ref": "#/components/responses/Error.404"
325
326
          },
          "412": {
327
            "$ref": "#/components/responses/Error.412"
328
          }
329
330
331
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ApplicationsTrafficRule"
332
333
334
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
335
336
337
338
339
340
    "/applications/{appInstanceId}/services": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Path.AppInstanceId"
        }
      ],
341
342
      "get": {
        "description": "This method retrieves information about a list of meService resources. This method is typically used in \"service availability query\" procedure",
Walter Featherstone's avatar
Walter Featherstone committed
343
        "operationId": "AppServices_GET",
344
345
346
        "tags": [
          "services"
        ],
347
348
        "parameters": [
          {
349
            "$ref": "#/components/parameters/Query.Ser_instance_id"
350
351
          },
          {
352
            "$ref": "#/components/parameters/Query.Ser_name"
353
354
          },
          {
355
            "$ref": "#/components/parameters/Query.Ser_category_id"
Walter Featherstone's avatar
Walter Featherstone committed
356
357
358
359
360
361
362
363
364
          },
          {
            "$ref": "#/components/parameters/Query.Consumed_local_only"
          },
          {
            "$ref": "#/components/parameters/Query.Is_local"
          },
          {
            "$ref": "#/components/parameters/Query.LocalityTypes"
365
366
367
368
          }
        ],
        "responses": {
          "200": {
369
            "$ref": "#/components/responses/Services.200"
370
371
          },
          "400": {
372
            "$ref": "#/components/responses/Error.400"
373
374
          },
          "403": {
375
            "$ref": "#/components/responses/Error.403"
376
377
          },
          "404": {
378
            "$ref": "#/components/responses/Error.404"
379
380
381
382
383
          }
        }
      },
      "post": {
        "description": "This method is used to create a meService resource. This method is typically used in \"service availability update and new service registration\" procedure",
Walter Featherstone's avatar
Walter Featherstone committed
384
        "operationId": "AppServices_POST",
385
386
387
        "tags": [
          "services"
        ],
388
389
        "responses": {
          "201": {
390
            "$ref": "#/components/responses/Services.201"
391
392
          },
          "400": {
393
            "$ref": "#/components/responses/Error.400"
394
395
          },
          "403": {
396
            "$ref": "#/components/responses/Error.403"
397
398
          },
          "404": {
399
            "$ref": "#/components/responses/Error.404"
400
          }
401
402
        },
        "requestBody": {
403
          "$ref": "#/components/requestBodies/Services.Post"
404
405
406
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
407
    "/applications/{appInstanceId}/services/{serviceId}": {
408
      "parameters": [
Walter Featherstone's avatar
Walter Featherstone committed
409
410
411
        {
          "$ref": "#/components/parameters/Path.AppInstanceId"
        },
412
        {
413
          "$ref": "#/components/parameters/Path.ServiceId"
414
415
416
417
        }
      ],
      "get": {
        "description": "This method retrieves information about a meService resource. This method is typically used in \"service availability query\" procedure",
Walter Featherstone's avatar
Walter Featherstone committed
418
        "operationId": "AppServicesServiceId_GET",
419
420
421
        "tags": [
          "services"
        ],
422
423
        "responses": {
          "200": {
424
            "$ref": "#/components/responses/ServicesServiceId.200"
425
426
          },
          "400": {
427
            "$ref": "#/components/responses/Error.400"
428
429
          },
          "403": {
430
            "$ref": "#/components/responses/Error.403"
431
432
          },
          "404": {
433
            "$ref": "#/components/responses/Error.404"
434
435
436
437
438
          }
        }
      },
      "put": {
        "description": "This method updates the information about a meService resource",
Walter Featherstone's avatar
Walter Featherstone committed
439
        "operationId": "AppServicesServiceId_PUT",
440
441
442
        "tags": [
          "services"
        ],
443
444
        "responses": {
          "200": {
445
            "$ref": "#/components/responses/ServicesServiceId.200"
446
447
          },
          "400": {
448
            "$ref": "#/components/responses/Error.400"
449
450
          },
          "403": {
451
            "$ref": "#/components/responses/Error.403"
452
453
          },
          "404": {
454
            "$ref": "#/components/responses/Error.404"
455
456
          },
          "412": {
457
            "$ref": "#/components/responses/Error.412"
458
          }
459
460
461
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ServicesServiceId"
462
463
464
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
    "/services": {
      "get": {
        "description": "This method retrieves information about a list of meService resources. This method is typically used in \"service availability query\" procedure",
        "operationId": "Services_GET",
        "parameters": [
          {
            "$ref": "#/components/parameters/Query.Ser_instance_id"
          },
          {
            "$ref": "#/components/parameters/Query.Ser_name"
          },
          {
            "$ref": "#/components/parameters/Query.Ser_category_id"
          },
          {
            "$ref": "#/components/parameters/Query.Consumed_local_only"
          },
          {
            "$ref": "#/components/parameters/Query.Is_local"
          },
          {
            "$ref": "#/components/parameters/Query.LocalityTypes"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/Services.200"
          },
          "400": {
            "$ref": "#/components/responses/Error.400"
          },
          "403": {
            "$ref": "#/components/responses/Error.403"
          },
          "404": {
            "$ref": "#/components/responses/Error.404"
          }
        }
      }
    },
    "/services/{serviceId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Path.ServiceId"
        }
      ],
      "get": {
        "description": "This method retrieves information about a meService resource. This method is typically used in \"service availability query\" procedure",
        "operationId": "ServicesServiceId_GET",
        "responses": {
          "200": {
            "$ref": "#/components/responses/ServicesServiceId.200"
          },
          "400": {
            "$ref": "#/components/responses/Error.400"
          },
          "403": {
            "$ref": "#/components/responses/Error.403"
          },
          "404": {
            "$ref": "#/components/responses/Error.404"
          }
        }
      }
    },
530
531
532
    "/timing/current_time": {
      "get": {
        "description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure",
533
        "operationId": "TimingCurrentTime_GET",
534
535
536
        "tags": [
          "timing"
        ],
537
538
        "responses": {
          "200": {
539
            "$ref": "#/components/responses/TimingCurrentTime.200"
540
541
          },
          "400": {
542
            "$ref": "#/components/responses/Error.400"
543
544
          },
          "403": {
545
            "$ref": "#/components/responses/Error.403"
546
547
          },
          "404": {
548
            "$ref": "#/components/responses/Error.404"
549
550
551
552
553
554
555
          }
        }
      }
    },
    "/timing/timing_caps": {
      "get": {
        "description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query",
556
        "operationId": "TimingCaps_GET",
557
558
559
        "tags": [
          "timing"
        ],
560
561
        "responses": {
          "200": {
562
            "$ref": "#/components/responses/TimingCaps.200"
563
564
          },
          "400": {
565
            "$ref": "#/components/responses/Error.400"
566
567
          },
          "403": {
568
            "$ref": "#/components/responses/Error.403"
569
570
          },
          "404": {
571
            "$ref": "#/components/responses/Error.404"
572
573
574
575
576
577
578
          }
        }
      }
    },
    "/transports": {
      "get": {
        "description": "This method retrieves information about a list of available transports. This method is typically used by a service-producing application to discover transports provided by the mobile edge platform in the \"transport information query\" procedure",
579
        "operationId": "Transports_GET",
580
581
582
        "tags": [
          "transports"
        ],
583
584
        "responses": {
          "200": {
585
            "$ref": "#/components/responses/Transports.200"
586
587
          },
          "400": {
588
            "$ref": "#/components/responses/Error.400"
589
590
          },
          "403": {
591
            "$ref": "#/components/responses/Error.403"
592
593
          },
          "404": {
594
            "$ref": "#/components/responses/Error.404"
595
596
597
598
599
          }
        }
      }
    }
  },
600
601
602
603
604
605
606
  "components": {
    "schemas": {
      "Empty": {
        "description": "Empty schema"
      },
      "AppTerminationNotification.MaxGracefulTimeout": {
        "description": "Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.",
607
        "type": "integer",
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
        "format": "uint32",
        "example": 10
      },
      "AppTerminationNotification.NotificationType": {
        "description": "Shall be set to AppTerminationNotification.",
        "type": "string",
        "example": "AppTerminationNotification"
      },
      "AppTerminationNotification": {
        "description": "This type represents the information that the mobile edge platform notifies the subscribed application instance about  the corresponding application instance termination/stop.",
        "type": "object",
        "required": [
          "notificationType",
          "maxGracefulTimeout",
          "_links"
        ],
        "properties": {
          "notificationType": {
            "$ref": "#/components/schemas/AppTerminationNotification.NotificationType"
          },
          "maxGracefulTimeout": {
            "$ref": "#/components/schemas/AppTerminationNotification.MaxGracefulTimeout"
          },
          "_links": {
            "$ref": "#/components/schemas/Subscription"
          }
634
        }
635
636
637
638
639
640
641
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
      },
      "AppTerminationNotificationSubscription.AppInstanceId": {
        "description": "It is used as the filtering criterion for the subscribed events.",
        "type": "string",
        "example": "ID1"
      },
      "AppTerminationNotificationSubscription.CallbackReference": {
        "description": "URI selected by the mobile edge application instance to receive notifications on the subscribed mobile edge application instance management information. This shall be included in both the request and the response.",
        "type": "string",
        "format": "uri"
      },
      "AppTerminationNotificationSubscription": {
        "description": "This type represents the information that the mobile edge platform notifies the subscribed application instance about  the corresponding application instance termination/stop.",
        "type": "object",
        "required": [
          "subscriptionType",
          "callbackReference",
          "_links",
          "appInstanceId"
        ],
        "properties": {
          "subscriptionType": {
            "$ref": "#/components/schemas/AppTerminationNotificationSubscription.SubscriptionType"
          },
          "callbackReference": {
            "$ref": "#/components/schemas/AppTerminationNotificationSubscription.CallbackReference"
          },
          "_links": {
            "$ref": "#/components/schemas/Self"
          },
          "appInstanceId": {
            "$ref": "#/components/schemas/AppTerminationNotificationSubscription.AppInstanceId"
          }
668
        }
669
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
712
713
714
715
716
      },
      "AppTerminationNotificationSubscription.SubscriptionType": {
        "description": "Shall be set to AppTerminationNotificationSubscription.",
        "type": "string",
        "example": "AppTerminationNotificationSubscription"
      },
      "CategoryRef.Href": {
        "description": "Reference of the catalogue",
        "type": "string",
        "example": "catItem1"
      },
      "CategoryRef.Id": {
        "description": "Unique identifier of the category",
        "type": "string",
        "example": "id12345"
      },
      "CategoryRef.Name": {
        "description": "Name of the category",
        "type": "string",
        "example": "RNI"
      },
      "CategoryRef.Version": {
        "description": "Category version",
        "type": "string",
        "example": "version1"
      },
      "CategoryRef": {
        "description": "This type represents the category reference",
        "type": "object",
        "required": [
          "href",
          "id",
          "name",
          "version"
        ],
        "properties": {
          "href": {
            "$ref": "#/components/schemas/CategoryRef.Href"
          },
          "id": {
            "$ref": "#/components/schemas/CategoryRef.Id"
          },
          "name": {
            "$ref": "#/components/schemas/CategoryRef.Name"
          },
          "version": {
            "$ref": "#/components/schemas/CategoryRef.Version"
          }
717
        }
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
      },
      "CurrentTime": {
        "description": "This type represents the information provided by the mobile edge platform in response to the Get Platform Time Request message.",
        "type": "object",
        "required": [
          "nanoSeconds",
          "seconds",
          "timeSourceStatus"
        ],
        "properties": {
          "seconds": {
            "type": "integer",
            "format": "uint32",
            "description": "The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
            "example": 1577836800
          },
          "nanoSeconds": {
            "type": "integer",
            "format": "uint32",
            "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
            "example": 0
          },
          "timeSourceStatus": {
            "type": "string",
            "enum": [
              "TRACEABLE",
              "NONTRACEABLE"
            ],
            "description": "Platform Time Source status. 1 = TRACEABLE - time source is locked to the UTC time source. 2 = NONTRACEABLE - time source is not locked to the UTC time source",
            "example": "TRACEABLE"
          }
749
        }
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
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
      },
      "DestinationInterface.InterfaceType": {
        "description": "Type of the interface",
        "type": "string",
        "enum": [
          "TUNNEL",
          "MAC",
          "IP"
        ],
        "example": "TUNNEL"
      },
      "DestinationInterface.IpAddress": {
        "description": "IP address of the remote destination",
        "type": "string",
        "example": "192.0.2.0"
      },
      "DestinationInterface.MacAddress": {
        "description": "Source address identifies the MAC address of the interface",
        "type": "string",
        "example": "02-00-00-00-00-00"
      },
      "DestinationInterface": {
        "description": "This type represents the destination interface.",
        "type": "object",
        "required": [
          "interfaceType"
        ],
        "properties": {
          "interfaceType": {
            "$ref": "#/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"
          }
793
        }
794
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
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
      },
      "DnsRule.DomainName": {
        "description": "FQDN resolved by the DNS rule",
        "type": "string",
        "example": "www.example.com"
      },
      "DnsRule.Id": {
        "description": "Identifies the DNS Rule",
        "type": "string",
        "example": "dnsRule1"
      },
      "DnsRule.IpAddress": {
        "description": "IP address associated with the FQDN resolved by the DNS rule",
        "type": "string",
        "example": "192.0.2.0"
      },
      "DnsRule.IpAddressType": {
        "description": "IP address type",
        "type": "string",
        "enum": [
          "IP_V6",
          "IP_V4"
        ],
        "example": "IP_V6"
      },
      "DnsRule.State": {
        "description": "DNS rule state",
        "type": "string",
        "enum": [
          "ACTIVE",
          "INACTIVE"
        ],
        "example": "ACTIVE"
      },
      "DnsRule.Ttl": {
        "description": "Time to live value",
        "type": "integer",
        "format": "uint32",
        "example": "?"
      },
      "DnsRule": {
        "description": "This type represents the general information of a DNS rule.",
        "type": "object",
        "required": [
          "dnsRuleId",
          "domainName",
          "ipAddressType",
          "ipAddress",
          "state"
        ],
        "properties": {
          "dnsRuleId": {
            "$ref": "#/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"
          }
863
        }
864
865
866
867
868
869
      },
      "EndPointInfo.Address.Host": {
        "description": "Host portion of the address",
        "type": "string",
        "example": "192.0.2.0"
      },
870
      "EndPointInfo.Address_Port": {
871
872
873
        "description": "Port portion of the address",
        "type": "integer",
        "format": "uint32",
874
        "example": 8080
875
876
877
878
      },
      "EndPointInfo.Address": {
        "description": "A IP address and port pair",
        "type": "object",
879
880
881
882
        "required": [
          "host",
          "port"
        ],
883
884
885
886
887
        "properties": {
          "host": {
            "$ref": "#/components/schemas/EndPointInfo.Address.Host"
          },
          "port": {
888
            "$ref": "#/components/schemas/EndPointInfo.Address_Port"
889
          }
890
        }
891
892
893
      },
      "EndPointInfo.Addresses": {
        "description": "Entry point information of the service as one or more pairs of IP address and port",
894
895
896
897
898
899
900
901
902
903
904
905
        "type": "object",
        "required": [
          "addresses"
        ],
        "properties": {
          "addresses": {
            "type": "array",
            "minItems": 0,
            "items": {
              "$ref": "#/components/schemas/EndPointInfo.Address"
            }
          }
906
907
908
909
        }
      },
      "EndPointInfo.Alternative": {
        "description": "Entry point information of the service in a format defined by an implementation, or in an external specification.",
910
911
912
913
914
915
916
917
918
        "type": "object",
        "required": [
          "alternative"
        ],
        "properties": {
          "alternative": {
            "type": "object"
          }
        }
919
920
921
922
923
924
925
926
927
      },
      "EndPointInfo.Uri": {
        "description": "Entry point information of the service",
        "type": "string",
        "format": "uri",
        "example": "/meMp1/service/EntryPoint"
      },
      "EndPointInfo.Uris": {
        "description": "Entry point information of the service as string, formatted according to URI syntax",
928
929
930
931
932
933
934
935
936
937
938
939
        "type": "object",
        "required": [
          "uris"
        ],
        "properties": {
          "uris": {
            "type": "array",
            "minItems": 0,
            "items": {
              "$ref": "#/components/schemas/EndPointInfo.Uri"
            }
          }
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
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
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
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
        }
      },
      "LinkType": {
        "description": "This type represents a type of link and may be referenced from data structures",
        "type": "object",
        "properties": {
          "href": {
            "$ref": "#/components/schemas/Href"
          }
        }
      },
      "Href": {
        "description": "URI referring to a resource",
        "type": "string",
        "format": "uri",
        "example": "/meMp1/example"
      },
      "Mp1SubscriptionLinkList.Links": {
        "description": "Self-referring URI.",
        "type": "object",
        "required": [
          "self"
        ],
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          },
          "subscription": {
            "description": "Subscription list",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Mp1SubscriptionLinkList.Subscription"
            }
          }
        }
      },
      "Mp1SubscriptionLinkList.Subscription": {
        "description": "A link to a subscription.",
        "type": "object",
        "required": [
          "href",
          "rel"
        ],
        "properties": {
          "href": {
            "$ref": "#/components/schemas/Href"
          },
          "rel": {
            "description": "The values are as defined in the \"subscriptionType\" attribute for each different Mp1 event subscription data type.",
            "type": "string",
            "enum": [
              "AppTerminationNotificationSubscription",
              "SerAvailabilityNotificationSubscription"
            ]
          }
        }
      },
      "Mp1SubscriptionLinkList": {
        "description": "This type represents a list of links related to currently existing subscriptions for a mobile edge application instance. This information is returned when sending a request to receive current subscriptions.",
        "type": "object",
        "required": [
          "_links"
        ],
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/Mp1SubscriptionLinkList.Links"
          }
        }
      },
      "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",
        "format": "uri",
        "description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
      },
      "SecurityInfo.OAuth2Info.GrantTypes": {
        "description": "List of supported OAuth 2.0 grant types",
        "type": "string",
        "enum": [
          "OAUTH2_AUTHORIZATION_CODE",
          "OAUTH2_IMPLICIT_GRANT",
          "OAUTH2_RESOURCE_OWNER",
          "OAUTH2_CLIENT_CREDENTIALS"
        ],
        "example": "OAUTH2_CLIENT_CREDENTIALS"
      },
      "SecurityInfo.OAuth2Info.TokenEndpoint": {
        "description": "The token endpoint",
        "type": "string",
        "format": "uri",
        "example": "/meMp1/security/TokenEndPoint"
      },
      "SecurityInfo.OAuth2Info": {
        "description": "Parameters related to use of OAuth 2.0",
        "required": [
          "grantTypes",
          "tokenEndpoint"
        ],
        "properties": {
          "grantTypes": {
            "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes"
          },
          "tokenEndpoint": {
            "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.TokenEndpoint"
          }
1082
        },
1083
1084
1085
1086
1087
1088
1089
1090
1091
        "type": "object"
      },
      "SecurityInfo": {
        "description": "This type represents security information related to a transport",
        "type": "object",
        "properties": {
          "oAuth2Info": {
            "$ref": "#/components/schemas/SecurityInfo.OAuth2Info"
          }
1092
        }
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
      },
      "Self": {
        "description": "Self-referring URI.",
        "type": "object",
        "required": [
          "self"
        ],
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          }
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
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
        "readOnly": true
      },
      "SerAvailabilityNotificationSubscription.CallbackReference": {
        "description": "URI selected by the mobile edge application instance to receive notifications on the subscribed mobile edge service availability information. This shall be included in both the request and the response.",
        "type": "string",
        "format": "uri"
      },
      "SerAvailabilityNotificationSubscription": {
        "description": "This type represents a subscription to the notifications from the mobile edge platform regarding the availability of a mobile edge service or a list of mobile edge services.",
        "type": "object",
        "required": [
          "subscriptionType",
          "callbackReference",
          "_links",
          "filteringCriteria"
        ],
        "properties": {
          "subscriptionType": {
            "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType"
          },
          "callbackReference": {
            "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.CallbackReference"
          },
          "_links": {
            "$ref": "#/components/schemas/Self"
          },
          "filteringCriteria": {
            "$ref": "#/components/schemas/ServiceInfo"
          }
        }
      },
      "SerAvailabilityNotificationSubscription.SubscriptionType": {
        "description": "Shall be set to SerAvailabilityNotificationSubscription.",
        "type": "string",
        "example": "SerAvailabilityNotificationSubscription"
      },
      "ServiceAvailabilityNotification": {
        "description": "This type represents the service availability information.",
        "type": "object",
        "required": [
          "notificationType",
          "services",
          "_links"
        ],
        "properties": {
          "notificationType": {
            "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType"
          },
          "services": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceInfo"
            }
          },
          "_links": {
            "$ref": "#/components/schemas/Subscription"
          }
        }
      },
      "SerializerTypes": {
        "description": "The enumeration SerializerTypes represents types of serializers",
        "type": "string",
        "enum": [
          "JSON",
          "XML",
          "PROTOBUF3"
        ],
        "example": "JSON"
      },
Walter Featherstone's avatar
Walter Featherstone committed
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
      "LocalityTypes": {
        "description": "The scope of locality as expressed by \"consumedLocalOnly\" and \"isLocal\". If absent, defaults to MEC_HOST",
        "type": "string",
        "enum": [
          "MEC_SYSTEM",
          "MEC_HOST",
          "NFVI_POP",
          "ZONE",
          "ZONE_GROUP",
          "NFVI_NODE"
        ],
        "example": "MEC_SYSTEM"
      },
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
      "ServiceInfo.SerInstanceId": {
        "description": "Identifier of the service instance assigned by the MEPM / mobile edge platform.",
        "type": "string",
        "readOnly": true,
        "example": "ServiceInstance123"
      },
      "ServiceInfo.SerName": {
        "description": "The name of the service. This is how the service producing mobile edge application identifies the service instance it produces.",
        "type": "string",
        "example": "ExampleService"
      },
      "ServiceInfo.State": {
        "description": "Contains the state",
        "type": "string",
        "enum": [
          "ACTIVE",
          "INACTIVE"
        ],
        "example": "ACTIVE"
      },
      "ServiceInfo.TransportId": {
        "description": "Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the \"Transport information query\" procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.",
        "type": "string",
1210
        "writeOnly": true,
1211
1212
1213
1214
1215
1216
1217
        "example": "Rest1"
      },
      "ServiceInfo.Version": {
        "description": "Service version",
        "type": "string",
        "example": "ServiceVersion1"
      },
Walter Featherstone's avatar
Walter Featherstone committed
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
      "ServiceInfo.ConsumedLocalOnly": {
        "description": "Indicate whether the service can only be consumed by the MEC applications located in the same locality (as defined by scopeOfLocality) as this  service instance.",
        "type": "boolean",
        "example": false
      },
      "ServiceInfo.IsLocal": {
        "description": "Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.",
        "type": "boolean",
        "example": true
      },
1228
      "ServiceInfo.Post": {
1229
1230
1231
1232
1233
1234
1235
1236
        "description": "This type represents the general information of a mobile edge service.",
        "type": "object",
        "required": [
          "serName",
          "version",
          "state",
          "serializer"
        ],
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
        "oneOf": [
          {
            "required": [
              "transportId"
            ]
          },
          {
            "required": [
              "transportInfo"
            ]
          }
        ],
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
        "properties": {
          "serInstanceId": {
            "$ref": "#/components/schemas/ServiceInfo.SerInstanceId"
          },
          "serName": {
            "$ref": "#/components/schemas/ServiceInfo.SerName"
          },
          "serCategory": {
            "$ref": "#/components/schemas/CategoryRef"
          },
          "version": {
            "$ref": "#/components/schemas/ServiceInfo.Version"
          },
          "state": {
            "$ref": "#/components/schemas/ServiceInfo.State"
          },
          "transportId": {
            "$ref": "#/components/schemas/ServiceInfo.TransportId"
          },
          "transportInfo": {
            "$ref": "#/components/schemas/TransportInfo"
          },
          "serializer": {
            "$ref": "#/components/schemas/SerializerTypes"
Walter Featherstone's avatar
Walter Featherstone committed
1273
1274
1275
1276
1277
1278
1279
1280
1281
          },
          "scopeOfLocality": {
            "$ref": "#/components/schemas/LocalityTypes"
          },
          "consumedLocalOnly": {
            "$ref": "#/components/schemas/ServiceInfo.ConsumedLocalOnly"
          },
          "isLocal": {
            "$ref": "#/components/schemas/ServiceInfo.IsLocal"
1282
1283
1284
          }
        }
      },
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
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
1323
1324
      "ServiceInfo": {
        "description": "This type represents the general information of a mobile edge service.",
        "type": "object",
        "required": [
          "serName",
          "version",
          "state",
          "transportInfo",
          "serializer"
        ],
        "properties": {
          "serInstanceId": {
            "$ref": "#/components/schemas/ServiceInfo.SerInstanceId"
          },
          "serName": {
            "$ref": "#/components/schemas/ServiceInfo.SerName"
          },
          "serCategory": {
            "$ref": "#/components/schemas/CategoryRef"
          },
          "version": {
            "$ref": "#/components/schemas/ServiceInfo.Version"
          },
          "state": {
            "$ref": "#/components/schemas/ServiceInfo.State"
          },
          "transportInfo": {
            "$ref": "#/components/schemas/TransportInfo"
          },
          "serializer": {
            "$ref": "#/components/schemas/SerializerTypes"
          },
          "scopeOfLocality": {
            "$ref": "#/components/schemas/LocalityTypes"
          },
          "consumedLocalOnly": {
            "$ref": "#/components/schemas/ServiceInfo.ConsumedLocalOnly"
          },
          "isLocal": {
            "$ref": "#/components/schemas/ServiceInfo.IsLocal"
1325
1326
1327
          }
        }
      },
1328
1329
1330
1331
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
      "ServiceInfo": {
        "description": "This type represents the general information of a mobile edge service.",
        "type": "object",
        "required": [
          "serName",
          "version",
          "state",
          "transportInfo",
          "serializer"
        ],
        "properties": {
          "serInstanceId": {
            "$ref": "#/components/schemas/ServiceInfo.SerInstanceId"
          },
          "serName": {
            "$ref": "#/components/schemas/ServiceInfo.SerName"
          },
          "serCategory": {
            "$ref": "#/components/schemas/CategoryRef"
          },
          "version": {
            "$ref": "#/components/schemas/ServiceInfo.Version"
          },
          "state": {
            "$ref": "#/components/schemas/ServiceInfo.State"
          },
          "transportInfo": {
            "$ref": "#/components/schemas/TransportInfo"
          },
          "serializer": {
            "$ref": "#/components/schemas/SerializerTypes"
          }
        }
      },
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
      "Subscription": {
        "description": "A link to the related subscription",
        "type": "object",
        "required": [
          "subscription"
        ],
        "properties": {
          "subscription": {
            "$ref": "#/components/schemas/LinkType"
          }
        }
      },
      "TimingCaps.NtpServers.AuthenticationKeyNum": {
        "description": "Authentication key number",
        "type": "integer",
        "format": "uint32",
        "example": 1
      },
      "TimingCaps.NtpServers.AuthenticationOption": {
        "description": "NTP authentication option",
        "type": "string",
        "enum": [
          "NONE",
          "SYMMETRIC_KEY",
          "AUTO_KEY"
        ],
        "example": "NONE"
      },
      "TimingCaps.NtpServers.DelayReqMaxRate": {
        "description": "Acceptable maximum rate of the Delay_Req messages in packets per second",
        "type": "integer",
        "format": "uint32",
        "example": 10
      },
      "TimingCaps.NtpServers.LocalPriority": {
        "description": "NTP server local priority",
        "type": "integer",
        "format": "uint32",
        "example": 1
      },
      "TimingCaps.NtpServers.MaxPollingInterval": {
        "description": "Maximum poll interval for NTP messages, in seconds as a power of two. Range 3...17",
        "type": "integer",
        "format": "uint32",
        "example": 17
      },
      "TimingCaps.NtpServers.MinPollingInterval": {
        "description": "Minimum poll interval for NTP messages, in seconds as a power of two. Range 3...17",
        "type": "integer",
        "format": "uint32",
        "example": 3
      },
      "TimingCaps.NtpServers.NtpServerAddr": {
        "description": "NTP server address",
        "type": "string",
        "example": "192.0.2.0"
      },
      "TimingCaps.NtpServers.NtpServerAddrType": {
        "description": "Address type of NTP server",
        "type": "string",
        "enum": [
          "IP_ADDRESS",
          "DNS_NAME"
        ],
        "example": "IP_ADDRESS"
      },