Mp1.yaml 72.3 KB
Newer Older
1
openapi: 3.0.2
2
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: 2.0.8
8
  description: The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI
9
10
11
  license:
    name: ETSI Forge copyright notice
    url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
12
13
  contact:
    email: cti_support@etsi.org
14
externalDocs:
15
  description: 'ETSI GS MEC011 Application Enablement API, V2.0.8'
16
  url: >-
17
    https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv208.zip
18
tags:
19
20
21
22
23
  - name: appTrafficRules
  - name: appDnsRules
  - name: appSubscriptions
  - name: appConfirmTermination
  - name: appServices
24
25
26
27
  - name: services
  - name: timing
  - name: transports
  - name: callbacks
28
paths:
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
  '/applications/{appInstanceId}/confirm_termination':
    parameters:
      - $ref: '#/components/parameters/Path.AppInstanceId'
    post:
      description: >-
        This method is used to confirm the application level termination 
        of an application instance.
      operationId: ApplicationsConfirmTermination_POST
      tags:
        - appConfirmTermination
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/Error.401'
        '403':
          $ref: '#/components/responses/Error.403'
        '404':
          $ref: '#/components/responses/Error.404'
        '409':
          $ref: '#/components/responses/Error.409'
        '429':
          $ref: '#/components/responses/Error.429'
52
  '/applications/{appInstanceId}/dns_rules':
53
    parameters:
54
      - $ref: '#/components/parameters/Path.AppInstanceId'
55
    get:
56
57
58
      description: >-
        This method retrieves information about all the DNS rules associated
        with a mobile edge application instance.
59
      operationId: ApplicationsDnsRules_GET
60
      tags:
Walter Featherstone's avatar
Walter Featherstone committed
61
        - appDnsRules
62
63
      responses:
        '200':
64
          $ref: '#/components/responses/ApplicationsDnsRules.200'
65
        '400':
66
          $ref: '#/components/responses/Error.400'
67
        '403':
68
          $ref: '#/components/responses/Error.403'
69
        '404':
70
          $ref: '#/components/responses/Error.404'
71
  '/applications/{appInstanceId}/dns_rules/{dnsRuleId}':
72
    parameters:
73
74
      - $ref: '#/components/parameters/Path.AppInstanceId'
      - $ref: '#/components/parameters/Path.DnsRuleId'
75
    get:
76
77
78
      description: >-
        This method retrieves information about a DNS rule associated with a
        mobile edge application instance.
79
      operationId: ApplicationsDnsRule_GET
80
      tags:
81
        - appDnsRules
82
83
      responses:
        '200':
84
          $ref: '#/components/responses/ApplicationsDnsRule.200'
85
        '400':
86
          $ref: '#/components/responses/Error.400'
87
        '403':
88
          $ref: '#/components/responses/Error.403'
89
        '404':
90
          $ref: '#/components/responses/Error.404'
91
92
    put:
      description: 'This method activates, de-activates or updates a traffic rule.'
93
      operationId: ApplicationsDnsRule_PUT
94
      tags:
95
        - appDnsRules
96
97
      responses:
        '200':
98
          $ref: '#/components/responses/ApplicationsDnsRule.200'
99
        '400':
100
          $ref: '#/components/responses/Error.400'
101
        '403':
102
          $ref: '#/components/responses/Error.403'
103
        '404':
104
          $ref: '#/components/responses/Error.404'
105
        '412':
106
107
108
          $ref: '#/components/responses/Error.412'
      requestBody:
          $ref: '#/components/requestBodies/ApplicationsDnsRule'
109
  '/applications/{appInstanceId}/subscriptions':
110
    parameters:
111
      - $ref: '#/components/parameters/Path.AppInstanceId'
112
    get:
113
114
115
116
      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.
117
      operationId: ApplicationsSubscriptions_GET
118
      tags:
119
        - appSubscriptions
120
121
      responses:
        '200':
122
          $ref: '#/components/responses/ApplicationsSubscriptions.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
    post:
130
131
132
133
134
      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.
135
      operationId: ApplicationsSubscriptions_POST
136
      tags:
137
        - appSubscriptions
138
      responses:
139
        '201':
140
          $ref: '#/components/responses/ApplicationsSubscriptions.201'
141
        '400':
142
          $ref: '#/components/responses/Error.400'
143
        '403':
144
          $ref: '#/components/responses/Error.403'
145
        '404':
146
147
148
149
150
151
152
153
          $ref: '#/components/responses/Error.404'
      requestBody:
        $ref: '#/components/requestBodies/ApplicationsSubscriptions'
      callbacks:
        appTerminationNotification:
          $ref: '#/components/callbacks/AppTerminationNotification'
        serviceAvailabilityNotification:
          $ref: '#/components/callbacks/ServiceAvailabilityNotification'
154
  '/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}':
155
    parameters:
156
157
158
      - $ref: '#/components/parameters/Path.AppInstanceId'
      - $ref: '#/components/parameters/Path.SubscriptionType'
      - $ref: '#/components/parameters/Path.SubscriptionId'
159
    get:
160
161
162
163
      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.
164
      operationId: ApplicationsSubscription_GET
165
      tags:
166
        - appSubscriptions
167
168
      responses:
        '200':
169
          $ref: '#/components/responses/ApplicationsSubscription.200'
170
        '400':
171
          $ref: '#/components/responses/Error.400'
172
        '403':
173
          $ref: '#/components/responses/Error.403'
174
        '404':
175
          $ref: '#/components/responses/Error.404'
176
    delete:
177
178
179
180
      description: >-
        This method deletes a meMp1Subscription. This method is typically used
        in "Unsubscribing from service availability event notifications"
        procedure.
181
      operationId: ApplicationsSubscription_DELETE
182
      tags:
183
        - appSubscriptions
184
185
186
      responses:
        '204':
          description: No Content
187
        '403':
188
          $ref: '#/components/responses/Error.403'
189
        '404':
190
          $ref: '#/components/responses/Error.404'
191
  '/applications/{appInstanceId}/traffic_rules':
192
    parameters:
193
      - $ref: '#/components/parameters/Path.AppInstanceId'
194
    get:
195
196
197
      description: >-
        This method retrieves information about all the traffic rules associated
        with a mobile edge application instance.
198
      operationId: ApplicationsTrafficRules_GET
199
      tags:
200
        - appTrafficRules
201
202
      responses:
        '200':
203
          $ref: '#/components/responses/ApplicationsTrafficRules.200'
204
        '400':
205
          $ref: '#/components/responses/Error.400'
206
        '403':
207
          $ref: '#/components/responses/Error.403'
208
        '404':
209
          $ref: '#/components/responses/Error.404'
210
  '/applications/{appInstanceId}/traffic_rules/{trafficRuleId}':
211
    parameters:
212
213
      - $ref: '#/components/parameters/Path.AppInstanceId'
      - $ref: '#/components/parameters/Path.TrafficRuleId'
214
    get:
215
216
217
      description: >-
        This method retrieves information about all the traffic rules associated
        with a mobile edge application instance.
218
      operationId: ApplicationsTrafficRule_GET
219
      tags:
220
        - appTrafficRules
221
222
      responses:
        '200':
223
          $ref: '#/components/responses/ApplicationsTrafficRule.200'
224
        '400':
225
          $ref: '#/components/responses/Error.400'
226
        '403':
227
          $ref: '#/components/responses/Error.403'
228
        '404':
229
          $ref: '#/components/responses/Error.404'
230
    put:
231
232
233
      description: >-
        This method retrieves information about all the traffic rules associated
        with a mobile edge application instance.
234
      operationId: ApplicationsTrafficRule_PUT
235
      tags:
236
        - appTrafficRules
237
238
      responses:
        '200':
239
          $ref: '#/components/responses/ApplicationsTrafficRule.200'
240
        '400':
241
          $ref: '#/components/responses/Error.400'
242
        '403':
243
          $ref: '#/components/responses/Error.403'
244
        '404':
245
          $ref: '#/components/responses/Error.404'
246
        '412':
247
248
249
          $ref: '#/components/responses/Error.412'
      requestBody:
        $ref: '#/components/requestBodies/ApplicationsTrafficRule'
Walter Featherstone's avatar
Walter Featherstone committed
250
251
252
  '/applications/{appInstanceId}/services':
    parameters:
      - $ref: '#/components/parameters/Path.AppInstanceId'
253
    get:
254
255
256
      description: >-
        This method retrieves information about a list of meService resources.
        This method is typically used in "service availability query" procedure
Walter Featherstone's avatar
Walter Featherstone committed
257
      operationId: AppServices_GET
258
      tags:
259
        - appServices
260
      parameters:
261
262
263
        - $ref: '#/components/parameters/Query.Ser_instance_id'
        - $ref: '#/components/parameters/Query.Ser_name'
        - $ref: '#/components/parameters/Query.Ser_category_id'
Walter Featherstone's avatar
Walter Featherstone committed
264
265
266
        - $ref: '#/components/parameters/Query.Consumed_local_only'
        - $ref: '#/components/parameters/Query.Is_local'
        - $ref: '#/components/parameters/Query.LocalityTypes' 
267
268
      responses:
        '200':
269
          $ref: '#/components/responses/Services.200'
270
        '400':
271
          $ref: '#/components/responses/Error.400'
272
        '403':
273
          $ref: '#/components/responses/Error.403'
274
        '404':
275
          $ref: '#/components/responses/Error.404'
276
    post:
277
278
279
280
      description: >-
        This method is used to create a meService resource. This method is
        typically used in "service availability update and new service
        registration" procedure
Walter Featherstone's avatar
Walter Featherstone committed
281
      operationId: AppServices_POST
282
      tags:
283
        - appServices
284
285
      responses:
        '201':
286
          $ref: '#/components/responses/Services.201'
287
        '400':
288
          $ref: '#/components/responses/Error.400'
289
        '403':
290
          $ref: '#/components/responses/Error.403'
291
        '404':
292
293
          $ref: '#/components/responses/Error.404'
      requestBody:
294
        $ref: '#/components/requestBodies/Services.Post'
Walter Featherstone's avatar
Walter Featherstone committed
295
  '/applications/{appInstanceId}/services/{serviceId}':
296
    parameters:
Walter Featherstone's avatar
Walter Featherstone committed
297
      - $ref: '#/components/parameters/Path.AppInstanceId'
298
      - $ref: '#/components/parameters/Path.ServiceId'
299
    get:
300
301
302
      description: >-
        This method retrieves information about a meService resource. This
        method is typically used in "service availability query" procedure
Walter Featherstone's avatar
Walter Featherstone committed
303
      operationId: AppServicesServiceId_GET
304
      tags:
305
        - appServices
306
307
      responses:
        '200':
308
          $ref: '#/components/responses/ServicesServiceId.200'
309
        '400':
310
          $ref: '#/components/responses/Error.400'
311
        '403':
312
          $ref: '#/components/responses/Error.403'
313
        '404':
314
          $ref: '#/components/responses/Error.404'
315
316
    put:
      description: This method updates the information about a meService resource
Walter Featherstone's avatar
Walter Featherstone committed
317
      operationId: AppServicesServiceId_PUT
318
      tags:
319
        - appServices
320
321
      responses:
        '200':
322
          $ref: '#/components/responses/ServicesServiceId.200'
323
        '400':
324
          $ref: '#/components/responses/Error.400'
325
        '403':
326
          $ref: '#/components/responses/Error.403'
327
        '404':
328
          $ref: '#/components/responses/Error.404'
329
        '412':
330
331
332
          $ref: '#/components/responses/Error.412'
      requestBody:
        $ref: '#/components/requestBodies/ServicesServiceId'
Walter Featherstone's avatar
Walter Featherstone committed
333
334
335
336
337
338
  '/services':
    get:
      description: >-
        This method retrieves information about a list of meService resources.
        This method is typically used in "service availability query" procedure
      operationId: Services_GET
339
340
      tags:
        - services
Walter Featherstone's avatar
Walter Featherstone committed
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
      parameters:
        - $ref: '#/components/parameters/Query.Ser_instance_id'
        - $ref: '#/components/parameters/Query.Ser_name'
        - $ref: '#/components/parameters/Query.Ser_category_id'
        - $ref: '#/components/parameters/Query.Consumed_local_only'
        - $ref: '#/components/parameters/Query.Is_local'
        - $ref: '#/components/parameters/Query.LocalityTypes' 
      responses:
        '200':
          $ref: '#/components/responses/Services.200'
        '400':
          $ref: '#/components/responses/Error.400'
        '403':
          $ref: '#/components/responses/Error.403'
        '404':
          $ref: '#/components/responses/Error.404'
  '/services/{serviceId}':
    parameters:
      - $ref: '#/components/parameters/Path.ServiceId'
    get:
      description: >-
        This method retrieves information about a meService resource. This
        method is typically used in "service availability query" procedure
      operationId: ServicesServiceId_GET
365
366
      tags:
        - services
Walter Featherstone's avatar
Walter Featherstone committed
367
368
369
370
371
372
373
374
375
      responses:
        '200':
          $ref: '#/components/responses/ServicesServiceId.200'
        '400':
          $ref: '#/components/responses/Error.400'
        '403':
          $ref: '#/components/responses/Error.403'
        '404':
          $ref: '#/components/responses/Error.404'
376
  '/timing/current_time':
377
    get:
378
379
380
      description: >-
        This method retrieves the information of the platform's current time
        which corresponds to the get platform time procedure
381
      operationId: TimingCurrentTime_GET
382
383
      tags:
        - timing
384
385
      responses:
        '200':
386
          $ref: '#/components/responses/TimingCurrentTime.200'
387
        '400':
388
          $ref: '#/components/responses/Error.400'
389
        '403':
390
          $ref: '#/components/responses/Error.403'
391
        '404':
392
          $ref: '#/components/responses/Error.404'
393
  '/timing/timing_caps':
394
    get:
395
396
397
      description: >-
        This method retrieves the information of the platform's timing
        capabilities which corresponds to the timing capabilities query
398
      operationId: TimingCaps_GET
399
400
      tags:
        - timing
401
402
      responses:
        '200':
403
          $ref: '#/components/responses/TimingCaps.200'
404
        '400':
405
          $ref: '#/components/responses/Error.400'
406
        '403':
407
          $ref: '#/components/responses/Error.403'
408
        '404':
409
          $ref: '#/components/responses/Error.404'
410
  '/transports':
411
    get:
412
413
414
415
416
      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
417
      operationId: Transports_GET
418
419
      tags:
        - transports
420
421
      responses:
        '200':
422
          $ref: '#/components/responses/Transports.200'
423
        '400':
424
          $ref: '#/components/responses/Error.400'
425
        '403':
426
          $ref: '#/components/responses/Error.403'
427
        '404':
428
429
430
431
432
          $ref: '#/components/responses/Error.404'
components:
  schemas:
    Empty:
      description: Empty schema
433
434
435
436
437
438
439
440
441
442
443
    AppTerminationNotification.Links:
      description: >-
        List of hyperlinks related to the resource.
      type: object
      required:
        - subscription
      properties:
        subscription:
          $ref: '#/components/schemas/LinkType'
        confirmTermination:
          $ref: '#/components/schemas/LinkType.ConfirmTermination'
444
445
446
447
    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
      format: uint32
      example: 10
    AppTerminationNotification.NotificationType:
      description: Shall be set to AppTerminationNotification.
      type: string
454
      example: 'AppTerminationNotification'
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
    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:
471
          $ref: '#/components/schemas/AppTerminationNotification.Links'
472
473
474
    AppTerminationNotificationSubscription.AppInstanceId:
      description: It is used as the filtering criterion for the subscribed events.
      type: string
475
      example: 'ID1'
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
    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
510
      example: 'AppTerminationNotificationSubscription'
511
512
513
    CategoryRef.Href:
      description: Reference of the catalogue
      type: string
514
      example: 'catItem1'
515
516
517
    CategoryRef.Id:
      description: Unique identifier of the category
      type: string
518
      example: 'id12345'
519
    CategoryRef.Name:
520
      description: Name of the category, example values include RNI, Location & Bandwidth Management
521
      type: string
522
      example: 'RNI'
523
524
525
    CategoryRef.Version:
      description: Category version
      type: string
526
      example: 'version1'
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
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
    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
577
          example: 'TRACEABLE'
578
579
580
581
582
583
584
    DestinationInterface.InterfaceType:
      description: Type of the interface
      type: string
      enum:
        - TUNNEL
        - MAC
        - IP
585
      example: 'TUNNEL'
586
587
588
    DestinationInterface.IpAddress:
      description: IP address of the remote destination
      type: string
589
      example: '192.0.2.0'
590
591
592
    DestinationInterface.MacAddress:
      description: Source address identifies the MAC address of the interface
      type: string
593
      example: '02-00-00-00-00-00'
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
    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
613
      example: 'www.example.com'
614
615
616
    DnsRule.Id:
      description: Identifies the DNS Rule
      type: string
617
      example: 'dnsRule1'
618
619
620
    DnsRule.IpAddress:
      description: IP address associated with the FQDN resolved by the DNS rule
      type: string
621
      example: '192.0.2.0'
622
623
624
625
626
627
    DnsRule.IpAddressType:
      description: IP address type
      type: string
      enum:
        - IP_V6
        - IP_V4
628
      example: 'IP_V6'
629
630
631
632
633
634
    DnsRule.State:
      description: DNS rule state
      type: string
      enum:
        - ACTIVE
        - INACTIVE
635
      example: 'ACTIVE'
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
    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
666
      example: '192.0.2.0'
667
    EndPointInfo.Address_Port:
668
669
670
      description: Port portion of the address
      type: integer
      format: uint32
671
      example: 8080
672
673
674
    EndPointInfo.Address:
      description: A IP address and port pair
      type: object
675
676
677
      required:
        - host
        - port
678
679
680
681
      properties:
        host:
          $ref: '#/components/schemas/EndPointInfo.Address.Host'
        port:
682
          $ref: '#/components/schemas/EndPointInfo.Address_Port'
683
684
685
686
    EndPointInfo.Addresses:
      description: >-
        Entry point information of the service as one or more pairs of IP
        address and port
687
688
689
690
691
692
693
694
695
      type: object
      required:
        - addresses
      properties:
        addresses:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/EndPointInfo.Address'
696
697
698
699
700
    EndPointInfo.Alternative:
      description: >-
        Entry point information of the service in a format defined by an
        implementation, or in an external specification.
      type: object
701
702
703
704
705
      required:
        - alternative
      properties: 
        alternative:
          type: object
706
707
708
709
    EndPointInfo.Uri:
      description: Entry point information of the service
      type: string
      format: uri
710
      example: '/meMp1/service/EntryPoint'
711
712
713
714
    EndPointInfo.Uris:
      description: >-
        Entry point information of the service as string, formatted according to
        URI syntax
715
716
717
718
719
720
721
722
723
      type: object
      required:
        - uris
      properties:
        uris:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/EndPointInfo.Uri'
724
725
726
727
728
729
    LinkType:
      description: This type represents a type of link and may be referenced from data structures
      type: object
      properties:
        href: 
          $ref: '#/components/schemas/Href'
730
731
732
733
734
735
736
737
    LinkType.ConfirmTermination:
      description: >-
        Link to the task resource where to confirm termination in case the 
        application is ready to be terminated before expiry of the timeout.
      type: object
      properties:
        href: 
          $ref: '#/components/schemas/Href'
738
739
740
741
    Href:
      description: URI referring to a resource
      type: string
      format: uri
742
      example: '/meMp1/example'
743
744
745
746
747
748
749
750
    Mp1SubscriptionLinkList.Links:
      description: Self-referring URI.
      type: object
      required:
        - self
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
751
752
        subscriptions:
          description: The MEC application instance's subscriptions
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
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
          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
825
      example: 'OAUTH2_CLIENT_CREDENTIALS'
826
827
828
829
    SecurityInfo.OAuth2Info.TokenEndpoint:
      description: The token endpoint
      type: string
      format: uri
830
      example: '/meMp1/security/TokenEndPoint'
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
    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
890
      example: 'SerAvailabilityNotificationSubscription'
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
    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
916
      example: 'JSON'
Walter Featherstone's avatar
Walter Featherstone committed
917
918
919
920
921
922
923
924
925
926
927
    LocalityTypes:
      description: The scope of locality as expressed by "consumedLocalOnly" and "isLocal". If absent, defaults to MEC_HOST
      type: string
      enum:
        - MEC_SYSTEM
        - MEC_HOST
        - NFVI_POP
        - ZONE
        - ZONE_GROUP
        - NFVI_NODE
      example: 'MEC_SYSTEM'
928
929
930
931
932
933
    ServiceInfo.SerInstanceId:
      description: >-
        Identifier of the service instance assigned by the MEPM / mobile edge
        platform.
      type: string
      readOnly: true
934
      example: 'ServiceInstance123'
935
936
937
938
939
    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
940
      example: 'ExampleService'
941
942
943
944
945
946
    ServiceInfo.State:
      description: Contains the state
      type: string
      enum:
        - ACTIVE
        - INACTIVE
947
      example: 'ACTIVE'
948
949
950
951
952
953
954
955
    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
956
      writeOnly: true
957
      example: 'Rest1'
958
959
960
    ServiceInfo.Version:
      description: Service version
      type: string
961
      example: 'ServiceVersion1'
Walter Featherstone's avatar
Walter Featherstone committed
962
963
964
965
966
967
968
969
970
971
972
973
974
    ServiceInfo.ConsumedLocalOnly:
      description: >-
        Indicate whether the service can only be consumed by the MEC applications
        located in the same locality (as defined by scopeOfLocality) as this 
        service instance.
      type: boolean
      example: false
    ServiceInfo.IsLocal:
      description: >-
        Indicate whether the service is located in the same locality (as defined
        by scopeOfLocality) as the consuming MEC application.
      type: boolean
      example: true
975
    ServiceInfo.Post:
976
977
978
979
980
981
982
      description: This type represents the general information of a mobile edge service.
      type: object
      required:
        - serName
        - version
        - state
        - serializer
983
984
985
      oneOf:
        - required: [transportId]
        - required: [transportInfo]
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
      properties:
        serInstanceId:
          $ref: '#/components/schemas/ServiceInfo.SerInstanceId'
        serName:
          $ref: '#/components/schemas/ServiceInfo.SerName'
        serCategory:
          $ref: '#/components/schemas/CategoryRef'
        version:
          $ref: '#/components/schemas/ServiceInfo.Version'
        state:
          $ref: '#/components/schemas/ServiceInfo.State'
        transportId:
          $ref: '#/components/schemas/ServiceInfo.TransportId'
        transportInfo:
          $ref: '#/components/schemas/TransportInfo'
        serializer:
          $ref: '#/components/schemas/SerializerTypes'
Walter Featherstone's avatar
Walter Featherstone committed
1003
1004
1005
1006
        scopeOfLocality:
          $ref: '#/components/schemas/LocalityTypes'
        consumedLocalOnly:
          $ref: '#/components/schemas/ServiceInfo.ConsumedLocalOnly'
1007
1008
        isLocal:
          $ref: '#/components/schemas/ServiceInfo.IsLocal'
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
    ServiceInfo:
      description: This type represents the general information of a mobile edge service.
      type: object
      required:
        - serName
        - version
        - state
        - transportInfo
        - serializer
      properties:
        serInstanceId:
          $ref: '#/components/schemas/ServiceInfo.SerInstanceId'
        serName:
          $ref: '#/components/schemas/ServiceInfo.SerName'
        serCategory:
          $ref: '#/components/schemas/CategoryRef'
        version:
          $ref: '#/components/schemas/ServiceInfo.Version'
        state:
          $ref: '#/components/schemas/ServiceInfo.State'
        transportInfo:
          $ref: '#/components/schemas/TransportInfo'
        serializer:
          $ref: '#/components/schemas/SerializerTypes'
1033
1034
1035
1036
        scopeOfLocality:
          $ref: '#/components/schemas/LocalityTypes'
        consumedLocalOnly:
          $ref: '#/components/schemas/ServiceInfo.ConsumedLocalOnly'
Walter Featherstone's avatar
Walter Featherstone committed
1037
1038
        isLocal: 
          $ref: '#/components/schemas/ServiceInfo.IsLocal'
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
    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
1059
      example: 'NONE'
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
    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
1087
      example: '192.0.2.0'
1088
1089
1090
1091
1092
1093
    TimingCaps.NtpServers.NtpServerAddrType:
      description: Address type of NTP server
      type: string
      enum:
        - IP_ADDRESS
        - DNS_NAME
1094
      example: 'IP_ADDRESS'
1095
    TimingCaps.NtpServers_PtpMasterIpAddress:
1096
1097
      description: PTP Master IP Address
      type: string
1098
      example: '192.0.2.0'
1099
    TimingCaps.NtpServers_PtpMasterLocalPriority:
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
      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'
1130
    TimingCaps_PtpMasters:
1131
1132
1133
1134
1135
1136
1137
1138
      description: NTP server detail.
      type: object
      required:
        - ptpMasterIpAddress
        - ptpMasterLocalPriority
        - delayReqMaxRate
      properties:
        ptpMasterIpAddress: