Mp1.json 76.6 KB
Newer Older
1
{
2
3
4
  "openapi": "3.0.0",
  "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
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
  "info": {
    "title": "Mp1 API",
    "version": "1.1.1",
    "description": "The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI",
    "license": {
      "name": "ETSI Forge copyright notice",
      "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
    }
  },
  "externalDocs": {
    "description": "ETSI GS MEC011 Application Enablement API, V1.1.1",
    "url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf"
  },
  "paths": {
    "/applications/{appInstanceId}/dns_rules": {
      "parameters": [
        {
28
          "$ref": "#/components/parameters/Path.AppInstanceId"
29
30
31
32
        }
      ],
      "get": {
        "description": "This method retrieves information about all the DNS rules associated with a mobile edge application instance.",
33
        "operationId": "ApplicationsDnsRules_GET",
34
35
        "responses": {
          "200": {
36
            "$ref": "#/components/responses/ApplicationsDnsRules.200"
37
38
          },
          "400": {
39
            "$ref": "#/components/responses/Error.400"
40
41
          },
          "403": {
42
            "$ref": "#/components/responses/Error.403"
43
44
          },
          "404": {
45
            "$ref": "#/components/responses/Error.404"
46
47
48
49
50
51
52
          }
        }
      }
    },
    "/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
      "parameters": [
        {
53
          "$ref": "#/components/parameters/Path.AppInstanceId"
54
55
        },
        {
56
          "$ref": "#/components/parameters/Path.DnsRuleId"
57
58
59
60
        }
      ],
      "get": {
        "description": "This method retrieves information about a DNS rule associated with a mobile edge application instance.",
61
        "operationId": "ApplicationsDnsRule_GET",
62
63
        "responses": {
          "200": {
64
            "$ref": "#/components/responses/ApplicationsDnsRule.200"
65
66
          },
          "400": {
67
            "$ref": "#/components/responses/Error.400"
68
69
          },
          "403": {
70
            "$ref": "#/components/responses/Error.403"
71
72
          },
          "404": {
73
            "$ref": "#/components/responses/Error.404"
74
75
76
77
78
          }
        }
      },
      "put": {
        "description": "This method activates, de-activates or updates a traffic rule.",
79
        "operationId": "ApplicationsDnsRule_PUT",
80
81
        "responses": {
          "200": {
82
            "$ref": "#/components/responses/ApplicationsDnsRule.200"
83
84
          },
          "400": {
85
            "$ref": "#/components/responses/Error.400"
86
87
          },
          "403": {
88
            "$ref": "#/components/responses/Error.403"
89
90
          },
          "404": {
91
            "$ref": "#/components/responses/Error.404"
92
93
          },
          "412": {
94
            "$ref": "#/components/responses/Error.412"
95
          }
96
97
98
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ApplicationsDnsRule"
99
100
101
102
103
104
        }
      }
    },
    "/applications/{appInstanceId}/subscriptions": {
      "parameters": [
        {
105
          "$ref": "#/components/parameters/Path.AppInstanceId"
106
107
108
109
        }
      ],
      "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.",
110
        "operationId": "ApplicationsSubscriptions_GET",
111
112
        "responses": {
          "200": {
113
            "$ref": "#/components/responses/ApplicationsSubscriptions.200"
114
115
          },
          "400": {
116
            "$ref": "#/components/responses/Error.400"
117
118
          },
          "403": {
119
            "$ref": "#/components/responses/Error.403"
120
121
          },
          "404": {
122
            "$ref": "#/components/responses/Error.404"
123
124
125
126
127
          }
        }
      },
      "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.",
128
        "operationId": "ApplicationsSubscriptions_POST",
129
130
        "responses": {
          "201": {
131
            "$ref": "#/components/responses/ApplicationsSubscriptions.201"
132
133
          },
          "400": {
134
            "$ref": "#/components/responses/Error.400"
135
136
          },
          "403": {
137
            "$ref": "#/components/responses/Error.403"
138
139
          },
          "404": {
140
141
142
143
144
145
146
147
148
149
150
151
            "$ref": "#/components/responses/Error.404"
          }
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ApplicationsSubscriptions"
        },
        "callbacks": {
          "appTerminationNotification": {
            "$ref": "#/components/callbacks/AppTerminationNotification"
          },
          "serviceAvailabilityNotification": {
            "$ref": "#/components/callbacks/ServiceAvailabilityNotification"
152
153
154
155
156
157
158
          }
        }
      }
    },
    "/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}": {
      "parameters": [
        {
159
          "$ref": "#/components/parameters/Path.AppInstanceId"
160
161
        },
        {
162
          "$ref": "#/components/parameters/Path.SubscriptionType"
163
164
        },
        {
165
          "$ref": "#/components/parameters/Path.SubscriptionId"
166
167
168
169
        }
      ],
      "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.",
170
        "operationId": "ApplicationsSubscription_GET",
171
172
        "responses": {
          "200": {
173
            "$ref": "#/components/responses/ApplicationsSubscription.200"
174
175
          },
          "400": {
176
            "$ref": "#/components/responses/Error.400"
177
178
          },
          "403": {
179
            "$ref": "#/components/responses/Error.403"
180
181
          },
          "404": {
182
            "$ref": "#/components/responses/Error.404"
183
184
185
186
187
          }
        }
      },
      "delete": {
        "description": "This method deletes a meMp1Subscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
188
        "operationId": "ApplicationsSubscription_DELETE",
189
190
191
192
193
        "responses": {
          "204": {
            "description": "No Content"
          },
          "403": {
194
            "$ref": "#/components/responses/Error.403"
195
196
          },
          "404": {
197
            "$ref": "#/components/responses/Error.404"
198
199
200
201
202
203
204
          }
        }
      }
    },
    "/applications/{appInstanceId}/traffic_rules": {
      "parameters": [
        {
205
          "$ref": "#/components/parameters/Path.AppInstanceId"
206
207
208
209
        }
      ],
      "get": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
210
        "operationId": "ApplicationsTrafficRules_GET",
211
212
        "responses": {
          "200": {
213
            "$ref": "#/components/responses/ApplicationsTrafficRules.200"
214
215
          },
          "400": {
216
            "$ref": "#/components/responses/Error.400"
217
218
          },
          "403": {
219
            "$ref": "#/components/responses/Error.403"
220
221
          },
          "404": {
222
            "$ref": "#/components/responses/Error.404"
223
224
225
226
227
228
229
          }
        }
      }
    },
    "/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
      "parameters": [
        {
230
          "$ref": "#/components/parameters/Path.AppInstanceId"
231
232
        },
        {
233
          "$ref": "#/components/parameters/Path.TrafficRuleId"
234
235
236
237
        }
      ],
      "get": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
238
        "operationId": "ApplicationsTrafficRule_GET",
239
240
        "responses": {
          "200": {
241
            "$ref": "#/components/responses/ApplicationsTrafficRule.200"
242
243
          },
          "400": {
244
            "$ref": "#/components/responses/Error.400"
245
246
          },
          "403": {
247
            "$ref": "#/components/responses/Error.403"
248
249
          },
          "404": {
250
            "$ref": "#/components/responses/Error.404"
251
252
253
254
255
          }
        }
      },
      "put": {
        "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
256
        "operationId": "ApplicationsTrafficRule_PUT",
257
258
        "responses": {
          "200": {
259
            "$ref": "#/components/responses/ApplicationsTrafficRule.200"
260
261
          },
          "400": {
262
            "$ref": "#/components/responses/Error.400"
263
264
          },
          "403": {
265
            "$ref": "#/components/responses/Error.403"
266
267
          },
          "404": {
268
            "$ref": "#/components/responses/Error.404"
269
270
          },
          "412": {
271
            "$ref": "#/components/responses/Error.412"
272
          }
273
274
275
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ApplicationsTrafficRule"
276
277
278
279
280
281
        }
      }
    },
    "/services": {
      "get": {
        "description": "This method retrieves information about a list of meService resources. This method is typically used in \"service availability query\" procedure",
282
        "operationId": "Services_GET",
283
284
        "parameters": [
          {
285
            "$ref": "#/components/parameters/Query.Ser_instance_id"
286
287
          },
          {
288
            "$ref": "#/components/parameters/Query.Ser_name"
289
290
          },
          {
291
            "$ref": "#/components/parameters/Query.Ser_category_id"
292
293
294
295
          }
        ],
        "responses": {
          "200": {
296
            "$ref": "#/components/responses/Services.200"
297
298
          },
          "400": {
299
            "$ref": "#/components/responses/Error.400"
300
301
          },
          "403": {
302
            "$ref": "#/components/responses/Error.403"
303
304
          },
          "404": {
305
            "$ref": "#/components/responses/Error.404"
306
307
308
309
310
          }
        }
      },
      "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",
311
        "operationId": "Services_POST",
312
313
        "responses": {
          "201": {
314
            "$ref": "#/components/responses/Services.201"
315
316
          },
          "400": {
317
            "$ref": "#/components/responses/Error.400"
318
319
          },
          "403": {
320
            "$ref": "#/components/responses/Error.403"
321
322
          },
          "404": {
323
            "$ref": "#/components/responses/Error.404"
324
          }
325
326
327
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/Services"
328
329
330
331
332
333
        }
      }
    },
    "/services/{serviceId}": {
      "parameters": [
        {
334
          "$ref": "#/components/parameters/Path.ServiceId"
335
336
337
338
        }
      ],
      "get": {
        "description": "This method retrieves information about a meService resource. This method is typically used in \"service availability query\" procedure",
339
        "operationId": "ServicesServiceId_GET",
340
341
        "responses": {
          "200": {
342
            "$ref": "#/components/responses/ServicesServiceId.200"
343
344
          },
          "400": {
345
            "$ref": "#/components/responses/Error.400"
346
347
          },
          "403": {
348
            "$ref": "#/components/responses/Error.403"
349
350
          },
          "404": {
351
            "$ref": "#/components/responses/Error.404"
352
353
354
355
356
          }
        }
      },
      "put": {
        "description": "This method updates the information about a meService resource",
357
        "operationId": "ServicesServiceId_PUT",
358
359
        "responses": {
          "200": {
360
            "$ref": "#/components/responses/ServicesServiceId.200"
361
362
          },
          "400": {
363
            "$ref": "#/components/responses/Error.400"
364
365
          },
          "403": {
366
            "$ref": "#/components/responses/Error.403"
367
368
          },
          "404": {
369
            "$ref": "#/components/responses/Error.404"
370
371
          },
          "412": {
372
            "$ref": "#/components/responses/Error.412"
373
          }
374
375
376
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ServicesServiceId"
377
378
379
380
381
382
        }
      }
    },
    "/timing/current_time": {
      "get": {
        "description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure",
383
        "operationId": "TimingCurrentTime_GET",
384
385
        "responses": {
          "200": {
386
            "$ref": "#/components/responses/TimingCurrentTime.200"
387
388
          },
          "400": {
389
            "$ref": "#/components/responses/Error.400"
390
391
          },
          "403": {
392
            "$ref": "#/components/responses/Error.403"
393
394
          },
          "404": {
395
            "$ref": "#/components/responses/Error.404"
396
397
398
399
400
401
402
          }
        }
      }
    },
    "/timing/timing_caps": {
      "get": {
        "description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query",
403
        "operationId": "TimingCaps_GET",
404
405
        "responses": {
          "200": {
406
            "$ref": "#/components/responses/TimingCaps.200"
407
408
          },
          "400": {
409
            "$ref": "#/components/responses/Error.400"
410
411
          },
          "403": {
412
            "$ref": "#/components/responses/Error.403"
413
414
          },
          "404": {
415
            "$ref": "#/components/responses/Error.404"
416
417
418
419
420
421
422
          }
        }
      }
    },
    "/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",
423
        "operationId": "Transports_GET",
424
425
        "responses": {
          "200": {
426
            "$ref": "#/components/responses/Transports.200"
427
428
          },
          "400": {
429
            "$ref": "#/components/responses/Error.400"
430
431
          },
          "403": {
432
            "$ref": "#/components/responses/Error.403"
433
434
          },
          "404": {
435
            "$ref": "#/components/responses/Error.404"
436
437
438
439
440
          }
        }
      }
    }
  },
441
442
443
444
445
446
447
  "components": {
    "schemas": {
      "Empty": {
        "description": "Empty schema"
      },
      "AppTerminationNotification.MaxGracefulTimeout": {
        "description": "Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.",
448
        "type": "integer",
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
        "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"
          }
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
      },
      "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"
          }
509
        }
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
      },
      "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"
          }
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
      },
      "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"
          }
590
        }
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
      },
      "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"
          }
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
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
      },
      "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"
          }
704
        }
705
706
707
708
709
710
      },
      "EndPointInfo.Address.Host": {
        "description": "Host portion of the address",
        "type": "string",
        "example": "192.0.2.0"
      },
711
      "EndPointInfo.Address_Port": {
712
713
714
        "description": "Port portion of the address",
        "type": "integer",
        "format": "uint32",
715
        "example": 8080
716
717
718
719
720
721
722
723
724
      },
      "EndPointInfo.Address": {
        "description": "A IP address and port pair",
        "type": "object",
        "properties": {
          "host": {
            "$ref": "#/components/schemas/EndPointInfo.Address.Host"
          },
          "port": {
725
            "$ref": "#/components/schemas/EndPointInfo.Address_Port"
726
          }
727
        }
728
729
730
      },
      "EndPointInfo.Addresses": {
        "description": "Entry point information of the service as one or more pairs of IP address and port",
731
732
733
734
735
736
737
738
739
740
741
742
        "type": "object",
        "required": [
          "addresses"
        ],
        "properties": {
          "addresses": {
            "type": "array",
            "minItems": 0,
            "items": {
              "$ref": "#/components/schemas/EndPointInfo.Address"
            }
          }
743
744
745
746
        }
      },
      "EndPointInfo.Alternative": {
        "description": "Entry point information of the service in a format defined by an implementation, or in an external specification.",
747
748
749
750
751
752
753
754
755
        "type": "object",
        "required": [
          "alternative"
        ],
        "properties": {
          "alternative": {
            "type": "object"
          }
        }
756
757
758
759
760
761
762
763
764
      },
      "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",
765
766
767
768
769
770
771
772
773
774
775
776
        "type": "object",
        "required": [
          "uris"
        ],
        "properties": {
          "uris": {
            "type": "array",
            "minItems": 0,
            "items": {
              "$ref": "#/components/schemas/EndPointInfo.Uri"
            }
          }
777
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
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
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
        }
      },
      "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"
          }
919
        },
920
921
922
923
924
925
926
927
928
        "type": "object"
      },
      "SecurityInfo": {
        "description": "This type represents security information related to a transport",
        "type": "object",
        "properties": {
          "oAuth2Info": {
            "$ref": "#/components/schemas/SecurityInfo.OAuth2Info"
          }
929
        }
930
931
932
933
934
935
936
937
938
939
940
      },
      "Self": {
        "description": "Self-referring URI.",
        "type": "object",
        "required": [
          "self"
        ],
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          }
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
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
        "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"
      },
      "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",
        "example": "Rest1"
      },
      "ServiceInfo.Version": {
        "description": "Service version",
        "type": "string",
        "example": "ServiceVersion1"
      },
      "ServiceInfo": {
        "description": "This type represents the general information of a mobile edge service.",
        "type": "object",
        "required": [
          "serName",
          "version",
          "state",
          "serializer"
        ],
        "properties": {
          "serInstanceId": {
            "$ref": "#/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"
          }
        }
      },
      "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"
      },
1143
      "TimingCaps.NtpServers_PtpMasterIpAddress": {
1144
1145
1146
1147
        "description": "PTP Master IP Address",
        "type": "string",
        "example": "192.0.2.0"
      },
1148
      "TimingCaps.NtpServers_PtpMasterLocalPriority": {
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
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
        "description": "PTP Master local priority",
        "type": "integer",
        "format": "uint32",
        "example": 1
      },
      "TimingCaps.NtpServers": {
        "description": "NTP server detail.",
        "type": "object",
        "required": [
          "ntpServerAddrType",
          "ntpServerAddr",
          "minPollingInterval",
          "maxPollingInterval",
          "localPriority",
          "authenticationOption",
          "authenticationKeyNum"
        ],
        "properties": {
          "ntpServerAddrType": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.NtpServerAddrType"
          },
          "ntpServerAddr": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.NtpServerAddr"
          },
          "minPollingInterval": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.MinPollingInterval"
          },
          "maxPollingInterval": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.MaxPollingInterval"
          },
          "localPriority": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.LocalPriority"
          },
          "authenticationOption": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.AuthenticationOption"
          },
          "authenticationKeyNum": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.AuthenticationKeyNum"
          }
        }
      },
1190
      "TimingCaps_PtpMasters": {
1191
1192
1193
1194
1195
1196
1197
1198
1199
        "description": "NTP server detail.",
        "type": "object",
        "required": [
          "ptpMasterIpAddress",
          "ptpMasterLocalPriority",
          "delayReqMaxRate"
        ],
        "properties": {
          "ptpMasterIpAddress": {
1200
            "$ref": "#/components/schemas/TimingCaps.NtpServers_PtpMasterIpAddress"
1201
1202
          },
          "ptpMasterLocalPriority": {
1203
            "$ref": "#/components/schemas/TimingCaps.NtpServers_PtpMasterLocalPriority"
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
          },
          "delayReqMaxRate": {
            "$ref": "#/components/schemas/TimingCaps.NtpServers.DelayReqMaxRate"
          }
        }
      },
      "TimingCaps.TimeStamp": {
        "description": "time",
        "type": "object",
        "required": [
          "nanoSeconds",
          "seconds"
        ],
        "properties": {
          "seconds": {
            "type": "integer",
            "format": "uint32",
            "description": "The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
            "example": 1577836800
          },
          "nanoSeconds": {
            "type": "integer",
            "format": "uint32",
            "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
            "example": 0
          }
        }
      },
      "TimingCaps": {
        "description": "This type represents the information provided by the mobile edge platform in response to the Timing capabilities Query message.",
        "type": "object",
        "properties": {
          "timeStamp": {
            "$ref": "#/components/schemas/TimingCaps.TimeStamp"
          },
          "ntpServers": {
            "description": "Available NTP servers",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TimingCaps.NtpServers"
            }
          },
          "ptpMasters": {
            "description": "Available PTP Masters",
            "type": "array",
            "items": {
1250
              "$ref": "#/components/schemas/TimingCaps_PtpMasters"
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
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
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
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
            }
          }
        }
      },
      "TrafficFilter.Address": {
        "description": "Identify the traffic ip address.",
        "type": "string",
        "example": "192.168.1.1"
      },
      "TrafficFilter.DSCP": {
        "description": "Used to match all IPv4 packets that have the same Differentiated Services Code Point (DSCP)",
        "type": "integer",
        "format": "uint32",
        "example": 0
      },
      "TrafficFilter.Port": {
        "description": "A port",
        "type": "string",
        "example": "8080"
      },
      "TrafficFilter.Protocol": {
        "description": "Protocol of the traffic filter",
        "type": "string",
        "example": "?"
      },
      "TrafficFilter.QCI": {
        "description": "Used to match all packets that have the same Quality Class Indicator (QCI).",
        "type": "integer",
        "format": "uint32",
        "example": 1
      },
      "TrafficFilter.TC": {
        "description": "Used to match all IPv6 packets that have the same Traffic Class.",
        "type": "integer",
        "format": "uint32",
        "example": 1
      },
      "TrafficFilter.Token": {
        "description": "Used for token based traffic rule",
        "type": "string",
        "example": "?"
      },
      "TrafficFilter.TunnelAddress": {
        "description": "Used for GTP tunnel based traffic rule",
        "type": "string",
        "example": "?"
      },
      "TrafficFilter.TunnelPort": {
        "description": "Used for GTP tunnel based traffic rule",
        "type": "string",
        "example": "?"
      },
      "TrafficFilter": {
        "description": "This type represents the traffic filter.",
        "type": "object",
        "properties": {
          "srcAddress": {
            "description": "An IP address or a range of IP address. For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses. For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.Address"
            }
          },
          "dstAddress": {
            "description": "An IP address or a range of IP address. For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses. For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.Address"
            }
          },
          "srcPort": {
            "description": "A port or a range of ports",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.Port"
            }
          },
          "dstPort": {
            "description": "A port or a range of ports",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.Port"
            }
          },
          "protocol": {
            "description": "Specify the protocol of the traffic filter",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.Protocol"
            }
          },
          "token": {
            "description": "Used for token based traffic rule",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.Token"
            }
          },
          "srcTunnelAddress": {
            "description": "Used for GTP tunnel based traffic rule",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.TunnelAddress"
            }
          },
          "tgtTunnelAddress": {
            "description": "Used for GTP tunnel based traffic rule",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.TunnelAddress"
            }
          },
          "srcTunnelPort": {
            "description": "Used for GTP tunnel based traffic rule",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.TunnelPort"
            }
          },
          "dstTunnelPort": {
            "description": "Used for GTP tunnel based traffic rule",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter.TunnelPort"
            }
          },
          "qCI": {
            "$ref": "#/components/schemas/TrafficFilter.QCI"
          },
          "dSCP": {
            "$ref": "#/components/schemas/TrafficFilter.DSCP"
          },
          "tC": {
            "$ref": "#/components/schemas/TrafficFilter.TC"
          }
        }
      },
      "TrafficRule.Action": {
        "description": "The action of the ME host data plane when a packet matches the trafficFilter",
        "type": "string",
        "enum": [
          "DROP",
          "FORWARD_DECAPSULATED",
          "FORWARD_AS_IS",
          "PASSTHROUGH",
          "DUPLICATE_DECAPSULATED",
          "DUPLICATE_AS_IS"
        ],
        "example": "DROP"
      },
      "TrafficRule.FilterType": {
        "description": "Definition of filter per FLOW or PACKET. If flow the filter match UE->EPC packet and the reverse packet is handled in the same context",
        "type": "string",
        "enum": [
          "FLOW",
          "PACKET"
        ],
        "example": "FLOW"
      },
      "TrafficRule.Id": {
        "description": "Identify the traffic rule.",
        "type": "string",
        "example": "TrafficRule1"
      },
1415
      "TrafficRule_Priority": {
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
        "description": "Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence",
        "type": "integer",
        "format": "uint32",
        "example": 1
      },
      "TrafficRule.State": {
        "description": "Contains the traffic rule state",
        "type": "string",
        "enum": [
          "ACTIVE",
          "INACTIVE"
        ],
        "example": "ACTIVE"
      },
      "TrafficRule": {
        "description": "This type represents the general information of a traffic rule.",
        "type": "object",
        "required": [
          "trafficRuleId",
          "filterType",
          "priority",
          "trafficFilter",
          "action",
          "state"
        ],
        "properties": {
          "trafficRuleId": {
            "$ref": "#/components/schemas/TrafficRule.Id"
          },
          "filterType": {
            "$ref": "#/components/schemas/TrafficRule.FilterType"
          },
          "priority": {
1449
            "$ref": "#/components/schemas/TrafficRule_Priority"
1450
1451
          },
          "trafficFilter": {
1452
1453
1454
1455
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter"
            }
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
          },
          "action": {
            "$ref": "#/components/schemas/TrafficRule.Action"
          },
          "dstInterface": {
            "$ref": "#/components/schemas/DestinationInterface"
          },
          "state": {
            "$ref": "#/components/schemas/TrafficRule.State"
          }
        }
      },
      "TransportInfo.Description": {
        "description": "Human-readable description of this transport",
        "type": "string",
        "example": "REST API"
      },
      "TransportInfo.Id": {
        "description": "The identifier of this transport",
        "type": "string",
        "example": "TransId12345"
      },
      "TransportInfo.ImplSpecificInfo": {
        "description": "Additional implementation specific details of the transport",
        "type": "object"
      },
      "TransportInfo.Name": {
        "description": "The name of this transport",
        "type": "string",
        "example": "REST"
      },
      "TransportInfo.Protocol": {
        "description": "The name of the protocol used. Shall be set to HTTP for a REST API.",
        "type": "string",
        "example": "HTTP"
      },
      "TransportInfo.Version": {
        "description": "The version of the protocol used",
        "type": "string",
        "example": "2.0"
      },
      "TransportInfo": {
        "description": "This type represents the general information of a mobile edge service.",
        "type": "object",
        "required": [
          "id",
          "name",
          "type",
          "protocol",
          "version",
          "endpoint",
          "security"
        ],
        "properties": {
          "id": {
            "$ref": "#/components/schemas/TransportInfo.Id"
          },
          "name": {
            "$ref": "#/components/schemas/TransportInfo.Name"
          },
          "description": {
            "$ref": "#/components/schemas/TransportInfo.Description"
          },
          "type": {
            "$ref": "#/components/schemas/TransportTypes"
          },
          "protocol": {
            "$ref": "#/components/schemas/TransportInfo.Protocol"
          },
          "version": {
            "$ref": "#/components/schemas/TransportInfo.Version"
          },
          "endpoint": {
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
            "description": "This type represents information about a transport endpoint",
            "type": "object",
            "oneOf": [
              {
                "$ref": "#/components/schemas/EndPointInfo.Uris"
              },
              {
                "$ref": "#/components/schemas/EndPointInfo.Addresses"
              },
              {
                "$ref": "#/components/schemas/EndPointInfo.Alternative"
              }
            ]
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
          },
          "security": {
            "$ref": "#/components/schemas/SecurityInfo"
          },
          "implSpecificInfo": {
            "$ref": "#/components/schemas/TransportInfo.ImplSpecificInfo"
          }
        }
      },
      "TransportTypes": {
        "description": "The enumeration TransportTypes represents types of transports",
        "type": "string",
        "enum": [
          "REST_HTTP",
          "MB_TOPIC_BASED",
          "MB_ROUTING",
          "MB_PUBSUB",
          "RPC",
          "RPC_STREAMING",
          "WEBSOCKET"
        ],