Newer
Older
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"servers": [
{
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
{
"url": "https://127.0.0.1:8081/mec_app_support/v1"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
],
"title": "MEC Application Support API",
"version": "2.1.1",
"description": "The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI",
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
},
"contact": {
"email": "cti_support@etsi.org"
"description": "ETSI GS MEC011 Application Enablement API, V2.1.1",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/parameters/Path.AppInstanceId"
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRules_GET",
"$ref": "#/components/responses/ApplicationsTrafficRules.200"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.400"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.403"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.404"
"/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/parameters/Path.AppInstanceId"
"$ref": "#/components/parameters/Path.TrafficRuleId"
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRule_GET",
"$ref": "#/components/responses/ApplicationsTrafficRule.200"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.400"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.403"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.404"
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRule_PUT",
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsTrafficRule.200"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.400"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.403"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.404"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.412"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsTrafficRule"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/parameters/Path.AppInstanceId"
"description": "This method retrieves information about all the DNS rules associated with a MEC application instance.",
"operationId": "ApplicationsDnsRules_GET",
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsDnsRules.200"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.400"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.403"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.404"
"/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/parameters/Path.AppInstanceId"
"$ref": "#/components/parameters/Path.DnsRuleId"
"description": "This method retrieves information about a DNS rule associated with a MEC application instance.",
"operationId": "ApplicationsDnsRule_GET",
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsDnsRule.200"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.400"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.403"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.404"
"put": {
"description": "This method activates, de-activates or updates a traffic rule.",
"operationId": "ApplicationsDnsRule_PUT",
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsDnsRule.200"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.400"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.403"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.404"
},
"412": {
"$ref": "#/components/responses/Error.412"
},
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsDnsRule"
"/applications/{appInstanceId}/subscriptions": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/parameters/Path.AppInstanceId"
"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",
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsSubscriptions.200"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.400"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.403"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.404"
"post": {
"description": "The POST method may be used to create a new subscription. One example use case is to create a new subscription to the MEC service availability notifications. Upon success, the response contains entity body describing the created subscription.",
"operationId": "ApplicationsSubscriptions_POST",
"201": {
"$ref": "#/components/responses/ApplicationsSubscriptions.201"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.400"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.403"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.404"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsSubscriptions"
},
"callbacks": {
"appTerminationNotification": {
"$ref": "#/components/callbacks/AppTerminationNotification"
}
"/applications/{appInstanceId}/subscriptions/{subscriptionId}": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
},
{
"$ref": "#/components/parameters/Path.SubscriptionId"
}
],
"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",
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsSubscription.200"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.400"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.403"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.404"
"delete": {
"description": "This method deletes a mecAppSuptApiSubscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
"operationId": "ApplicationsSubscription_DELETE",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.403"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.404"
"/applications/{appInstanceId}/confirm_termination": {
"$ref": "#/components/parameters/Path.AppInstanceId"
"post": {
"description": "This method is used to confirm the application level termination of an application instance.",
"operationId": "ApplicationsConfirmTermination_POST",
"401": {
"$ref": "#/components/responses/Error.401"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.403"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.404"
"409": {
"$ref": "#/components/responses/Error.409"
"429": {
"$ref": "#/components/responses/Error.429"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsConfirmTermination"
"/applications/{appInstanceId}/confirm_ready": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
}
],
"post": {
"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",
"401": {
"$ref": "#/components/responses/Error.401"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.403"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.404"
},
"409": {
"$ref": "#/components/responses/Error.409"
},
"429": {
"$ref": "#/components/responses/Error.429"
},
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsConfirmReady"
}
}
},
"/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",
],
"responses": {
"200": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/TimingCaps.200"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.400"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.403"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.404"
"description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure",
"operationId": "TimingCurrentTime_GET",
],
"responses": {
"200": {
"$ref": "#/components/responses/TimingCurrentTime.200"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.400"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.403"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/responses/Error.404"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"components": {
"schemas": {
"Empty": {
"description": "Empty schema"
},
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
"AppReadyConfirmation": {
"description": "This type represents the information that the MEC application instance indicates to the MEC platform that it is up and running.",
"type": "object",
"required": [
"indication"
],
"properties": {
"indication": {
"$ref": "#/components/schemas/ReadyIndicationType"
}
}
},
"AppTerminationConfirmation": {
"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.",
"type": "object",
"required": [
"operationAction"
],
"properties": {
"operationAction": {
"$ref": "#/components/schemas/OperationActionType"
}
}
},
"AppTerminationNotification.Links": {
"description": "Object containing hyperlinks related to the resource.",
"type": "object",
"required": [
"subscription"
],
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
},
"confirmTermination": {
"$ref": "#/components/schemas/LinkType.ConfirmTermination"
}
}
},
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"AppTerminationNotification.MaxGracefulTimeout": {
"description": "Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"type": "integer",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"format": "uint32",
"example": 10
},
"AppTerminationNotification.NotificationType": {
"description": "Shall be set to AppTerminationNotification.",
"type": "string",
"example": "AppTerminationNotification"
},
"AppTerminationNotification": {
"description": "This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"type": "object",
"required": [
"notificationType",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"maxGracefulTimeout",
"_links"
],
"properties": {
"notificationType": {
"$ref": "#/components/schemas/AppTerminationNotification.NotificationType"
},
"operationAction": {
"$ref": "#/components/schemas/OperationActionType"
},
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"maxGracefulTimeout": {
"$ref": "#/components/schemas/AppTerminationNotification.MaxGracefulTimeout"
},
"_links": {
"$ref": "#/components/schemas/AppTerminationNotification.Links"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"AppTerminationNotificationSubscription.AppInstanceId": {
"description": "It is used as the filtering criterion for the subscribed events.",
"type": "string",
"example": "ID1"
},
"AppTerminationNotificationSubscription.CallbackReference": {
"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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"type": "string",
"format": "uri"
},
"AppTerminationNotificationSubscription": {
"description": "This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"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"
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"AppTerminationNotificationSubscription.SubscriptionType": {
"description": "Shall be set to AppTerminationNotificationSubscription.",
"type": "string",
"example": "AppTerminationNotificationSubscription"
},
"CurrentTime": {
"description": "This type represents the information provided by the MEC platform in response to the Get Platform Time Request message.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
"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",
"example": "TRACEABLE"
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"DestinationInterface.InterfaceType": {
"description": "Type of the interface",
"type": "string",
"enum": [
"TUNNEL",
"MAC",
"IP"
],
"example": "TUNNEL"
},
"DestinationInterface.IpAddress": {
"description": "IP address of the remote destination",
"type": "string",
"example": "192.0.2.0"
},
"DestinationInterface.MacAddress": {
"description": "Source address identifies the MAC address of the interface",
"type": "string",
"example": "02-00-00-00-00-00"
},
"DestinationInterface": {
"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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"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"
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
},
"DnsRule.DomainName": {
"description": "FQDN resolved by the DNS rule",
"type": "string",
"example": "www.example.com"
},
"DnsRule.Id": {
"description": "Identifies the DNS Rule",
"type": "string",
"example": "dnsRule1"
},
"DnsRule.IpAddress": {
"description": "IP address associated with the FQDN resolved by the DNS rule",
"type": "string",
"example": "192.0.2.0"
},
"DnsRule.IpAddressType": {
"description": "IP address type",
"type": "string",
"enum": [
"IP_V6",
"IP_V4"
],
"example": "IP_V6"
},
"DnsRule.State": {
"description": "DNS rule state. This attribute may be updated using HTTP PUT method",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
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
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
],
"example": "ACTIVE"
},
"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"
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
},
"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.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"type": "object",
"properties": {
"href": {
"$ref": "#/components/schemas/Href"
}
}
},
"Href": {
"description": "URI referring to a resource",
"type": "string",
"format": "uri",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"description": "Self-referring URI.",
"type": "object",
"required": [
"self"
],
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"subscriptions": {
"description": "The MEC application instance's subscriptions",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"type": "array",
"items": {
"$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList.Subscription"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
}
}
},
"MecAppSuptApiSubscriptionLinkList.Subscription": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"description": "A link to a subscription.",
"type": "object",
"required": [
"href",
"rel"
],
"properties": {
"href": {
"$ref": "#/components/schemas/Href"
},
"rel": {
"description": "The values shall be set to AppTerminationNotificationSubscription.",
"type": "string"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
}
},
"MecAppSuptApiSubscriptionLinkList": {
"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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"type": "object",
"required": [
"_links"
],
"properties": {
"_links": {
"$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList.Links"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
}
},
"OperationActionType": {
"description": "Operation that is being performed on the MEC application instance.",
"type": "string",
"enum": [
"STOPPING",
"TERMINATING"
],
"example": "TERMINATING"
},
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
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
825
826
827
828
829
830
831
832
833
834
"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"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"ReadyIndicationType": {
"description": "Indication about the MEC application instance.",
"type": "string",
"enum": [
"READY"
"Self": {
"description": "Self-referring URI.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"type": "object",
"required": [
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
],
"properties": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"$ref": "#/components/schemas/LinkType"
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
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
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
},
"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"
],
"example": "NONE"
},
"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",
"example": "192.0.2.0"
},
"TimingCaps.NtpServers.NtpServerAddrType": {
"description": "Address type of NTP server",
"type": "string",
"enum": [
"IP_ADDRESS",
"DNS_NAME"
],
"example": "IP_ADDRESS"
},
"TimingCaps.NtpServers_PtpMasterIpAddress": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"description": "PTP Master IP Address",
"type": "string",
"example": "192.0.2.0"
},
"TimingCaps.NtpServers_PtpMasterLocalPriority": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
919
920
921
922
923
924
925
926
927
928
929
930
931
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
959
"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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"description": "NTP server detail.",
"type": "object",
"required": [
"ptpMasterIpAddress",
"ptpMasterLocalPriority",
"delayReqMaxRate"
],
"properties": {
"ptpMasterIpAddress": {
"$ref": "#/components/schemas/TimingCaps.NtpServers_PtpMasterIpAddress"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"ptpMasterLocalPriority": {
"$ref": "#/components/schemas/TimingCaps.NtpServers_PtpMasterLocalPriority"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
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
1002
},
"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 MEC platform in response to the Timing capabilities Query message.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
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
1054
1055
1056
1057
1058
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
}
}
}
},
"TrafficFilter.Address": {
"description": "Identify the traffic ip address.",
"type": "string",
"example": "192.168.1.1"
},
"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 MEC host data plane when a packet matches the trafficFilter\n ",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"type": "string",
"enum": [
"DROP",
"FORWARD_DECAPSULATED",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"PASSTHROUGH",
"DUPLICATE_DECAPSULATED",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
],
"example": "DROP"
},
"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",
"example": "TrafficRule1"
},
"TrafficRule_Priority": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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. This attribute may be updated using HTTP PUT method",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
],
"example": "ACTIVE"
},
"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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"trafficFilter": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"type": "array",
"items": {
"$ref": "#/components/schemas/TrafficFilter"
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
},
"action": {
"$ref": "#/components/schemas/TrafficRule.Action"
},
"dstInterface": {
"$ref": "#/components/schemas/DestinationInterface"
},
"state": {
"$ref": "#/components/schemas/TrafficRule.State"
}
}
},
"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"
],
"example": "GTP_U"
},
"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"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"parameters": {
"Path.AppInstanceId": {
"name": "appInstanceId",
"description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"in": "path",
"required": true,
"schema": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"Path.DnsRuleId": {
"name": "dnsRuleId",
"description": "Represents a DNS rule.",
"in": "path",
"required": true,
"schema": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"type": "string"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"Path.SubscriptionId": {
"name": "subscriptionId",
"description": "Represents a subscription to the notifications from the MEC platform.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"in": "path",
"required": true,
"schema": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"type": "string"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"Path.TrafficRuleId": {
"name": "trafficRuleId",
"description": "Represents a traffic rule.",
"in": "path",
"required": true,
"schema": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"type": "string"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"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"
}
}
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
"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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"links": {
"getIndividualmecAppSuptApiSubscriptionLinkList": {
"$ref": "#/components/links/GetIndividualmecAppSuptApiSubscriptionLinkList"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"delIndividualmecAppSuptApiSubscriptionLinkList": {
"$ref": "#/components/links/DelIndividualmecAppSuptApiSubscriptionLinkList"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"headers": {
"location": {
"description": "The resource URI of the created resource",
"schema": {
"type": "string",
"format": "uri"
}
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppTerminationNotificationSubscription"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"links": {
"getIndividualmecAppSuptApiSubscription": {
"$ref": "#/components/links/GetIndividualmecAppSuptApiSubscription"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"delIndividualmecAppSuptApiSubscription": {
"$ref": "#/components/links/DelIndividualmecAppSuptApiSubscription"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
}
}
}
},
"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"
}
}
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
"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"
}
}
}
}
},
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"content": {
"application/json": {
"schema": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"TimingCaps.200": {
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"content": {
"application/json": {
"schema": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"Error.400": {
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"content": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"schema": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"schema": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
},
"Error.401": {
"description": "Unauthorized. It is used when the client did not submit the appropriate credentials.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"content": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Empty"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"Error.403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource. ",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"content": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"schema": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
},
"Error.404": {
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"text/plain": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"schema": {
"$ref": "#/components/schemas/Empty"
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
},
"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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
},
"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.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"text/plain": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"schema": {
"$ref": "#/components/schemas/Empty"
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
},
"Error.429": {
"description": "Too Many Requests. It is used when a rate limiter has triggered.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"text/plain": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"schema": {
"$ref": "#/components/schemas/Empty"
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
}
},
"requestBodies": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppReadyConfirmation"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppTerminationConfirmation"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"content": {
"application/json": {
"schema": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
"description": "The updated state is included in the entity body of the request.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"required": true
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppTerminationNotificationSubscription"
"description": "Entity body in the request contains a subscription to the MEC application termination notifications that is to be created.",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"content": {
"application/json": {
"schema": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
"description": "One or more updated attributes that are allowed to be changed",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"required": true
},
"AppTerminationNotification": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppTerminationNotification"
}
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"callbacks": {
"AppTerminationNotification": {
"{$request.body#/callbackReference}": {
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"requestBody": {
"$ref": "#/components/requestBodies/AppTerminationNotification"
},
"responses": {
"200": {
"description": "Expected responses from callback consumer, if it accepts the callback"
}
}
}
}
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"links": {
"GetIndividualMeDNSRule": {
"operationId": "ApplicationsDnsRule_GET",
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"subscriptionId": "TBC"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
"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"
},
{
"dnsRuleId": "DnsRule2",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.4",
"ttl": 300,
"state": "INACTIVE"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
}
]
},
"TrafficRule": {
"value": {
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
},
"state": "ACTIVE"
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
},
"TrafficRules": {
"value": [
{
"trafficRuleId": "TrafficRule123",
"serName": "ExampleService",
"filterType": "FLOW",
"priority": 1,
![Walter Featherstone Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
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 Walter Featherstone's avatar](/rep/assets/no_avatar-849f9c04a3a0d0cea2424ae97b27447dc64a7dbfae83c036c45b403392f0e8ba.png)
Walter Featherstone
committed
"action": "FORWARD_DECAPSULATED",
"dstInterface": {
"interfaceType": "IP",
"dstIpAddress": "20.1.1.1"
},
"state": "ACTIVE"
}
]