Newer
Older
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
Walter Featherstone
committed
},
"AppTerminationNotification": {
"{$request.body#/callbackUri}": {
"post": {
"description": "Represents the information that the MEP notifies the subscribed application instance about the corresponding application instance termination/stop'",
"operationId": "AppTerminationNotification_POST",
"tags": [
"callbacks"
],
"requestBody": {
"$ref": "#/components/requestBodies/AppTerminationNotification"
},
"responses": {
"200": {
"description": "Expected responses from callback consumer, if it accepts the callback"
}
}
}
}
"/applications/{appInstanceId}/subscriptions/{subscriptionId}": {
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
"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",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "subscriptionId",
"in": "path",
"description": "Represents a subscription to the notifications from the MEC platform.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"description": "Upon success, a response body containing the requested subscription is returned.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppTerminationNotificationSubscription"
}
}
}
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
"description": "This method deletes a mecAppSuptApiSubscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
"operationId": "ApplicationsSubscription_DELETE",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "subscriptionId",
"in": "path",
"description": "Represents a subscription to the notifications from the MEC platform.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
],
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
}
},
"deprecated": false
},
"parameters": []
"/applications/{appInstanceId}/confirm_termination": {
"post": {
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
"description": "This method is used to confirm the application level termination of an application instance.",
"operationId": "ApplicationsConfirmTermination_POST",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppTerminationConfirmation"
}
}
},
"required": false
},
"description": "No Content",
"headers": {},
"content": {}
"description": "Unauthorized. It is used when the client did not submit the appropriate credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"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.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Too Many Requests. It is used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
Walter Featherstone
committed
},
"deprecated": false
},
"parameters": []
"/applications/{appInstanceId}/confirm_ready": {
"post": {
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
"description": "This method may be used by the MEC application instance to notify the MEC platform that it is up and running. ",
"operationId": "ApplicationsConfirmReady_POST",
"parameters": [
{
"name": "appInstanceId",
"in": "path",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppReadyConfirmation"
}
}
},
"required": false
},
"description": "No Content",
"headers": {},
"content": {}
"description": "Unauthorized. It is used when the client did not submit the appropriate credentials.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"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.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Too Many Requests. It is used when a rate limiter has triggered.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"deprecated": false
},
"parameters": []
},
"/timing/timing_caps": {
"get": {
"description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query",
"operationId": "TimingCaps_GET",
"parameters": [],
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimingCaps"
}
}
}
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
},
"deprecated": false
},
"parameters": []
"description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure",
"operationId": "TimingCurrentTime_GET",
"parameters": [],
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrentTime"
}
}
}
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"type": "object",
"description": "Empty schema",
"contentMediaType": "text/plain"
}
}
}
},
"deprecated": false
},
"parameters": []
Walter Featherstone
committed
"components": {
"schemas": {
"const": "READY",
"type": "string",
"description": "Indication about the MEC application instance.",
"examples": [
"READY"
]
},
"description": "This type represents the information that the MEC application instance indicates to the MEC platform that it is up and running."
"properties": {
"operationAction": {
"$ref": "#/components/schemas/OperationActionType"
}
},
"description": "This type represents the information that the MEC application instance provides to the MEC platform when informing it that the application has completed its application level related terminate/stop actions, e.g. retention of application state in the case of stop."
"title": "AppTerminationNotification.Links",
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
},
"confirmTermination": {
"$ref": "#/components/schemas/LinkType.ConfirmTermination"
}
},
"description": "Object containing hyperlinks related to the resource."
Walter Featherstone
committed
},
"AppTerminationNotification": {
Walter Featherstone
committed
"required": [
"notificationType",
Walter Featherstone
committed
"maxGracefulTimeout",
"_links"
],
Walter Featherstone
committed
"properties": {
"notificationType": {
"type": "string",
"description": "Shall be set to AppTerminationNotification.",
"examples": [
"AppTerminationNotification"
]
Walter Featherstone
committed
},
"operationAction": {
"$ref": "#/components/schemas/OperationActionType"
},
Walter Featherstone
committed
"maxGracefulTimeout": {
"type": "integer",
"description": "Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.",
"contentEncoding": "int32",
"examples": [
10
]
Walter Featherstone
committed
},
"_links": {
"$ref": "#/components/schemas/AppTerminationNotification.Links"
Walter Featherstone
committed
}
},
"description": "This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop."
Walter Featherstone
committed
},
"AppTerminationNotificationSubscription": {
"title": "AppTerminationNotificationSubscription",
Walter Featherstone
committed
"required": [
"subscriptionType",
"callbackReference",
"_links",
"appInstanceId"
],
Walter Featherstone
committed
"properties": {
"subscriptionType": {
"type": "string",
"description": "Shall be set to AppTerminationNotificationSubscription.",
"examples": [
"AppTerminationNotificationSubscription"
]
Walter Featherstone
committed
},
"callbackReference": {
"type": "string",
"description": "URI selected by the MEC application instance to receive notifications on the subscribed MEC application instance management information. This shall be included in both the request and the response."
Walter Featherstone
committed
},
"_links": {
"$ref": "#/components/schemas/Self"
},
"appInstanceId": {
"type": "string",
"description": "It is used as the filtering criterion for the subscribed events.",
"examples": [
"ID1"
]
Walter Featherstone
committed
}
},
"description": "This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop."
Walter Featherstone
committed
},
"CurrentTime": {
Walter Featherstone
committed
"required": [
"seconds",
Walter Featherstone
committed
"timeSourceStatus"
],
Walter Featherstone
committed
"properties": {
"seconds": {
"type": "integer",
"description": "The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
"contentEncoding": "int32",
"examples": [
1577836800
]
Walter Featherstone
committed
},
"nanoSeconds": {
"type": "integer",
"description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
"contentEncoding": "int32",
"examples": [
0
]
Walter Featherstone
committed
},
"timeSourceStatus": {
"$ref": "#/components/schemas/TimeSourceStatus"
Walter Featherstone
committed
}
},
"description": "This type represents the information provided by the MEC platform in response to the Get Platform Time Request message."
Walter Featherstone
committed
},
"DestinationInterface.InterfaceType": {
"title": "DestinationInterface.InterfaceType",
Walter Featherstone
committed
"enum": [
"TUNNEL",
"MAC",
"IP"
],
"type": "string",
"description": "Type of the interface",
"examples": [
"TUNNEL"
]
Walter Featherstone
committed
},
"DestinationInterface": {
Walter Featherstone
committed
"required": [
"interfaceType"
],
Walter Featherstone
committed
"properties": {
"interfaceType": {
"$ref": "#/components/schemas/DestinationInterface.InterfaceType"
},
"tunnelInfo": {
"$ref": "#/components/schemas/TunnelInfo"
},
"srcMacAddress": {
"type": "string",
"description": "Source address identifies the MAC address of the interface",
"examples": [
"02-00-00-00-00-00"
]
Walter Featherstone
committed
},
"dstMacAddress": {
"type": "string",
"description": "Source address identifies the MAC address of the interface",
"examples": [
"02-00-00-00-00-00"
]
Walter Featherstone
committed
},
"dstIpAddress": {
"type": "string",
"description": "IP address of the remote destination",
"examples": [
"192.0.2.0"
]
Walter Featherstone
committed
}
},
"description": "This type represents the destination interface. If the action is FORWARD_DECAPSULATED, FORWARD_ENCAPSULATED or PASSTHROUGH one value shall be provided. If the action is DUPLICATE_DECAPSULATED or DUPLICATE_ENCAPSULATED, two values shall be provided. If the action is DROP, no value shall be provided."
Walter Featherstone
committed
},
"DnsRule.IpAddressType": {
Walter Featherstone
committed
"enum": [
"IP_V6",
"IP_V4"
],
"type": "string",
"description": "IP address type",
"examples": [
"IP_V6"
]
Walter Featherstone
committed
},
"DnsRule.State": {
Walter Featherstone
committed
"enum": [
"ACTIVE",
"INACTIVE"
],
"type": "string",
"description": "DNS rule state. This attribute may be updated using HTTP PUT method",
"examples": [
"ACTIVE"
]
Walter Featherstone
committed
},
"DnsRule": {
Walter Featherstone
committed
"required": [
"dnsRuleId",
"domainName",
"ipAddressType",
"ipAddress",
"state"
],
Walter Featherstone
committed
"properties": {
"dnsRuleId": {
"type": "string",
"description": "Identifies the DNS Rule",
"examples": [
"dnsRule1"
]
Walter Featherstone
committed
},
"domainName": {
"type": "string",
"description": "FQDN resolved by the DNS rule",
"examples": [
"www.example.com"
]
Walter Featherstone
committed
},
"ipAddressType": {
"$ref": "#/components/schemas/DnsRule.IpAddressType"
},
"ipAddress": {
"type": "string",
"description": "IP address associated with the FQDN resolved by the DNS rule",
"examples": [
"192.0.2.0"
]
Walter Featherstone
committed
},
"ttl": {
"type": "integer",
"description": "Time to live value",
"contentEncoding": "int32"
Walter Featherstone
committed
},
"state": {
"$ref": "#/components/schemas/DnsRule.State"
}
},
"description": "This type represents the general information of a DNS rule."
Walter Featherstone
committed
},
"type": "object",
"properties": {
"type": "string",
"description": "URI referring to a resource",
"examples": [
"/mecAppSuptApi/example"
]
},
"description": "This type represents a type of link and may be referenced from data structures"
Walter Featherstone
committed
},
Walter Featherstone
committed
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "URI referring to a resource",
"examples": [
"/mecAppSuptApi/example"
]
Walter Featherstone
committed
}
},
"description": "Link to the task resource where to confirm termination in case the application is ready to be terminated before expiry of the timeout."
Walter Featherstone
committed
},
"title": "MecAppSuptApiSubscriptionLinkList.Links",
Walter Featherstone
committed
"required": [
"self"
],
Walter Featherstone
committed
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
Walter Featherstone
committed
"type": "array",
"items": {
"$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList.Subscription"
},
"description": "The MEC application instance's subscriptions"
Walter Featherstone
committed
}
},
"description": "Self-referring URI."
Walter Featherstone
committed
},
"MecAppSuptApiSubscriptionLinkList.Subscription": {
"title": "MecAppSuptApiSubscriptionLinkList.Subscription",
Walter Featherstone
committed
"required": [
"href",
"rel"
],
Walter Featherstone
committed
"properties": {
"href": {
"type": "string",
"description": "URI referring to a resource",
"examples": [
"/mecAppSuptApi/example"
]
Walter Featherstone
committed
},
"rel": {
"type": "string",
"description": "The values shall be set to AppTerminationNotificationSubscription."
Walter Featherstone
committed
}
},
"description": "A link to a subscription."
Walter Featherstone
committed
},
"title": "MecAppSuptApiSubscriptionLinkList",
Walter Featherstone
committed
"required": [
"_links"
],
Walter Featherstone
committed
"properties": {
"_links": {
"$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList.Links"
Walter Featherstone
committed
}
},
"description": "This type represents a list of links related to currently existing subscriptions for a MEC application instance. This information is returned when sending a request to receive current subscriptions."
Walter Featherstone
committed
},
"enum": [
"STOPPING",
"TERMINATING"
],
"type": "string",
"description": "Operation that is being performed on the MEC application instance.",
"examples": [
"TERMINATING"
]
Walter Featherstone
committed
"ProblemDetails": {
Walter Featherstone
committed
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
Walter Featherstone
committed
},
"title": {
"type": "string",
"description": "A short, human-readable summary of the problem type"
Walter Featherstone
committed
},
"status": {
"type": "integer",
"description": "The HTTP status code for this occurrence of the problem",
"contentEncoding": "int32"
Walter Featherstone
committed
},
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem"
Walter Featherstone
committed
},
"instance": {
"type": "string",
"description": "A URI reference that identifies the specific occurrence of the problem"
Walter Featherstone
committed
}
}
},
Walter Featherstone
committed
"required": [
Walter Featherstone
committed
],
Walter Featherstone
committed
"properties": {