Newer
Older
Walter Featherstone
committed
},
"Error.412": {
"description": "Precondition Failed",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
Walter Featherstone
committed
"text/plain": {
Walter Featherstone
committed
"schema": {
"$ref": "#/components/schemas/Empty"
}
Walter Featherstone
committed
}
}
},
"requestBodies": {
"ApplicationsDnsRule": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DnsRule"
}
Walter Featherstone
committed
"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"
}
]
}
Walter Featherstone
committed
"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"
}
Walter Featherstone
committed
"description": "One or more updated attributes that are allowed to be changed",
"required": true
},
"Services": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceInfo"
}
Walter Featherstone
committed
"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"
}
Walter Featherstone
committed
"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"
}
}
Walter Featherstone
committed
"required": true
},
"ServiceAvailabilityNotification": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceAvailabilityNotification"
}
}
Walter Featherstone
committed
"required": true
Walter Featherstone
committed
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
"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"
}
}
}
Walter Featherstone
committed
"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"
Walter Featherstone
committed
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
"examples": {
"DnsRule": {
"value": {
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3",
"ttl": 300,
"state": "ACTIVE"
}
},
"DnsRules": {
"value": [
{
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3",
"ttl": 300,
"state": "ACTIVE"
}
]
},
"ServiceInfo": {
"value": {
"serInstanceId": "ServiceInstance123",
"serName": "ExampleService",
"serCategory": {
"href": "catItem1",
"id": "id12345",
"name": "RNI",
"version": "version1"
},
"version": "ServiceVersion1",
"state": "ACTIVE",
"transportId": "Rest1",
"transportInfo": {
"id": "TransId12345",
"name": "REST",
"description": "REST API",
Walter Featherstone
committed
"type": "REST_HTTP",
Walter Featherstone
committed
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
"protocol": "HTTP",
"version": "2.0",
"endpoint": {
"uris": [
"/meMp1/service/EntryPoint"
]
},
"security": {
"oAuth2Info": {
"grantTypes": "OAUTH2_CLIENT_CREDENTIALS",
"tokenEndpoint": "/meMp1/security/TokenEndPoint"
}
}
},
"serializer": "JSON"
}
},
"ServiceInfoList": {
"value": [
{
"serInstanceId": "ServiceInstance123",
"serName": "ExampleService",
"serCategory": {
"href": "catItem1",
"id": "id12345",
"name": "RNI",
"version": "version1"
},
"version": "ServiceVersion1",
"state": "ACTIVE",
"transportId": "Rest1",
"transportInfo": {
"id": "TransId12345",
"name": "REST",
"description": "REST API",
Walter Featherstone
committed
"type": "REST_HTTP",
Walter Featherstone
committed
"protocol": "HTTP",
"version": "2.0",
"endpoint": {
"addresses": [
{
"host": "192.0.2.0",
Walter Featherstone
committed
"port": 8080
Walter Featherstone
committed
}
]
},
"security": {
"oAuth2Info": {
"grantTypes": "OAUTH2_CLIENT_CREDENTIALS",
"tokenEndpoint": "/meMp1/security/TokenEndPoint"
}
}
},
"serializer": "JSON"
}
]
},
"TrafficRule": {
"value": {
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
Walter Featherstone
committed
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
],
"dstAddress": [
"192.127.4.100/32"
],
"dstPort": [
"80"
]
}
],
Walter Featherstone
committed
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
},
"state": "ACTIVE"
Walter Featherstone
committed
},
"TrafficRules": {
"value": [
{
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
Walter Featherstone
committed
"trafficFilter": [
{
"srcAddress": [
"192.168.2.0/24",
"192.168.3.0/24"
],
"dstAddress": [
"192.127.4.100/32"
],
"dstPort": [
"80"
]
}
],
Walter Featherstone
committed
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
},
"state": "ACTIVE"
}
]