Mp1.json 90.3 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",
13
    "version": "2.0.8",
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": {
24
25
    "description": "ETSI GS MEC011 Application Enablement API, V2.0.8",
    "url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv208.zip"
26
  },
27
28
  "tags": [
    {
29
      "name": "appTrafficRules"
30
31
    },
    {
32
      "name": "appDnsRules"
33
34
    },
    {
35
36
37
38
39
40
41
      "name": "appSubscriptions"
    },
    {
      "name": "appConfirmTermination"
    },
    {
      "name": "appServices"
42
43
44
45
46
47
48
49
50
51
52
53
54
55
    },
    {
      "name": "services"
    },
    {
      "name": "timing"
    },
    {
      "name": "transports"
    },
    {
      "name": "callbacks"
    }
  ],
56
  "paths": {
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
    "/applications/{appInstanceId}/confirm_termination": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Path.AppInstanceId"
        }
      ],
      "post": {
        "description": "This method is used to confirm the application level termination  of an application instance.",
        "operationId": "ApplicationsConfirmTermination_POST",
        "tags": [
          "appConfirmTermination"
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "401": {
            "$ref": "#/components/responses/Error.401"
          },
          "403": {
            "$ref": "#/components/responses/Error.403"
          },
          "404": {
            "$ref": "#/components/responses/Error.404"
          },
          "409": {
            "$ref": "#/components/responses/Error.409"
          },
          "429": {
            "$ref": "#/components/responses/Error.429"
          }
        }
      }
    },
91
92
93
    "/applications/{appInstanceId}/dns_rules": {
      "parameters": [
        {
94
          "$ref": "#/components/parameters/Path.AppInstanceId"
95
96
97
98
        }
      ],
      "get": {
        "description": "This method retrieves information about all the DNS rules associated with a mobile edge application instance.",
99
        "operationId": "ApplicationsDnsRules_GET",
100
        "tags": [
Walter Featherstone's avatar
Walter Featherstone committed
101
          "appDnsRules"
102
        ],
103
104
        "responses": {
          "200": {
105
            "$ref": "#/components/responses/ApplicationsDnsRules.200"
106
107
          },
          "400": {
108
            "$ref": "#/components/responses/Error.400"
109
110
          },
          "403": {
111
            "$ref": "#/components/responses/Error.403"
112
113
          },
          "404": {
114
            "$ref": "#/components/responses/Error.404"
115
116
117
118
119
120
121
          }
        }
      }
    },
    "/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
      "parameters": [
        {
122
          "$ref": "#/components/parameters/Path.AppInstanceId"
123
124
        },
        {
125
          "$ref": "#/components/parameters/Path.DnsRuleId"
126
127
128
129
        }
      ],
      "get": {
        "description": "This method retrieves information about a DNS rule associated with a mobile edge application instance.",
130
        "operationId": "ApplicationsDnsRule_GET",
131
        "tags": [
132
          "appDnsRules"
133
        ],
134
135
        "responses": {
          "200": {
136
            "$ref": "#/components/responses/ApplicationsDnsRule.200"
137
138
          },
          "400": {
139
            "$ref": "#/components/responses/Error.400"
140
141
          },
          "403": {
142
            "$ref": "#/components/responses/Error.403"
143
144
          },
          "404": {
145
            "$ref": "#/components/responses/Error.404"
146
147
148
149
150
          }
        }
      },
      "put": {
        "description": "This method activates, de-activates or updates a traffic rule.",
151
        "operationId": "ApplicationsDnsRule_PUT",
152
        "tags": [
153
          "appDnsRules"
154
        ],
155
156
        "responses": {
          "200": {
157
            "$ref": "#/components/responses/ApplicationsDnsRule.200"
158
159
          },
          "400": {
160
            "$ref": "#/components/responses/Error.400"
161
162
          },
          "403": {
163
            "$ref": "#/components/responses/Error.403"
164
165
          },
          "404": {
166
            "$ref": "#/components/responses/Error.404"
167
168
          },
          "412": {
169
            "$ref": "#/components/responses/Error.412"
170
          }
171
172
173
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ApplicationsDnsRule"
174
175
176
177
178
179
        }
      }
    },
    "/applications/{appInstanceId}/subscriptions": {
      "parameters": [
        {
180
          "$ref": "#/components/parameters/Path.AppInstanceId"
181
182
183
184
        }
      ],
      "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.",
185
        "operationId": "ApplicationsSubscriptions_GET",
186
        "tags": [
187
          "appSubscriptions"
188
        ],
189
190
        "responses": {
          "200": {
191
            "$ref": "#/components/responses/ApplicationsSubscriptions.200"
192
193
          },
          "400": {
194
            "$ref": "#/components/responses/Error.400"
195
196
          },
          "403": {
197
            "$ref": "#/components/responses/Error.403"
198
199
          },
          "404": {
200
            "$ref": "#/components/responses/Error.404"
201
202
203
204
205
          }
        }
      },
      "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.",
206
        "operationId": "ApplicationsSubscriptions_POST",
207
        "tags": [
208
          "appSubscriptions"
209
        ],
210
211
        "responses": {
          "201": {
212
            "$ref": "#/components/responses/ApplicationsSubscriptions.201"
213
214
          },
          "400": {
215
            "$ref": "#/components/responses/Error.400"
216
217
          },
          "403": {
218
            "$ref": "#/components/responses/Error.403"
219
220
          },
          "404": {
221
222
223
224
225
226
227
228
229
230
231
232
            "$ref": "#/components/responses/Error.404"
          }
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ApplicationsSubscriptions"
        },
        "callbacks": {
          "appTerminationNotification": {
            "$ref": "#/components/callbacks/AppTerminationNotification"
          },
          "serviceAvailabilityNotification": {
            "$ref": "#/components/callbacks/ServiceAvailabilityNotification"
233
234
235
236
237
238
239
          }
        }
      }
    },
    "/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}": {
      "parameters": [
        {
240
          "$ref": "#/components/parameters/Path.AppInstanceId"
241
242
        },
        {
243
          "$ref": "#/components/parameters/Path.SubscriptionType"
244
245
        },
        {
246
          "$ref": "#/components/parameters/Path.SubscriptionId"
247
248
249
250
        }
      ],
      "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.",
251
        "operationId": "ApplicationsSubscription_GET",
252
        "tags": [
253
          "appSubscriptions"
254
        ],
255
256
        "responses": {
          "200": {
257
            "$ref": "#/components/responses/ApplicationsSubscription.200"
258
259
          },
          "400": {
260
            "$ref": "#/components/responses/Error.400"
261
262
          },
          "403": {
263
            "$ref": "#/components/responses/Error.403"
264
265
          },
          "404": {
266
            "$ref": "#/components/responses/Error.404"
267
268
269
270
271
          }
        }
      },
      "delete": {
        "description": "This method deletes a meMp1Subscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
272
        "operationId": "ApplicationsSubscription_DELETE",
273
        "tags": [
274
          "appSubscriptions"
275
        ],
276
277
278
279
280
        "responses": {
          "204": {
            "description": "No Content"
          },
          "403": {
281
            "$ref": "#/components/responses/Error.403"
282
283
          },
          "404": {
284
            "$ref": "#/components/responses/Error.404"
285
286
287
288
289
290
291
          }
        }
      }
    },
    "/applications/{appInstanceId}/traffic_rules": {
      "parameters": [
        {
292
          "$ref": "#/components/parameters/Path.AppInstanceId"
293
294
295
296
        }
      ],
      "get": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
297
        "operationId": "ApplicationsTrafficRules_GET",
298
        "tags": [
299
          "appTrafficRules"
300
        ],
301
302
        "responses": {
          "200": {
303
            "$ref": "#/components/responses/ApplicationsTrafficRules.200"
304
305
          },
          "400": {
306
            "$ref": "#/components/responses/Error.400"
307
308
          },
          "403": {
309
            "$ref": "#/components/responses/Error.403"
310
311
          },
          "404": {
312
            "$ref": "#/components/responses/Error.404"
313
314
315
316
317
318
319
          }
        }
      }
    },
    "/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
      "parameters": [
        {
320
          "$ref": "#/components/parameters/Path.AppInstanceId"
321
322
        },
        {
323
          "$ref": "#/components/parameters/Path.TrafficRuleId"
324
325
326
327
        }
      ],
      "get": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
328
        "operationId": "ApplicationsTrafficRule_GET",
329
        "tags": [
330
          "appTrafficRules"
331
        ],
332
333
        "responses": {
          "200": {
334
            "$ref": "#/components/responses/ApplicationsTrafficRule.200"
335
336
          },
          "400": {
337
            "$ref": "#/components/responses/Error.400"
338
339
          },
          "403": {
340
            "$ref": "#/components/responses/Error.403"
341
342
          },
          "404": {
343
            "$ref": "#/components/responses/Error.404"
344
345
346
347
348
          }
        }
      },
      "put": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
349
        "operationId": "ApplicationsTrafficRule_PUT",
350
        "tags": [
351
          "appTrafficRules"
352
        ],
353
354
        "responses": {
          "200": {
355
            "$ref": "#/components/responses/ApplicationsTrafficRule.200"
356
357
          },
          "400": {
358
            "$ref": "#/components/responses/Error.400"
359
360
          },
          "403": {
361
            "$ref": "#/components/responses/Error.403"
362
363
          },
          "404": {
364
            "$ref": "#/components/responses/Error.404"
365
366
          },
          "412": {
367
            "$ref": "#/components/responses/Error.412"
368
          }
369
370
371
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ApplicationsTrafficRule"
372
373
374
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
375
376
377
378
379
380
    "/applications/{appInstanceId}/services": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Path.AppInstanceId"
        }
      ],
381
382
      "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
383
        "operationId": "AppServices_GET",
384
        "tags": [
385
          "appServices"
386
        ],
387
388
        "parameters": [
          {
389
            "$ref": "#/components/parameters/Query.Ser_instance_id"
390
391
          },
          {
392
            "$ref": "#/components/parameters/Query.Ser_name"
393
394
          },
          {
395
            "$ref": "#/components/parameters/Query.Ser_category_id"
Walter Featherstone's avatar
Walter Featherstone committed
396
397
398
399
400
401
402
403
404
          },
          {
            "$ref": "#/components/parameters/Query.Consumed_local_only"
          },
          {
            "$ref": "#/components/parameters/Query.Is_local"
          },
          {
            "$ref": "#/components/parameters/Query.LocalityTypes"
405
406
407
408
          }
        ],
        "responses": {
          "200": {
409
            "$ref": "#/components/responses/Services.200"
410
411
          },
          "400": {
412
            "$ref": "#/components/responses/Error.400"
413
414
          },
          "403": {
415
            "$ref": "#/components/responses/Error.403"
416
417
          },
          "404": {
418
            "$ref": "#/components/responses/Error.404"
419
420
421
422
423
          }
        }
      },
      "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
424
        "operationId": "AppServices_POST",
425
        "tags": [
426
          "appServices"
427
        ],
428
429
        "responses": {
          "201": {
430
            "$ref": "#/components/responses/Services.201"
431
432
          },
          "400": {
433
            "$ref": "#/components/responses/Error.400"
434
435
          },
          "403": {
436
            "$ref": "#/components/responses/Error.403"
437
438
          },
          "404": {
439
            "$ref": "#/components/responses/Error.404"
440
          }
441
442
        },
        "requestBody": {
443
          "$ref": "#/components/requestBodies/Services.Post"
444
445
446
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
447
    "/applications/{appInstanceId}/services/{serviceId}": {
448
      "parameters": [
Walter Featherstone's avatar
Walter Featherstone committed
449
450
451
        {
          "$ref": "#/components/parameters/Path.AppInstanceId"
        },
452
        {
453
          "$ref": "#/components/parameters/Path.ServiceId"
454
455
456
457
        }
      ],
      "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
458
        "operationId": "AppServicesServiceId_GET",
459
        "tags": [
460
          "appServices"
461
        ],
462
463
        "responses": {
          "200": {
464
            "$ref": "#/components/responses/ServicesServiceId.200"
465
466
          },
          "400": {
467
            "$ref": "#/components/responses/Error.400"
468
469
          },
          "403": {
470
            "$ref": "#/components/responses/Error.403"
471
472
          },
          "404": {
473
            "$ref": "#/components/responses/Error.404"
474
475
476
477
478
          }
        }
      },
      "put": {
        "description": "This method updates the information about a meService resource",
Walter Featherstone's avatar
Walter Featherstone committed
479
        "operationId": "AppServicesServiceId_PUT",
480
        "tags": [
481
          "appServices"
482
        ],
483
484
        "responses": {
          "200": {
485
            "$ref": "#/components/responses/ServicesServiceId.200"
486
487
          },
          "400": {
488
            "$ref": "#/components/responses/Error.400"
489
490
          },
          "403": {
491
            "$ref": "#/components/responses/Error.403"
492
493
          },
          "404": {
494
            "$ref": "#/components/responses/Error.404"
495
496
          },
          "412": {
497
            "$ref": "#/components/responses/Error.412"
498
          }
499
500
501
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ServicesServiceId"
502
503
504
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
505
506
507
508
    "/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",
509
510
511
        "tags": [
          "services"
        ],
Walter Featherstone's avatar
Walter Featherstone committed
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
        "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",
557
558
559
        "tags": [
          "services"
        ],
Walter Featherstone's avatar
Walter Featherstone committed
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
        "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"
          }
        }
      }
    },
576
577
578
    "/timing/current_time": {
      "get": {
        "description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure",
579
        "operationId": "TimingCurrentTime_GET",
580
581
582
        "tags": [
          "timing"
        ],
583
584
        "responses": {
          "200": {
585
            "$ref": "#/components/responses/TimingCurrentTime.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
          }
        }
      }
    },
    "/timing/timing_caps": {
      "get": {
        "description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query",
602
        "operationId": "TimingCaps_GET",
603
604
605
        "tags": [
          "timing"
        ],
606
607
        "responses": {
          "200": {
608
            "$ref": "#/components/responses/TimingCaps.200"
609
610
          },
          "400": {
611
            "$ref": "#/components/responses/Error.400"
612
613
          },
          "403": {
614
            "$ref": "#/components/responses/Error.403"
615
616
          },
          "404": {
617
            "$ref": "#/components/responses/Error.404"
618
619
620
621
622
623
624
          }
        }
      }
    },
    "/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",
625
        "operationId": "Transports_GET",
626
627
628
        "tags": [
          "transports"
        ],
629
630
        "responses": {
          "200": {
631
            "$ref": "#/components/responses/Transports.200"
632
633
          },
          "400": {
634
            "$ref": "#/components/responses/Error.400"
635
636
          },
          "403": {
637
            "$ref": "#/components/responses/Error.403"
638
639
          },
          "404": {
640
            "$ref": "#/components/responses/Error.404"
641
642
643
644
645
          }
        }
      }
    }
  },
646
647
648
649
650
  "components": {
    "schemas": {
      "Empty": {
        "description": "Empty schema"
      },
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
      "AppTerminationNotification.Links": {
        "description": "List of hyperlinks related to the resource.",
        "type": "object",
        "required": [
          "subscription"
        ],
        "properties": {
          "subscription": {
            "$ref": "#/components/schemas/LinkType"
          },
          "confirmTermination": {
            "$ref": "#/components/schemas/LinkType.ConfirmTermination"
          }
        }
      },
666
667
      "AppTerminationNotification.MaxGracefulTimeout": {
        "description": "Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.",
668
        "type": "integer",
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
        "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": {
693
            "$ref": "#/components/schemas/AppTerminationNotification.Links"
694
          }
695
        }
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
      },
      "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"
          }
729
        }
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
      },
      "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": {
747
        "description": "Name of the category, example values include RNI, Location & Bandwidth Management",
748
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
        "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"
          }
778
        }
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
      },
      "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"
          }
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
      },
      "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"
          }
854
        }
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
      },
      "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",
893
        "example": "?"
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
      },
      "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"
          }
924
        }
925
926
927
928
929
930
      },
      "EndPointInfo.Address.Host": {
        "description": "Host portion of the address",
        "type": "string",
        "example": "192.0.2.0"
      },
931
      "EndPointInfo.Address_Port": {
932
933
934
        "description": "Port portion of the address",
        "type": "integer",
        "format": "uint32",
935
        "example": 8080
936
937
938
939
      },
      "EndPointInfo.Address": {
        "description": "A IP address and port pair",
        "type": "object",
940
941
942
943
        "required": [
          "host",
          "port"
        ],
944
945
946
947
948
        "properties": {
          "host": {
            "$ref": "#/components/schemas/EndPointInfo.Address.Host"
          },
          "port": {
949
            "$ref": "#/components/schemas/EndPointInfo.Address_Port"
950
          }
951
        }
952
953
954
      },
      "EndPointInfo.Addresses": {
        "description": "Entry point information of the service as one or more pairs of IP address and port",
955
956
957
958
959
960
961
962
963
964
965
966
        "type": "object",
        "required": [
          "addresses"
        ],
        "properties": {
          "addresses": {
            "type": "array",
            "minItems": 0,
            "items": {
              "$ref": "#/components/schemas/EndPointInfo.Address"
            }
          }
967
968
969
970
        }
      },
      "EndPointInfo.Alternative": {
        "description": "Entry point information of the service in a format defined by an implementation, or in an external specification.",
971
972
973
974
975
976
977
978
979
        "type": "object",
        "required": [
          "alternative"
        ],
        "properties": {
          "alternative": {
            "type": "object"
          }
        }
980
981
982
983
984
985
986
987
988
      },
      "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",
989
990
991
992
993
994
995
996
997
998
999
1000
        "type": "object",
        "required": [
          "uris"
        ],
        "properties": {
          "uris": {
            "type": "array",
            "minItems": 0,
            "items": {
              "$ref": "#/components/schemas/EndPointInfo.Uri"
            }
          }
For faster browsing, not all history is shown. View entire blame