Newer
Older
Walter Featherstone
committed
servers:
- 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'
contact:
email: cti_support@etsi.org
description: 'ETSI GS MEC011 Application Enablement API, V2.0.8'
Walter Featherstone
committed
url: >-
https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv208.zip
- name: appTrafficRules
- name: appDnsRules
- name: appSubscriptions
- name: appConfirmTermination
- name: appServices
- name: services
- name: timing
- name: transports
- name: callbacks
'/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'
'/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.Post'
'/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'
'/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.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'
Walter Featherstone
committed
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/AppTerminationNotification.Links'
Walter Featherstone
committed
AppTerminationNotificationSubscription.AppInstanceId:
description: It is used as the filtering criterion for the subscribed events.
type: string
Walter Featherstone
committed
example: 'ID1'
Walter Featherstone
committed
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
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, example values include RNI, Location & Bandwidth Management
Walter Featherstone
committed
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
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
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
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
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
Walter Featherstone
committed
required:
- host
- port
Walter Featherstone
committed
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: object
required:
- addresses
properties:
addresses:
type: array
minItems: 0
items:
$ref: '#/components/schemas/EndPointInfo.Address'
Walter Featherstone
committed
EndPointInfo.Alternative:
description: >-
Entry point information of the service in a format defined by an
implementation, or in an external specification.
type: object
required:
- alternative
properties:
alternative:
type: object
Walter Featherstone
committed
EndPointInfo.Uri:
description: Entry point information of the service
type: string
format: uri
Walter Featherstone
committed
example: '/meMp1/service/EntryPoint'
Walter Featherstone
committed
EndPointInfo.Uris:
description: >-
Entry point information of the service as string, formatted according to
URI syntax
type: object
required:
- uris
properties:
uris:
type: array
minItems: 0
items:
$ref: '#/components/schemas/EndPointInfo.Uri'
Walter Featherstone
committed
LinkType:
description: This type represents a type of link and may be referenced from data structures
type: object
properties:
href:
$ref: '#/components/schemas/Href'
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'
Walter Featherstone
committed
Href:
description: URI referring to a resource
type: string
format: uri
Walter Featherstone
committed
example: '/meMp1/example'
Walter Featherstone
committed
Mp1SubscriptionLinkList.Links:
description: Self-referring URI.
type: object
required:
- self
properties:
self:
$ref: '#/components/schemas/LinkType'
subscriptions:
description: The MEC application instance's subscriptions
Walter Featherstone
committed
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
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
SecurityInfo.OAuth2Info:
description: Parameters related to use of OAuth 2.0
required:
- grantTypes
- tokenEndpoint
properties:
grantTypes:
Walter Featherstone
committed
description: >-
List of supported OAuth 2.0 grant types.
type: array
minItems: 1
maxItems: 4
items:
$ref: '#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes'
Walter Featherstone
committed
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
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
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
description: This type represents the general information of a mobile edge service.
type: object
required:
- serName
- version
- state
- serializer
oneOf:
- required: [transportId]
- required: [transportInfo]
Walter Featherstone
committed
properties:
serInstanceId:
$ref: '#/components/schemas/ServiceInfo.SerInstanceId'
serName:
$ref: '#/components/schemas/ServiceInfo.SerName'
serCategory:
$ref: '#/components/schemas/CategoryRef'
version:
$ref: '#/components/schemas/ServiceInfo.Version'