Newer
Older
Represents a subscription to the notifications from the MEC
Walter Featherstone
committed
platform.
in: path
required: true
schema:
Walter Featherstone
committed
Path.TrafficRuleId:
name: trafficRuleId
description: Represents a traffic rule.
in: path
required: true
schema:
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
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/MecAppSuptApiSubscriptionLinkList'
Walter Featherstone
committed
links:
getIndividualmecAppSuptApiSubscriptionLinkList:
$ref: '#/components/links/GetIndividualmecAppSuptApiSubscriptionLinkList'
delIndividualmecAppSuptApiSubscriptionLinkList:
$ref: '#/components/links/DelIndividualmecAppSuptApiSubscriptionLinkList'
Walter Featherstone
committed
ApplicationsSubscriptions.201:
description: >-
Entity body in the request contains a subscription to the
MEC service availability notifications that is to be created.
Walter Featherstone
committed
headers:
location:
description: The resource URI of the created resource
schema:
type: string
format: uri
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationNotificationSubscription'
Walter Featherstone
committed
links:
getIndividualmecAppSuptApiSubscription:
$ref: '#/components/links/GetIndividualmecAppSuptApiSubscription'
delIndividualmecAppSuptApiSubscription:
$ref: '#/components/links/DelIndividualmecAppSuptApiSubscription'
Walter Featherstone
committed
ApplicationsSubscription.200:
description: >-
Upon success, a response body containing the requested subscription
is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationNotificationSubscription'
Walter Featherstone
committed
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
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'
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'
Walter Featherstone
committed
description: >-
Bad Request.
It is used to indicate that incorrect parameters were passed to the request.
Walter Featherstone
committed
content:
Walter Featherstone
committed
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
$ref: '#/components/schemas/Empty'
Error.401:
description: >-
Unauthorized.
It is used when the client did not submit the appropriate credentials.
Walter Featherstone
committed
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.
The operation is not allowed given the current status of the resource.
Walter Featherstone
committed
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
Error.404:
description: >-
Not Found.
It is used when a client provided a URI that cannot be mapped
to a valid resource URI.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
$ref: '#/components/schemas/Empty'
Error.409:
description: >-
Conflict.
The operation cannot be executed currently, due to a conflict with
the state of the resource. Typically, this is because the application
instance resource is in NOT_INSTANTIATED state.
Walter Featherstone
committed
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.
It is used when a condition has failed during conditional requests,
e.g. when using ETags to avoid write conflicts.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
$ref: '#/components/schemas/Empty'
Error.429:
description: >-
Too Many Requests.
It is used when a rate limiter has triggered.
Walter Featherstone
committed
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
Walter Featherstone
committed
text/plain:
Walter Featherstone
committed
schema:
$ref: '#/components/schemas/Empty'
requestBodies:
ApplicationsConfirmReady:
content:
application/json:
schema:
$ref: '#/components/schemas/AppReadyConfirmation'
ApplicationsConfirmTermination:
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationConfirmation'
Walter Featherstone
committed
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:
$ref: '#/components/schemas/AppTerminationNotificationSubscription'
Walter Featherstone
committed
description: >-
Entity body in the request contains a subscription to the MEC
Walter Featherstone
committed
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
AppTerminationNotification:
content:
application/json:
schema:
$ref: '#/components/schemas/AppTerminationNotification'
Walter Featherstone
committed
callbacks:
AppTerminationNotification:
'{$request.body#/callbackReference}':
Walter Featherstone
committed
post:
description: >-
Represents the information that the MEP notifies the
subscribed application instance about the corresponding
application instance termination/stop
operationId: AppTerminationNotification_POST
tags:
Walter Featherstone
committed
requestBody:
$ref: '#/components/requestBodies/AppTerminationNotification'
responses:
'200':
description: Expected responses from callback consumer, if it accepts the callback
links:
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'
operationId: ApplicationsSubscription_GET
description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}`
Walter Featherstone
committed
parameters:
description: regex = \/mec_app_support\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
Walter Featherstone
committed
subscriptionId: 'TBC'
operationId: ApplicationsSubscription_DELETE
description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}`
Walter Featherstone
committed
parameters:
description: regex = \/mec_app_support\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
Walter Featherstone
committed
subscriptionId: 'TBC'
GetIndividualmecAppSuptApiSubscriptionLinkList:
operationId: ApplicationsSubscription_GET
description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}`
Walter Featherstone
committed
parameters:
description: regex = \/mec_app_support\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
Walter Featherstone
committed
subscriptionId: 'TBC'
DelIndividualmecAppSuptApiSubscriptionLinkList:
operationId: ApplicationsSubscription_DELETE
description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}`
Walter Featherstone
committed
parameters:
description: regex = \/mec_app_support\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute
Walter Featherstone
committed
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'
- dnsRuleId: 'DnsRule2'
domainName: 'www.example.com'
ipAddressType: 'IP_V4'
ipAddress: '146.241.7.4'
ttl: 300
state: 'INACTIVE'
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'