Mp1.yaml 61.3 KB
Newer Older
1
2
openapi: 3.0.0
servers:
3
4
  - url: 'http://127.0.0.1:8081/mp1/v1/'
  - url: 'https://127.0.0.1:8081/mp1/v1/'
5
info:
6
  title: Mp1 API
7
  version: 1.1.1
8
  description: The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI
9
10
11
12
  license:
    name: ETSI Forge copyright notice
    url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
externalDocs:
13
  description: 'ETSI GS MEC011 Application Enablement API, V1.1.1'
14
15
  url: >-
    http://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf
16
17
paths:
  '/applications/{appInstanceId}/dns_rules':
18
    parameters:
19
      - $ref: '#/components/parameters/Path.AppInstanceId'
20
    get:
21
22
23
      description: >-
        This method retrieves information about all the DNS rules associated
        with a mobile edge application instance.
24
      operationId: ApplicationsDnsRules_GET
25
26
      responses:
        '200':
27
          $ref: '#/components/responses/ApplicationsDnsRules.200'
28
        '400':
29
          $ref: '#/components/responses/Error.400'
30
        '403':
31
          $ref: '#/components/responses/Error.403'
32
        '404':
33
          $ref: '#/components/responses/Error.404'
34
  '/applications/{appInstanceId}/dns_rules/{dnsRuleId}':
35
    parameters:
36
37
      - $ref: '#/components/parameters/Path.AppInstanceId'
      - $ref: '#/components/parameters/Path.DnsRuleId'
38
    get:
39
40
41
      description: >-
        This method retrieves information about a DNS rule associated with a
        mobile edge application instance.
42
      operationId: ApplicationsDnsRule_GET
43
44
      responses:
        '200':
45
          $ref: '#/components/responses/ApplicationsDnsRule.200'
46
        '400':
47
          $ref: '#/components/responses/Error.400'
48
        '403':
49
          $ref: '#/components/responses/Error.403'
50
        '404':
51
          $ref: '#/components/responses/Error.404'
52
53
    put:
      description: 'This method activates, de-activates or updates a traffic rule.'
54
      operationId: ApplicationsDnsRule_PUT
55
56
      responses:
        '200':
57
          $ref: '#/components/responses/ApplicationsDnsRule.200'
58
        '400':
59
          $ref: '#/components/responses/Error.400'
60
        '403':
61
          $ref: '#/components/responses/Error.403'
62
        '404':
63
          $ref: '#/components/responses/Error.404'
64
        '412':
65
66
67
          $ref: '#/components/responses/Error.412'
      requestBody:
          $ref: '#/components/requestBodies/ApplicationsDnsRule'
68
  '/applications/{appInstanceId}/subscriptions':
69
    parameters:
70
      - $ref: '#/components/parameters/Path.AppInstanceId'
71
    get:
72
73
74
75
      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.
76
      operationId: ApplicationsSubscriptions_GET
77
78
      responses:
        '200':
79
          $ref: '#/components/responses/ApplicationsSubscriptions.200'
80
        '400':
81
          $ref: '#/components/responses/Error.400'
82
        '403':
83
          $ref: '#/components/responses/Error.403'
84
        '404':
85
          $ref: '#/components/responses/Error.404'
86
    post:
87
88
89
90
91
      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.
92
      operationId: ApplicationsSubscriptions_POST
93
      responses:
94
        '201':
95
          $ref: '#/components/responses/ApplicationsSubscriptions.201'
96
        '400':
97
          $ref: '#/components/responses/Error.400'
98
        '403':
99
          $ref: '#/components/responses/Error.403'
100
        '404':
101
102
103
104
105
106
107
108
          $ref: '#/components/responses/Error.404'
      requestBody:
        $ref: '#/components/requestBodies/ApplicationsSubscriptions'
      callbacks:
        appTerminationNotification:
          $ref: '#/components/callbacks/AppTerminationNotification'
        serviceAvailabilityNotification:
          $ref: '#/components/callbacks/ServiceAvailabilityNotification'
109
  '/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}':
110
    parameters:
111
112
113
      - $ref: '#/components/parameters/Path.AppInstanceId'
      - $ref: '#/components/parameters/Path.SubscriptionType'
      - $ref: '#/components/parameters/Path.SubscriptionId'
114
    get:
115
116
117
118
      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.
119
      operationId: ApplicationsSubscription_GET
120
121
      responses:
        '200':
122
          $ref: '#/components/responses/ApplicationsSubscription.200'
123
        '400':
124
          $ref: '#/components/responses/Error.400'
125
        '403':
126
          $ref: '#/components/responses/Error.403'
127
        '404':
128
          $ref: '#/components/responses/Error.404'
129
    delete:
130
131
132
133
      description: >-
        This method deletes a meMp1Subscription. This method is typically used
        in "Unsubscribing from service availability event notifications"
        procedure.
134
      operationId: ApplicationsSubscription_DELETE
135
136
137
      responses:
        '204':
          description: No Content
138
        '403':
139
          $ref: '#/components/responses/Error.403'
140
        '404':
141
          $ref: '#/components/responses/Error.404'
142
  '/applications/{appInstanceId}/traffic_rules':
143
    parameters:
144
      - $ref: '#/components/parameters/Path.AppInstanceId'
145
    get:
146
147
148
      description: >-
        This method retrieves information about all the traffic rules associated
        with a mobile edge application instance.
149
      operationId: ApplicationsTrafficRules_GET
150
151
      responses:
        '200':
152
          $ref: '#/components/responses/ApplicationsTrafficRules.200'
153
        '400':
154
          $ref: '#/components/responses/Error.400'
155
        '403':
156
          $ref: '#/components/responses/Error.403'
157
        '404':
158
          $ref: '#/components/responses/Error.404'
159
  '/applications/{appInstanceId}/traffic_rules/{trafficRuleId}':
160
    parameters:
161
162
      - $ref: '#/components/parameters/Path.AppInstanceId'
      - $ref: '#/components/parameters/Path.TrafficRuleId'
163
    get:
164
165
166
      description: >-
        This method retrieves information about all the traffic rules associated
        with a mobile edge application instance.
167
      operationId: ApplicationsTrafficRule_GET
168
169
      responses:
        '200':
170
          $ref: '#/components/responses/ApplicationsTrafficRule.200'
171
        '400':
172
          $ref: '#/components/responses/Error.400'
173
        '403':
174
          $ref: '#/components/responses/Error.403'
175
        '404':
176
          $ref: '#/components/responses/Error.404'
177
    put:
178
179
180
      description: >-
        This method retrieves information about all the traffic rules associated
        with a mobile edge application instance.
181
      operationId: ApplicationsTrafficRule_PUT
182
183
      responses:
        '200':
184
          $ref: '#/components/responses/ApplicationsTrafficRule.200'
185
        '400':
186
          $ref: '#/components/responses/Error.400'
187
        '403':
188
          $ref: '#/components/responses/Error.403'
189
        '404':
190
          $ref: '#/components/responses/Error.404'
191
        '412':
192
193
194
          $ref: '#/components/responses/Error.412'
      requestBody:
        $ref: '#/components/requestBodies/ApplicationsTrafficRule'
195
  '/services':
196
    get:
197
198
199
      description: >-
        This method retrieves information about a list of meService resources.
        This method is typically used in "service availability query" procedure
200
      operationId: Services_GET
201
      parameters:
202
203
204
        - $ref: '#/components/parameters/Query.Ser_instance_id'
        - $ref: '#/components/parameters/Query.Ser_name'
        - $ref: '#/components/parameters/Query.Ser_category_id'
205
206
      responses:
        '200':
207
          $ref: '#/components/responses/Services.200'
208
        '400':
209
          $ref: '#/components/responses/Error.400'
210
        '403':
211
          $ref: '#/components/responses/Error.403'
212
        '404':
213
          $ref: '#/components/responses/Error.404'
214
    post:
215
216
217
218
      description: >-
        This method is used to create a meService resource. This method is
        typically used in "service availability update and new service
        registration" procedure
219
      operationId: Services_POST
220
221
      responses:
        '201':
222
          $ref: '#/components/responses/Services.201'
223
        '400':
224
          $ref: '#/components/responses/Error.400'
225
        '403':
226
          $ref: '#/components/responses/Error.403'
227
        '404':
228
229
230
          $ref: '#/components/responses/Error.404'
      requestBody:
        $ref: '#/components/requestBodies/Services'
231
  '/services/{serviceId}':
232
    parameters:
233
      - $ref: '#/components/parameters/Path.ServiceId'
234
    get:
235
236
237
      description: >-
        This method retrieves information about a meService resource. This
        method is typically used in "service availability query" procedure
238
      operationId: ServicesServiceId_GET
239
240
      responses:
        '200':
241
          $ref: '#/components/responses/ServicesServiceId.200'
242
        '400':
243
          $ref: '#/components/responses/Error.400'
244
        '403':
245
          $ref: '#/components/responses/Error.403'
246
        '404':
247
          $ref: '#/components/responses/Error.404'
248
249
    put:
      description: This method updates the information about a meService resource
250
      operationId: ServicesServiceId_PUT
251
252
      responses:
        '200':
253
          $ref: '#/components/responses/ServicesServiceId.200'
254
        '400':
255
          $ref: '#/components/responses/Error.400'
256
        '403':
257
          $ref: '#/components/responses/Error.403'
258
        '404':
259
          $ref: '#/components/responses/Error.404'
260
        '412':
261
262
263
          $ref: '#/components/responses/Error.412'
      requestBody:
        $ref: '#/components/requestBodies/ServicesServiceId'
264
  '/timing/current_time':
265
    get:
266
267
268
      description: >-
        This method retrieves the information of the platform's current time
        which corresponds to the get platform time procedure
269
      operationId: TimingCurrentTime_GET
270
271
      responses:
        '200':
272
          $ref: '#/components/responses/TimingCurrentTime.200'
273
        '400':
274
          $ref: '#/components/responses/Error.400'
275
        '403':
276
          $ref: '#/components/responses/Error.403'
277
        '404':
278
          $ref: '#/components/responses/Error.404'
279
  '/timing/timing_caps':
280
    get:
281
282
283
      description: >-
        This method retrieves the information of the platform's timing
        capabilities which corresponds to the timing capabilities query
284
      operationId: TimingCaps_GET
285
286
      responses:
        '200':
287
          $ref: '#/components/responses/TimingCaps.200'
288
        '400':
289
          $ref: '#/components/responses/Error.400'
290
        '403':
291
          $ref: '#/components/responses/Error.403'
292
        '404':
293
          $ref: '#/components/responses/Error.404'
294
  '/transports':
295
    get:
296
297
298
299
300
      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
301
      operationId: Transports_GET
302
303
      responses:
        '200':
304
          $ref: '#/components/responses/Transports.200'
305
        '400':
306
          $ref: '#/components/responses/Error.400'
307
        '403':
308
          $ref: '#/components/responses/Error.403'
309
        '404':
310
311
312
313
314
315
316
317
318
          $ref: '#/components/responses/Error.404'
components:
  schemas:
    Empty:
      description: Empty schema
    AppTerminationNotification.MaxGracefulTimeout:
      description: >-
        Maximum timeout value in seconds for graceful termination or graceful
        stop of an application instance.
319
      type: integer
320
321
322
323
324
      format: uint32
      example: 10
    AppTerminationNotification.NotificationType:
      description: Shall be set to AppTerminationNotification.
      type: string
325
      example: 'AppTerminationNotification'
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
    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'
    AppTerminationNotificationSubscription.AppInstanceId:
      description: It is used as the filtering criterion for the subscribed events.
      type: string
346
      example: 'ID1'
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
    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
    AppTerminationNotificationSubscription.SubscriptionType:
      description: Shall be set to AppTerminationNotificationSubscription.
      type: string
381
      example: 'AppTerminationNotificationSubscription'
382
383
384
    CategoryRef.Href:
      description: Reference of the catalogue
      type: string
385
      example: 'catItem1'
386
387
388
    CategoryRef.Id:
      description: Unique identifier of the category
      type: string
389
      example: 'id12345'
390
391
392
    CategoryRef.Name:
      description: Name of the category
      type: string
393
      example: 'RNI'
394
395
396
    CategoryRef.Version:
      description: Category version
      type: string
397
      example: 'version1'
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
    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'
    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
448
          example: 'TRACEABLE'
449
450
451
452
453
454
455
    DestinationInterface.InterfaceType:
      description: Type of the interface
      type: string
      enum:
        - TUNNEL
        - MAC
        - IP
456
      example: 'TUNNEL'
457
458
459
    DestinationInterface.IpAddress:
      description: IP address of the remote destination
      type: string
460
      example: '192.0.2.0'
461
462
463
    DestinationInterface.MacAddress:
      description: Source address identifies the MAC address of the interface
      type: string
464
      example: '02-00-00-00-00-00'
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
    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'
    DnsRule.DomainName:
      description: FQDN resolved by the DNS rule
      type: string
484
      example: 'www.example.com'
485
486
487
    DnsRule.Id:
      description: Identifies the DNS Rule
      type: string
488
      example: 'dnsRule1'
489
490
491
    DnsRule.IpAddress:
      description: IP address associated with the FQDN resolved by the DNS rule
      type: string
492
      example: '192.0.2.0'
493
494
495
496
497
498
    DnsRule.IpAddressType:
      description: IP address type
      type: string
      enum:
        - IP_V6
        - IP_V4
499
      example: 'IP_V6'
500
501
502
503
504
505
    DnsRule.State:
      description: DNS rule state
      type: string
      enum:
        - ACTIVE
        - INACTIVE
506
      example: 'ACTIVE'
507
508
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
    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'
    EndPointInfo.Address.Host:
      description: Host portion of the address
      type: string
537
      example: '192.0.2.0'
538
    EndPointInfo.Address_Port:
539
540
541
      description: Port portion of the address
      type: integer
      format: uint32
542
      example: 8080
543
544
545
546
547
548
549
    EndPointInfo.Address:
      description: A IP address and port pair
      type: object
      properties:
        host:
          $ref: '#/components/schemas/EndPointInfo.Address.Host'
        port:
550
          $ref: '#/components/schemas/EndPointInfo.Address_Port'
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
    EndPointInfo.Addresses:
      description: >-
        Entry point information of the service as one or more pairs of IP
        address and port
      type: array
      items:
        $ref: '#/components/schemas/EndPointInfo.Address'
    EndPointInfo.Alternative:
      description: >-
        Entry point information of the service in a format defined by an
        implementation, or in an external specification.
      type: object
    EndPointInfo.Uri:
      description: Entry point information of the service
      type: string
      format: uri
567
      example: '/meMp1/service/EntryPoint'
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
    EndPointInfo.Uris:
      description: >-
        Entry point information of the service as string, formatted according to
        URI syntax
      type: array
      items:
        $ref: '#/components/schemas/EndPointInfo.Uri'
    EndPointInfo:
      description: This type represents information about a transport endpoint
      type: object
      properties:
        uris:
          $ref: '#/components/schemas/EndPointInfo.Uris'
        addresses:
          $ref: '#/components/schemas/EndPointInfo.Addresses'
        alternative:
          $ref: '#/components/schemas/EndPointInfo.Alternative'
    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
595
      example: '/meMp1/example'
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
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
    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
678
      example: 'OAUTH2_CLIENT_CREDENTIALS'
679
680
681
682
    SecurityInfo.OAuth2Info.TokenEndpoint:
      description: The token endpoint
      type: string
      format: uri
683
      example: '/meMp1/security/TokenEndPoint'
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
    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'
      type: object
    SecurityInfo:
      description: This type represents security information related to a transport
      type: object
      properties:
        oAuth2Info:
          $ref: '#/components/schemas/SecurityInfo.OAuth2Info'
    Self:
      description: Self-referring URI.
      type: object
      required:
        - self
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
      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
743
      example: 'SerAvailabilityNotificationSubscription'
744
745
746
747
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
    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
776
      example: 'ServiceInstance123'
777
778
779
780
781
    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
782
      example: 'ExampleService'
783
784
785
786
787
788
    ServiceInfo.State:
      description: Contains the state
      type: string
      enum:
        - ACTIVE
        - INACTIVE
789
      example: 'ACTIVE'
790
791
792
793
794
795
796
797
    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
798
      example: 'Rest1'
799
800
801
    ServiceInfo.Version:
      description: Service version
      type: string
802
      example: 'ServiceVersion1'
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
    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
848
      example: 'NONE'
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
    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
876
      example: '192.0.2.0'
877
878
879
880
881
882
    TimingCaps.NtpServers.NtpServerAddrType:
      description: Address type of NTP server
      type: string
      enum:
        - IP_ADDRESS
        - DNS_NAME
883
      example: 'IP_ADDRESS'
884
    TimingCaps.NtpServers_PtpMasterIpAddress:
885
886
      description: PTP Master IP Address
      type: string
887
      example: '192.0.2.0'
888
    TimingCaps.NtpServers_PtpMasterLocalPriority:
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
      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'
919
    TimingCaps_PtpMasters:
920
921
922
923
924
925
926
927
      description: NTP server detail.
      type: object
      required:
        - ptpMasterIpAddress
        - ptpMasterLocalPriority
        - delayReqMaxRate
      properties:
        ptpMasterIpAddress:
928
          $ref: '#/components/schemas/TimingCaps.NtpServers_PtpMasterIpAddress'
929
        ptpMasterLocalPriority:
930
          $ref: '#/components/schemas/TimingCaps.NtpServers_PtpMasterLocalPriority'
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
        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:
971
            $ref: '#/components/schemas/TimingCaps_PtpMasters'
972
973
974
    TrafficFilter.Address:
      description: Identify the traffic ip address.
      type: string
975
      example: '192.168.1.1'
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
    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
1095
      example: 'DROP'
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
    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
1108
      example: 'TrafficRule1'
1109
    TrafficRule_Priority:
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
      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
1122
      example: 'ACTIVE'
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
    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:
1139
          $ref: '#/components/schemas/TrafficRule_Priority'
1140
        trafficFilter:
1141
1142
1143
          type: array
          items:
            $ref: '#/components/schemas/TrafficFilter'
1144
1145
1146
1147
1148
1149
1150
1151
1152
        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
1153
      example: 'REST API'
1154
1155
1156
    TransportInfo.Id:
      description: The identifier of this transport
      type: string
1157
      example: 'TransId12345'
1158
1159
1160
1161
1162
1163
    TransportInfo.ImplSpecificInfo:
      description: Additional implementation specific details of the transport
      type: object
    TransportInfo.Name:
      description: The name of this transport
      type: string
1164
      example: 'REST'
1165
1166
1167
    TransportInfo.Protocol:
      description: The name of the protocol used. Shall be set to HTTP for a REST API.
      type: string
1168
      example: 'HTTP'
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
    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:
          $ref: '#/components/schemas/EndPointInfo'
        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
1214
      example: 'REST_HTTP'
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
    TunnelInfo.TunnelDstAddress:
      description: Destination address of the tunnel
      type: string
      example: '?'
    TunnelInfo.TunnelSrcAddress:
      description: Source address of the tunnel
      type: string
      example: '?'
    TunnelInfo.TunnelType:
      description: This type represents the tunnel information.
      type: string
      enum:
        - GTP_U
        - GRE
1229
      example: 'GTP_U'
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
    TunnelInfo:
      description: This type represents the tunnel information.
      type: object
      required:
        - tunnelType
      properties:
        tunnelType:
          $ref: '#/components/schemas/TunnelInfo.TunnelType'
        tunnelDstAddress:
          $ref: '#/components/schemas/TunnelInfo.TunnelDstAddress'
        tunnelSrcAddress:
          $ref: '#/components/schemas/TunnelInfo.TunnelSrcAddress'
  parameters:
    Path.AppInstanceId:
      name: appInstanceId
      description: >-
        Represents a mobile edge application instance. Note that the
        appInstanceId is allocated by the mobile edge platform manager.
      in: path
      required: true
      schema:
1251
        type: string
1252
1253
1254
1255
1256
1257
    Path.DnsRuleId:
      name: dnsRuleId
      description: Represents a DNS rule.
      in: path
      required: true
      schema:
1258
        type: string
1259
1260
1261
1262
1263
1264
1265
1266
    Path.SubscriptionId:
      name: subscriptionId
      description: >-
        Represents a subscription to the notifications from the mobile edge
        platform.
      in: path
      required: true
      schema:
1267
        type: string
1268
1269
1270
1271
1272
1273
1274
1275
1276
    Path.SubscriptionType:
      name: subscriptionType
      description: >-
        Represents a subscription type to the notifications from the mobile edge
        platform.
      in: path
      required: true
      schema:
        type: string
1277
1278
1279
        enum:
          - AppTerminationNotificationSubscription        
          - SerAvailabilityNotificationSubscription
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
    Path.ServiceId:
      name: serviceId
      description: Represents a mobile edge service instance.
      in: path
      required: true
      schema:
        type: string
    Path.TrafficRuleId:
      name: trafficRuleId
      description: Represents a traffic rule.
      in: path
      required: true
      schema:
        type: string
    Query.Ser_category_id:
      name: ser_category_id
      description: >-
        A mobile edge application instance may use ser_category_id as an input
        parameter to query the availability of a list of mobile edge service
        instances in a serCategory. Either "ser_instance_id" or "ser_name" or
        "ser_category_id" or none of them shall be present.
      in: query
      required: false
      schema:
        type: string
    Query.Ser_instance_id:
      name: ser_instance_id
      description: >-
        A mobile edge application instance may use multiple ser_instance_ids as
        an input parameter to query the availability of a list of mobile edge
        service instances. Either "ser_instance_id" or "ser_name" or
        "ser_category_id" or none of them shall be present.
      in: query
      required: false
      schema:
1315
1316
        type: array
        items:
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
          type: string
    Query.Ser_name:
      name: ser_name
      description: >-
        A mobile edge application instance may use multiple ser_names as an
        input parameter to query the availability of a list of mobile edge
        service instances. Either "ser_instance_id" or "ser_name" or
        "ser_category_id" or none of them shall be present.
      in: query
      required: false
      schema:
1328
1329
        type: array
        items:
1330
1331