Newer
Older
Walter Featherstone
committed
openapi: 3.0.0
servers:
Walter Featherstone
committed
- url: 'http://127.0.0.1:8081/mp1/v1/'
- url: 'https://127.0.0.1:8081/mp1/v1/'
description: The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI
license:
name: ETSI Forge copyright notice
url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
externalDocs:
description: 'ETSI GS MEC011 Application Enablement API, V2.0.5'
Walter Featherstone
committed
url: >-
https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv205.zip
paths:
'/applications/{appInstanceId}/dns_rules':
parameters:
Walter Featherstone
committed
- $ref: '#/components/parameters/Path.AppInstanceId'
Walter Featherstone
committed
description: >-
This method retrieves information about all the DNS rules associated
with a mobile edge application instance.
operationId: ApplicationsDnsRules_GET
Walter Featherstone
committed
$ref: '#/components/responses/ApplicationsDnsRules.200'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
'/applications/{appInstanceId}/dns_rules/{dnsRuleId}':
parameters:
Walter Featherstone
committed
- $ref: '#/components/parameters/Path.AppInstanceId'
- $ref: '#/components/parameters/Path.DnsRuleId'
Walter Featherstone
committed
description: >-
This method retrieves information about a DNS rule associated with a
mobile edge application instance.
operationId: ApplicationsDnsRule_GET
Walter Featherstone
committed
$ref: '#/components/responses/ApplicationsDnsRule.200'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
put:
description: 'This method activates, de-activates or updates a traffic rule.'
operationId: ApplicationsDnsRule_PUT
Walter Featherstone
committed
$ref: '#/components/responses/ApplicationsDnsRule.200'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
Walter Featherstone
committed
$ref: '#/components/responses/Error.412'
requestBody:
$ref: '#/components/requestBodies/ApplicationsDnsRule'
'/applications/{appInstanceId}/subscriptions':
parameters:
Walter Featherstone
committed
- $ref: '#/components/parameters/Path.AppInstanceId'
Walter Featherstone
committed
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.
operationId: ApplicationsSubscriptions_GET
Walter Featherstone
committed
$ref: '#/components/responses/ApplicationsSubscriptions.200'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
Walter Featherstone
committed
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.
operationId: ApplicationsSubscriptions_POST
Walter Featherstone
committed
$ref: '#/components/responses/ApplicationsSubscriptions.201'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
requestBody:
$ref: '#/components/requestBodies/ApplicationsSubscriptions'
callbacks:
appTerminationNotification:
$ref: '#/components/callbacks/AppTerminationNotification'
serviceAvailabilityNotification:
$ref: '#/components/callbacks/ServiceAvailabilityNotification'
'/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}':
parameters:
Walter Featherstone
committed
- $ref: '#/components/parameters/Path.AppInstanceId'
- $ref: '#/components/parameters/Path.SubscriptionType'
- $ref: '#/components/parameters/Path.SubscriptionId'
Walter Featherstone
committed
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.
operationId: ApplicationsSubscription_GET
Walter Featherstone
committed
$ref: '#/components/responses/ApplicationsSubscription.200'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
Walter Featherstone
committed
description: >-
This method deletes a meMp1Subscription. This method is typically used
in "Unsubscribing from service availability event notifications"
procedure.
operationId: ApplicationsSubscription_DELETE
responses:
'204':
description: No Content
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
'/applications/{appInstanceId}/traffic_rules':
parameters:
Walter Featherstone
committed
- $ref: '#/components/parameters/Path.AppInstanceId'
Walter Featherstone
committed
description: >-
This method retrieves information about all the traffic rules associated
with a mobile edge application instance.
operationId: ApplicationsTrafficRules_GET
Walter Featherstone
committed
$ref: '#/components/responses/ApplicationsTrafficRules.200'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
'/applications/{appInstanceId}/traffic_rules/{trafficRuleId}':
parameters:
Walter Featherstone
committed
- $ref: '#/components/parameters/Path.AppInstanceId'
- $ref: '#/components/parameters/Path.TrafficRuleId'
Walter Featherstone
committed
description: >-
This method retrieves information about all the traffic rules associated
with a mobile edge application instance.
operationId: ApplicationsTrafficRule_GET
Walter Featherstone
committed
$ref: '#/components/responses/ApplicationsTrafficRule.200'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
Walter Featherstone
committed
description: >-
This method retrieves information about all the traffic rules associated
with a mobile edge application instance.
operationId: ApplicationsTrafficRule_PUT
Walter Featherstone
committed
$ref: '#/components/responses/ApplicationsTrafficRule.200'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
Walter Featherstone
committed
$ref: '#/components/responses/Error.412'
requestBody:
$ref: '#/components/requestBodies/ApplicationsTrafficRule'
'/applications/{appInstanceId}/services':
parameters:
- $ref: '#/components/parameters/Path.AppInstanceId'
Walter Featherstone
committed
description: >-
This method retrieves information about a list of meService resources.
This method is typically used in "service availability query" procedure
Walter Featherstone
committed
- $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'
Walter Featherstone
committed
$ref: '#/components/responses/Services.200'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
Walter Featherstone
committed
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
committed
$ref: '#/components/responses/Services.201'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
requestBody:
$ref: '#/components/requestBodies/Services'
'/applications/{appInstanceId}/services/{serviceId}':
parameters:
- $ref: '#/components/parameters/Path.AppInstanceId'
Walter Featherstone
committed
- $ref: '#/components/parameters/Path.ServiceId'
Walter Featherstone
committed
description: >-
This method retrieves information about a meService resource. This
method is typically used in "service availability query" procedure
Walter Featherstone
committed
$ref: '#/components/responses/ServicesServiceId.200'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
put:
description: This method updates the information about a meService resource
Walter Featherstone
committed
$ref: '#/components/responses/ServicesServiceId.200'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
Walter Featherstone
committed
$ref: '#/components/responses/Error.412'
requestBody:
$ref: '#/components/requestBodies/ServicesServiceId'
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
'/services':
get:
description: >-
This method retrieves information about a list of meService resources.
This method is typically used in "service availability query" procedure
operationId: Services_GET
parameters:
- $ref: '#/components/parameters/Query.Ser_instance_id'
- $ref: '#/components/parameters/Query.Ser_name'
- $ref: '#/components/parameters/Query.Ser_category_id'
- $ref: '#/components/parameters/Query.Consumed_local_only'
- $ref: '#/components/parameters/Query.Is_local'
- $ref: '#/components/parameters/Query.LocalityTypes'
responses:
'200':
$ref: '#/components/responses/Services.200'
'400':
$ref: '#/components/responses/Error.400'
'403':
$ref: '#/components/responses/Error.403'
'404':
$ref: '#/components/responses/Error.404'
'/services/{serviceId}':
parameters:
- $ref: '#/components/parameters/Path.ServiceId'
get:
description: >-
This method retrieves information about a meService resource. This
method is typically used in "service availability query" procedure
operationId: ServicesServiceId_GET
responses:
'200':
$ref: '#/components/responses/ServicesServiceId.200'
'400':
$ref: '#/components/responses/Error.400'
'403':
$ref: '#/components/responses/Error.403'
'404':
$ref: '#/components/responses/Error.404'
Walter Featherstone
committed
'/timing/current_time':
Walter Featherstone
committed
description: >-
This method retrieves the information of the platform's current time
which corresponds to the get platform time procedure
operationId: TimingCurrentTime_GET
Walter Featherstone
committed
$ref: '#/components/responses/TimingCurrentTime.200'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
Walter Featherstone
committed
'/timing/timing_caps':
Walter Featherstone
committed
description: >-
This method retrieves the information of the platform's timing
capabilities which corresponds to the timing capabilities query
operationId: TimingCaps_GET
Walter Featherstone
committed
$ref: '#/components/responses/TimingCaps.200'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$ref: '#/components/responses/Error.404'
Walter Featherstone
committed
'/transports':
Walter Featherstone
committed
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
operationId: Transports_GET
Walter Featherstone
committed
$ref: '#/components/responses/Transports.200'
Walter Featherstone
committed
$ref: '#/components/responses/Error.400'
Walter Featherstone
committed
$ref: '#/components/responses/Error.403'
Walter Featherstone
committed
$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.
Walter Featherstone
committed
type: integer
Walter Featherstone
committed
format: uint32
example: 10
AppTerminationNotification.NotificationType:
description: Shall be set to AppTerminationNotification.
type: string
Walter Featherstone
committed
example: 'AppTerminationNotification'
Walter Featherstone
committed
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
Walter Featherstone
committed
example: 'ID1'
Walter Featherstone
committed
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
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
Walter Featherstone
committed
example: 'AppTerminationNotificationSubscription'
Walter Featherstone
committed
CategoryRef.Href:
description: Reference of the catalogue
type: string
Walter Featherstone
committed
example: 'catItem1'
Walter Featherstone
committed
CategoryRef.Id:
description: Unique identifier of the category
type: string
Walter Featherstone
committed
example: 'id12345'
Walter Featherstone
committed
CategoryRef.Name:
description: Name of the category
type: string
Walter Featherstone
committed
example: 'RNI'
Walter Featherstone
committed
CategoryRef.Version:
description: Category version
type: string
Walter Featherstone
committed
example: 'version1'
Walter Featherstone
committed
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
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
Walter Featherstone
committed
example: 'TRACEABLE'
Walter Featherstone
committed
DestinationInterface.InterfaceType:
description: Type of the interface
type: string
enum:
- TUNNEL
- MAC
- IP
Walter Featherstone
committed
example: 'TUNNEL'
Walter Featherstone
committed
DestinationInterface.IpAddress:
description: IP address of the remote destination
type: string
Walter Featherstone
committed
example: '192.0.2.0'
Walter Featherstone
committed
DestinationInterface.MacAddress:
description: Source address identifies the MAC address of the interface
type: string
Walter Featherstone
committed
example: '02-00-00-00-00-00'
Walter Featherstone
committed
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
Walter Featherstone
committed
example: 'www.example.com'
Walter Featherstone
committed
DnsRule.Id:
description: Identifies the DNS Rule
type: string
Walter Featherstone
committed
example: 'dnsRule1'
Walter Featherstone
committed
DnsRule.IpAddress:
description: IP address associated with the FQDN resolved by the DNS rule
type: string
Walter Featherstone
committed
example: '192.0.2.0'
Walter Featherstone
committed
DnsRule.IpAddressType:
description: IP address type
type: string
enum:
- IP_V6
- IP_V4
Walter Featherstone
committed
example: 'IP_V6'
Walter Featherstone
committed
DnsRule.State:
description: DNS rule state
type: string
enum:
- ACTIVE
- INACTIVE
Walter Featherstone
committed
example: 'ACTIVE'
Walter Featherstone
committed
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
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
Walter Featherstone
committed
example: '192.0.2.0'
EndPointInfo.Address_Port:
Walter Featherstone
committed
description: Port portion of the address
type: integer
format: uint32
Walter Featherstone
committed
example: 8080
Walter Featherstone
committed
EndPointInfo.Address:
description: A IP address and port pair
type: object
properties:
host:
$ref: '#/components/schemas/EndPointInfo.Address.Host'
port:
$ref: '#/components/schemas/EndPointInfo.Address_Port'
Walter Featherstone
committed
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
Walter Featherstone
committed
example: '/meMp1/service/EntryPoint'
Walter Featherstone
committed
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
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
Walter Featherstone
committed
example: '/meMp1/example'
Walter Featherstone
committed
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
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
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
Walter Featherstone
committed
example: 'OAUTH2_CLIENT_CREDENTIALS'
Walter Featherstone
committed
SecurityInfo.OAuth2Info.TokenEndpoint:
description: The token endpoint
type: string
format: uri
Walter Featherstone
committed
example: '/meMp1/security/TokenEndPoint'
Walter Featherstone
committed
735
736
737
738
739
740
741
742
743
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
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
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
required:
- oAuth2Info
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
Walter Featherstone
committed
example: 'SerAvailabilityNotificationSubscription'
Walter Featherstone
committed
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'
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'
Walter Featherstone
committed
ServiceInfo.SerInstanceId:
description: >-
Identifier of the service instance assigned by the MEPM / mobile edge
platform.
type: string
readOnly: true
Walter Featherstone
committed
example: 'ServiceInstance123'
Walter Featherstone
committed
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
Walter Featherstone
committed
example: 'ExampleService'
Walter Featherstone
committed
ServiceInfo.State:
description: Contains the state
type: string
enum:
- ACTIVE
- INACTIVE
Walter Featherstone
committed
example: 'ACTIVE'
Walter Featherstone
committed
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
Walter Featherstone
committed
example: 'Rest1'
Walter Featherstone
committed
ServiceInfo.Version:
description: Service version
type: string
Walter Featherstone
committed
example: 'ServiceVersion1'
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
Walter Featherstone
committed
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'
scopeOfLocality:
$ref: '#/components/schemas/LocalityTypes'
consumedLocalOnly:
$ref: '#/components/schemas/ServiceInfo.ConsumedLocalOnly'
isLocal:
$ref: '#/components/schemas/ServiceInfo.IsLocal'
Walter Featherstone
committed
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
Walter Featherstone
committed
example: 'NONE'
Walter Featherstone
committed
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
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
Walter Featherstone
committed
example: '192.0.2.0'
Walter Featherstone
committed
TimingCaps.NtpServers.NtpServerAddrType:
description: Address type of NTP server
type: string
enum:
- IP_ADDRESS
- DNS_NAME
Walter Featherstone
committed
example: 'IP_ADDRESS'
TimingCaps.NtpServers_PtpMasterIpAddress:
Walter Featherstone
committed
description: PTP Master IP Address
type: string
Walter Featherstone
committed
example: '192.0.2.0'
TimingCaps.NtpServers_PtpMasterLocalPriority:
Walter Featherstone
committed
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
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'
TimingCaps_PtpMasters:
Walter Featherstone
committed
description: NTP server detail.
type: object
required:
- ptpMasterIpAddress
- ptpMasterLocalPriority
- delayReqMaxRate
properties:
ptpMasterIpAddress:
$ref: '#/components/schemas/TimingCaps.NtpServers_PtpMasterIpAddress'
Walter Featherstone
committed
ptpMasterLocalPriority:
$ref: '#/components/schemas/TimingCaps.NtpServers_PtpMasterLocalPriority'
Walter Featherstone
committed
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
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:
$ref: '#/components/schemas/TimingCaps_PtpMasters'
Walter Featherstone
committed
TrafficFilter.Address:
description: Identify the traffic ip address.
type: string
Walter Featherstone
committed
example: '192.168.1.1'
Walter Featherstone
committed
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
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
Walter Featherstone
committed
example: 'DROP'
Walter Featherstone
committed
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
Walter Featherstone
committed
example: 'TrafficRule1'
TrafficRule_Priority:
Walter Featherstone
committed
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
Walter Featherstone
committed
example: 'ACTIVE'
Walter Featherstone
committed
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:
$ref: '#/components/schemas/TrafficRule_Priority'
Walter Featherstone
committed
trafficFilter:
Walter Featherstone
committed
type: array
items:
$ref: '#/components/schemas/TrafficFilter'
Walter Featherstone
committed
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
Walter Featherstone
committed
example: 'REST API'
Walter Featherstone
committed
TransportInfo.Id:
description: The identifier of this transport
type: string
Walter Featherstone
committed
example: 'TransId12345'
Walter Featherstone
committed
TransportInfo.ImplSpecificInfo:
description: Additional implementation specific details of the transport
type: object
TransportInfo.Name:
description: The name of this transport
type: string
Walter Featherstone
committed
example: 'REST'
Walter Featherstone
committed
TransportInfo.Protocol:
description: The name of the protocol used. Shall be set to HTTP for a REST API.
type: string
Walter Featherstone
committed
example: 'HTTP'
Walter Featherstone
committed
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
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
Walter Featherstone
committed
example: 'REST_HTTP'
Walter Featherstone
committed
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
Walter Featherstone
committed
example: 'GTP_U'
Walter Featherstone
committed
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
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:
Walter Featherstone
committed
Path.DnsRuleId:
name: dnsRuleId
description: Represents a DNS rule.
in: path
required: true
schema:
Walter Featherstone
committed
Path.SubscriptionId:
name: subscriptionId
description: >-
Represents a subscription to the notifications from the mobile edge
platform.
in: path
required: true
schema:
Walter Featherstone
committed
Path.SubscriptionType:
name: subscriptionType
description: >-
Represents a subscription type to the notifications from the mobile edge
platform.
in: path
required: true
schema:
type: string
enum:
- AppTerminationNotificationSubscription
- SerAvailabilityNotificationSubscription
Walter Featherstone
committed
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
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:
Walter Featherstone
committed
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:
Walter Featherstone
committed
type: string
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
Query.LocalityTypes:
name: scope_of_locality
description: >-
A MEC application instance may use scope_of_locality as an input
parameter to query the availability of a list of MEC service instances
with a certain scope of locality.
in: query
required: false
schema:
type: string
Query.Is_local:
name: is_local
description: >-
Indicate whether the service is located in the same locality (as
defined by scopeOfLocality) as the consuming MEC application.
in: query
required: false
schema:
type: boolean
Query.Consumed_local_only:
name: consumed_local_only
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.
in: query
required: false
schema:
type: boolean
Walter Featherstone
committed
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
responses:
ApplicationsDnsRules.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
type: array
minItems: 0
items:
$ref: '#/components/schemas/DnsRule'
examples:
DnsRules:
$ref: '#/components/examples/DnsRules'
links:
getIndividualMeDNSRule:
$ref: '#/components/links/GetIndividualMeDNSRule'
putIndividualMeDNSRule:
$ref: '#/components/links/PutIndividualMeDNSRule'
ApplicationsDnsRule.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
$ref: '#/components/schemas/DnsRule'
examples:
DnsRule:
$ref: '#/components/examples/DnsRule'
ApplicationsSubscriptions.200:
description: >-
Upon success, a response body containing the list of links to the
requested subscriptions is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/Mp1SubscriptionLinkList'
links:
getIndividualMeMp1SubscriptionLinkList:
$ref: '#/components/links/GetIndividualMeMp1SubscriptionLinkList'
delIndividualMeMp1SubscriptionLinkList:
$ref: '#/components/links/DelIndividualMeMp1SubscriptionLinkList'
ApplicationsSubscriptions.201:
description: >-
Entity body in the request contains a subscription to the mobile
edge service availability notifications that is to be created.
headers:
location:
description: The resource URI of the created resource
schema:
type: string
format: uri
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AppTerminationNotificationSubscription'
- $ref: '#/components/schemas/SerAvailabilityNotificationSubscription'
links:
getIndividualMeMp1Subscription:
$ref: '#/components/links/GetIndividualMeMp1Subscription'
delIndividualMeMp1Subscription:
$ref: '#/components/links/DelIndividualMeMp1Subscription'
ApplicationsSubscription.200:
description: >-
Upon success, a response body containing the requested subscription
is returned.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AppTerminationNotificationSubscription'
- $ref: '#/components/schemas/SerAvailabilityNotificationSubscription'
ApplicationsTrafficRules.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
type: array
minItems: 0
items:
$ref: '#/components/schemas/TrafficRule'
examples:
TrafficRules:
$ref: '#/components/examples/TrafficRules'
links:
getIndividualMeTrafficRule:
$ref: '#/components/links/GetIndividualMeTrafficRule'
putIndividualMeTrafficRule:
$ref: '#/components/links/PutIndividualMeTrafficRule'
ApplicationsTrafficRule.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficRule'
examples:
TrafficRule:
$ref: '#/components/examples/TrafficRule'
Services.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
type: array
minItems: 0
items:
$ref: '#/components/schemas/ServiceInfo'
examples:
ServiceInfoList:
$ref: '#/components/examples/ServiceInfoList'
links:
getIndividualMeService:
$ref: '#/components/links/GetIndividualMeService'
putIndividualMeService:
$ref: '#/components/links/PutIndividualMeService'
Services.201:
description: >-
Upon success, the HTTP response shall include a Location HTTP header
that contains the resource URI of the created resource.
headers:
location:
description: The resource URI of the created resource
schema:
type: string
format: uri
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceInfo'
examples:
ServiceInfo:
$ref: '#/components/examples/ServiceInfo'
links:
getIndividualMeService:
$ref: '#/components/links/GetIndividualMeService'
putIndividualMeService:
$ref: '#/components/links/PutIndividualMeService'
ServicesServiceId.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceInfo'
examples:
ServiceInfo:
$ref: '#/components/examples/ServiceInfo'
TimingCurrentTime.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
$ref: '#/components/schemas/CurrentTime'
TimingCaps.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
$ref: '#/components/schemas/TimingCaps'
Transports.200:
description: >-
It is used to indicate nonspecific success. The response body
contains a representation of the resource.
content:
application/json:
schema:
type: array
minItems: 0
items:
$ref: '#/components/schemas/TransportInfo'
Error.400:
description: Bad Request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
Walter Featherstone
committed
text/plain:
Walter Featherstone
committed
schema:
$ref: '#/components/schemas/Empty'
Error.403:
description: Forbidden
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
Error.404:
description: Not Found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
Walter Featherstone
committed
text/plain:
Walter Featherstone
committed
schema:
$ref: '#/components/schemas/Empty'
Error.412:
description: Precondition Failed
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
Walter Featherstone
committed
text/plain:
Walter Featherstone
committed
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
schema:
$ref: '#/components/schemas/Empty'
requestBodies:
ApplicationsDnsRule:
content:
application/json:
schema:
$ref: '#/components/schemas/DnsRule'
description: The updated state is included in the entity body of the request.
required: true
ApplicationsSubscriptions:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AppTerminationNotificationSubscription'
- $ref: '#/components/schemas/SerAvailabilityNotificationSubscription'
description: >-
Entity body in the request contains a subscription to the mobile edge
application termination notifications that is to be created.
required: true
ApplicationsTrafficRule:
content:
application/json:
schema:
$ref: '#/components/schemas/TrafficRule'
description: One or more updated attributes that are allowed to be changed
required: true
Services:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceInfo'
description: >-
New ServiceInfo with updated "state" is included as entity body of the
request
required: true
ServicesServiceId:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceInfo'
description: >-
New ServiceInfo with updated "state" is included as entity body of the
request
required: true
AppTerminationNotification:
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationNotification'
required: true
ServiceAvailabilityNotification:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceAvailabilityNotification'
required: true
callbacks:
AppTerminationNotification:
'$request.body#/callbackReference':
post:
requestBody:
$ref: '#/components/requestBodies/AppTerminationNotification'
responses:
'200':
description: Expected responses from callback consumer, if it accepts the callback
ServiceAvailabilityNotification:
'$request.body#/callbackReference':
post:
requestBody:
$ref: '#/components/requestBodies/ServiceAvailabilityNotification'
responses:
'200':
description: Expected responses from callback consumer, if it accepts the callback
links:
GetIndividualMeService:
operationId: ServicesServiceId_GET
Walter Featherstone
committed
description: The `serviceId` value returned in the response can be used as the `serviceId` parameter in `GET /services/{serviceId}`
parameters:
serviceId: '$response.body#/serviceId'
PutIndividualMeService:
operationId: ServicesServiceId_PUT
Walter Featherstone
committed
description: The `serviceId` value returned in the response can be used as the `serviceId` parameter in `PUT /services/{serviceId}`
parameters:
serviceId: '$response.body#/serviceId'
GetIndividualMeDNSRule:
operationId: ApplicationsDnsRule_GET
Walter Featherstone
committed
description: The `dnsRuleId` value returned in the response can be used as the `dnsRuleId` parameter in `GET /applications/{appInstanceId}/dns_rules/{dnsRuleId}`
parameters:
dnsRuleId: '$response.body#/dnsRuleId'
PutIndividualMeDNSRule:
operationId: ApplicationsDnsRule_PUT
Walter Featherstone
committed
description: The `dnsRuleId` value returned in the response can be used as the `dnsRuleId` parameter in `PUT /applications/{appInstanceId}/dns_rules/{dnsRuleId}`
parameters:
dnsRuleId: '$response.body#/dnsRuleId'
GetIndividualMeTrafficRule:
operationId: ApplicationsTrafficRule_GET
Walter Featherstone
committed
description: The `trafficRuleId` value returned in the response can be used as the `trafficRuleId` parameter in `GET /applications/{appInstanceId}/traffic_rules/{trafficRuleId}`
parameters:
trafficRuleId: '$response.body#/trafficRuleId'
PutIndividualMeTrafficRule:
operationId: ApplicationsTrafficRule_PUT
Walter Featherstone
committed
description: The `trafficRuleId` value returned in the response can be used as the `trafficRuleId` parameter in `PUT /applications/{appInstanceId}/traffic_rules/{trafficRuleId}`
parameters:
trafficRuleId: '$response.body#/trafficRuleId'
GetIndividualMeMp1Subscription:
operationId: ApplicationsSubscription_GET
Walter Featherstone
committed
description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}`
parameters:
description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
subscriptionId: 'TBC'
DelIndividualMeMp1Subscription:
operationId: ApplicationsSubscription_DELETE
Walter Featherstone
committed
description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}`
parameters:
description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
subscriptionId: 'TBC'
GetIndividualMeMp1SubscriptionLinkList:
operationId: ApplicationsSubscription_GET
Walter Featherstone
committed
description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}`
parameters:
description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
subscriptionId: 'TBC'
DelIndividualMeMp1SubscriptionLinkList:
operationId: ApplicationsSubscription_DELETE
Walter Featherstone
committed
description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}`
parameters:
description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
subscriptionId: 'TBC'
examples:
DnsRule:
value:
Walter Featherstone
committed
dnsRuleId: 'DnsRule1'
domainName: 'www.example.com'
ipAddressType: 'IP_V4'
ipAddress: '146.241.7.3'
Walter Featherstone
committed
ttl: 300
Walter Featherstone
committed
state: 'ACTIVE'
Walter Featherstone
committed
DnsRules:
value:
Walter Featherstone
committed
- dnsRuleId: 'DnsRule1'
domainName: 'www.example.com'
ipAddressType: 'IP_V4'
ipAddress: '146.241.7.3'
Walter Featherstone
committed
ttl: 300
Walter Featherstone
committed
state: 'ACTIVE'
Walter Featherstone
committed
ServiceInfo:
value:
Walter Featherstone
committed
serInstanceId: 'ServiceInstance123'
serName: 'ExampleService'
Walter Featherstone
committed
serCategory:
Walter Featherstone
committed
href: 'catItem1'
id: 'id12345'
name: 'RNI'
version: 'version1'
version: 'ServiceVersion1'
state: 'ACTIVE'
transportId: 'Rest1'
Walter Featherstone
committed
transportInfo:
Walter Featherstone
committed
id: 'TransId12345'
name: 'REST'
description: 'REST API'
type: 'REST_HTTP'
protocol: 'HTTP'
Walter Featherstone
committed
version: '2.0'
endpoint:
uris:
Walter Featherstone
committed
- '/meMp1/service/EntryPoint'
Walter Featherstone
committed
addresses:
Walter Featherstone
committed
- host: '192.0.2.0'
port: 8080
Walter Featherstone
committed
security:
oAuth2Info:
Walter Featherstone
committed
grantTypes: 'OAUTH2_CLIENT_CREDENTIALS'
tokenEndpoint: '/meMp1/security/TokenEndPoint'
serializer: 'JSON'
Walter Featherstone
committed
ServiceInfoList:
value:
Walter Featherstone
committed
- serInstanceId: 'ServiceInstance123'
serName: 'ExampleService'
Walter Featherstone
committed
serCategory:
Walter Featherstone
committed
href: 'catItem1'
id: 'id12345'
name: 'RNI'
version: 'version1'
version: 'ServiceVersion1'
state: 'ACTIVE'
transportId: 'Rest1'
Walter Featherstone
committed
transportInfo:
Walter Featherstone
committed
id: 'TransId12345'
name: 'REST'
description: 'REST API'
type: 'REST_HTTP'
protocol: 'HTTP'
Walter Featherstone
committed
version: '2.0'
endpoint:
uris:
Walter Featherstone
committed
- '/meMp1/service/EntryPoint'
Walter Featherstone
committed
addresses:
Walter Featherstone
committed
- host: '192.0.2.0'
port: 8080
Walter Featherstone
committed
security:
oAuth2Info:
Walter Featherstone
committed
grantTypes: 'OAUTH2_CLIENT_CREDENTIALS'
tokenEndpoint: '/meMp1/security/TokenEndPoint'
serializer: 'JSON'
Walter Featherstone
committed
TrafficRule:
value:
Walter Featherstone
committed
trafficRuleId: 'TrafficRule123'
serName: 'ExampleService'
filterType: 'FLOW'
Walter Featherstone
committed
priority: 1
trafficFilter:
Walter Featherstone
committed
- srcAddress:
- '192.168.2.0/24'
- '192.168.3.0/24'
dstAddress:
- '192.127.4.100/32'
dstPort:
- '80'
action: 'FORWARD_DECAPSULATED'
Walter Featherstone
committed
dstInterface:
Walter Featherstone
committed
interfaceType: 'IP'
dstIpAddress: '20.1.1.1'
state: 'ACTIVE'
Walter Featherstone
committed
TrafficRules:
value:
Walter Featherstone
committed
- trafficRuleId: 'TrafficRule123'
serName: 'ExampleService'
filterType: 'FLOW'
Walter Featherstone
committed
priority: 1
trafficFilter:
Walter Featherstone
committed
- srcAddress:
- '192.168.2.0/24'
- '192.168.3.0/24'
dstAddress:
- '192.127.4.100/32'
dstPort:
- '80'
action: 'FORWARD_DECAPSULATED'
Walter Featherstone
committed
dstInterface:
Walter Featherstone
committed
interfaceType: 'IP'
dstIpAddress: '20.1.1.1'
state: 'ACTIVE'