Commit 82cc81fc authored by Elian Kraja's avatar Elian Kraja
Browse files

Update MecAppSupportApi.json

parent b764bc6e
Pipeline #11164 failed with stage
in 0 seconds
......@@ -43,11 +43,13 @@
"servers": [
{
"url": "http://127.0.0.1:8081/mec_app_support/v1",
"variables": {}
"variables": {
}
},
{
"url": "https://127.0.0.1:8081/mec_app_support/v1",
"variables": {}
"variables": {
}
}
],
"paths": {
......@@ -56,6 +58,7 @@
"tags": [
"appTrafficRules"
],
"summary": "get traffic rules",
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRules_GET",
"parameters": [
......@@ -73,7 +76,8 @@
"responses": {
"200": {
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/json": {
"schema": {
......@@ -162,7 +166,8 @@
},
"400": {
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -180,7 +185,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -191,7 +197,8 @@
},
"404": {
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -210,13 +217,16 @@
},
"deprecated": false
},
"parameters": []
"parameters": [
]
},
"/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
"get": {
"tags": [
"appTrafficRules"
],
"summary": "Get traffic rule",
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRule_GET",
"parameters": [
......@@ -244,7 +254,8 @@
"responses": {
"200": {
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/json": {
"schema": {
......@@ -288,7 +299,8 @@
},
"400": {
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -306,7 +318,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -317,7 +330,8 @@
},
"404": {
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -340,6 +354,7 @@
"tags": [
"appTrafficRules"
],
"summary": "Update traffic rule",
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRule_PUT",
"parameters": [
......@@ -378,7 +393,8 @@
"responses": {
"200": {
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/json": {
"schema": {
......@@ -422,7 +438,8 @@
},
"400": {
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -440,7 +457,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -451,7 +469,8 @@
},
"404": {
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -469,7 +488,8 @@
},
"412": {
"description": "Precondition Failed. It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -488,13 +508,16 @@
},
"deprecated": false
},
"parameters": []
"parameters": [
]
},
"/applications/{appInstanceId}/dns_rules": {
"get": {
"tags": [
"appDnsRules"
],
"summary": "Get DNS rules",
"description": "This method retrieves information about all the DNS rules associated with a MEC application instance.",
"operationId": "ApplicationsDnsRules_GET",
"parameters": [
......@@ -512,7 +535,8 @@
"responses": {
"200": {
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/json": {
"schema": {
......@@ -570,7 +594,8 @@
},
"400": {
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -588,7 +613,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -599,7 +625,8 @@
},
"404": {
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -618,13 +645,16 @@
},
"deprecated": false
},
"parameters": []
"parameters": [
]
},
"/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
"get": {
"tags": [
"appDnsRules"
],
"summary": "Get DNS rule",
"description": "This method retrieves information about a DNS rule associated with a MEC application instance.",
"operationId": "ApplicationsDnsRule_GET",
"parameters": [
......@@ -652,7 +682,8 @@
"responses": {
"200": {
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/json": {
"schema": {
......@@ -675,7 +706,8 @@
},
"400": {
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -693,7 +725,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -704,7 +737,8 @@
},
"404": {
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -727,6 +761,7 @@
"tags": [
"appDnsRules"
],
"summary": "Update DNS rule",
"description": "This method activates, de-activates or updates a traffic rule.",
"operationId": "ApplicationsDnsRule_PUT",
"parameters": [
......@@ -765,7 +800,8 @@
"responses": {
"200": {
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/json": {
"schema": {
......@@ -788,7 +824,8 @@
},
"400": {
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -806,7 +843,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -817,7 +855,8 @@
},
"404": {
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -835,7 +874,8 @@
},
"412": {
"description": "Precondition Failed. It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -854,13 +894,16 @@
},
"deprecated": false
},
"parameters": []
"parameters": [
]
},
"/applications/{appInstanceId}/subscriptions": {
"get": {
"tags": [
"appSubscriptions"
],
"summary": "Get subscriptions",
"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",
"parameters": [
......@@ -878,7 +921,8 @@
"responses": {
"200": {
"description": "Upon success, a response body containing the list of links to the requested subscriptions is returned.",
"headers": {},
"headers": {
},
"content": {
"application/json": {
"schema": {
......@@ -889,7 +933,8 @@
},
"400": {
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -907,7 +952,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -918,7 +964,8 @@
},
"404": {
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -941,6 +988,7 @@
"tags": [
"appSubscriptions"
],
"summary": "Create subscription",
"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",
"parameters": [
......@@ -993,7 +1041,8 @@
},
"400": {
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1011,7 +1060,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1022,7 +1072,8 @@
},
"404": {
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1049,6 +1100,7 @@
"tags": [
"callbacks"
],
"summary": "Create callback",
"requestBody": {
"$ref": "#/components/requestBodies/AppTerminationNotification"
},
......@@ -1062,13 +1114,16 @@
}
}
},
"parameters": []
"parameters": [
]
},
"/applications/{appInstanceId}/subscriptions/{subscriptionId}": {
"get": {
"tags": [
"appSubscriptions"
],
"summary": "Get subscription",
"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": [
......@@ -1096,7 +1151,8 @@
"responses": {
"200": {
"description": "Upon success, a response body containing the requested subscription is returned.",
"headers": {},
"headers": {
},
"content": {
"application/json": {
"schema": {
......@@ -1107,7 +1163,8 @@
},
"400": {
"description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1125,7 +1182,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1136,7 +1194,8 @@
},
"404": {
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1159,6 +1218,7 @@
"tags": [
"appSubscriptions"
],
"summary": "delete subscription",
"description": "This method deletes a mecAppSuptApiSubscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
"operationId": "ApplicationsSubscription_DELETE",
"parameters": [
......@@ -1186,12 +1246,15 @@
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
"headers": {
},
"content": {
}
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1202,7 +1265,8 @@
},
"404": {
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1221,13 +1285,16 @@
},
"deprecated": false
},
"parameters": []
"parameters": [
]
},
"/applications/{appInstanceId}/confirm_termination": {
"post": {
"tags": [
"appConfirmTermination"
],
"summary": "Confirm termination",
"description": "This method is used to confirm the application level termination of an application instance.",
"operationId": "ApplicationsConfirmTermination_POST",
"parameters": [
......@@ -1256,12 +1323,15 @@
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
"headers": {
},
"content": {
}
},
"401": {
"description": "Unauthorized. It is used when the client did not submit the appropriate credentials.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1279,7 +1349,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1290,7 +1361,8 @@
},
"404": {
"description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1308,7 +1380,8 @@
},
"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.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1326,7 +1399,8 @@
},
"429": {
"description": "Too Many Requests. It is used when a rate limiter has triggered.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1345,13 +1419,16 @@
},
"deprecated": false
},
"parameters": []
"parameters": [
]
},
"/applications/{appInstanceId}/confirm_ready": {
"post": {
"tags": [
"appConfirmReady"
],
"summary": "Confirm ready",
"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": [
......@@ -1380,12 +1457,15 @@
"responses": {
"204": {
"description": "No Content",
"headers": {},
"content": {}
"headers": {
},
"content": {
}
},
"401": {
"description": "Unauthorized. It is used when the client did not submit the appropriate credentials.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1403,7 +1483,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},