Skip to content
GitLab
Commit 431c2152 authored by Elian Kraja's avatar Elian Kraja
Browse files

Update MecServiceMgmtApi.json

parent 82cc81fc
Pipeline #11165 running with stage
Show whitespace changes
Inline Side-by-side
MecServiceMgmtApi.json
View file @ 431c2152
......@@ -20,11 +20,13 @@
"servers": [
{
"url": "http://127.0.0.1:8081/mec_service_mgmt/v1",
"variables": {}
"variables": {
}
},
{
"url": "https://127.0.0.1:8081/mec_service_mgmt/v1",
"variables": {}
"variables": {
}
}
],
"tags": [
......@@ -53,6 +55,7 @@
"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": [
......@@ -70,7 +73,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": {
......@@ -81,7 +85,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": {
......@@ -99,7 +104,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -110,7 +116,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": {
......@@ -133,6 +140,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": [
......@@ -185,7 +193,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": {
......@@ -203,7 +212,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -214,7 +224,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": {
......@@ -238,6 +249,7 @@
"post": {
"description": "'Represents the service availability information that is used in the following cases\n when the MEC platform announces the newly available\nservices to the authorized relevant MEC applications (e.g. the applications that indicate the services as \"optional\" or \"required\") that are subscribed to the corresponding service availability notifications when the MEC platform notifies the authorized relevant applications that are subscribed to the corresponding service availability notifications about the service availability changes.'",
"operationId": "ServiceAvailabilityNotification_POST",
"summary": "Create callback",
"tags": [
"callbacks"
],
......@@ -254,13 +266,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": [
......@@ -288,7 +303,8 @@
"responses": {
"200": {
"description": "Upon success, a response body containing the requested subscription is returned.",
"headers": {},
"headers": {
},
"content": {
"application/json": {
"schema": {
......@@ -299,7 +315,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": {
......@@ -317,7 +334,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -328,7 +346,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": {
......@@ -351,6 +370,7 @@
"tags": [
"appSubscriptions"
],
"summary": "delete subscription",
"description": "This method deletes a mecSrvMgmtSubscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
"operationId": "ApplicationsSubscription_DELETE",
"parameters": [
......@@ -378,12 +398,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": {
......@@ -394,7 +417,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": {
......@@ -413,13 +437,16 @@
},
"deprecated": false
},
"parameters": []
"parameters": [
]
},
"/applications/{appInstanceId}/services": {
"get": {
"tags": [
"appServices"
],
"summary": "get services",
"description": "This method retrieves information about a list of mecService resources. This method is typically used in \"service availability query\" procedure",
"operationId": "AppServices_GET",
"parameters": [
......@@ -503,7 +530,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": {
......@@ -603,7 +631,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": {
......@@ -621,7 +650,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -632,7 +662,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": {
......@@ -650,7 +681,8 @@
},
"414": {
"description": "It is used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -673,6 +705,7 @@
"tags": [
"appServices"
],
"summary": "create service",
"description": "This method is used to create a mecService resource. This method is typically used in \"service availability update and new service registration\" procedure",
"operationId": "AppServices_POST",
"parameters": [
......@@ -772,7 +805,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": {
......@@ -790,7 +824,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -801,7 +836,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": {
......@@ -820,13 +856,16 @@
},
"deprecated": false
},
"parameters": []
"parameters": [
]
},
"/applications/{appInstanceId}/services/{serviceId}": {
"get": {
"tags": [
"appServices"
],
"summary": "get service",
"description": "This method retrieves information about a mecService resource. This method is typically used in \"service availability query\" procedure",
"operationId": "AppServicesServiceId_GET",
"parameters": [
......@@ -854,7 +893,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": {
......@@ -903,7 +943,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": {
......@@ -921,7 +962,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -932,7 +974,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": {
......@@ -955,6 +998,7 @@
"tags": [
"appServices"
],
"summary": "update service",
"description": "This method updates the information about a mecService resource",
"operationId": "AppServicesServiceId_PUT",
"parameters": [
......@@ -993,7 +1037,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": {
......@@ -1042,7 +1087,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": {
......@@ -1060,7 +1106,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1071,7 +1118,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": {
......@@ -1089,7 +1137,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": {
......@@ -1112,6 +1161,7 @@
"tags": [
"appServices"
],
"summary": "delete service",
"description": "This method deletes a mecService resource. This method is typically used in the service deregistration procedure. ",
"operationId": "AppServicesServiceId_DELETE",
"parameters": [
......@@ -1139,12 +1189,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": {
......@@ -1155,7 +1208,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": {
......@@ -1174,13 +1228,16 @@
},
"deprecated": false
},
"parameters": []
"parameters": [
]
},
"/services": {
"get": {
"tags": [
"services"
],
"summary": "get services",
"description": "This method retrieves information about a list of mecService resources. This method is typically used in \"service availability query\" procedure",
"operationId": "Services_GET",
"parameters": [
......@@ -1254,7 +1311,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": {
......@@ -1354,7 +1412,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": {
......@@ -1372,7 +1431,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1383,7 +1443,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": {
......@@ -1401,7 +1462,8 @@
},
"414": {
"description": "It is used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1420,13 +1482,16 @@
},
"deprecated": false
},
"parameters": []
"parameters": [
]
},
"/services/{serviceId}": {
"get": {
"tags": [
"services"
],
"summary": "get service",
"description": "This method retrieves information about a mecService resource. This method is typically used in \"service availability query\" procedure",
"operationId": "ServicesServiceId_GET",
"parameters": [
......@@ -1444,7 +1509,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": {
......@@ -1493,7 +1559,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": {
......@@ -1511,7 +1578,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1522,7 +1590,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": {
......@@ -1541,20 +1610,26 @@
},
"deprecated": false
},
"parameters": []
"parameters": [
]
},
"/transports": {
"get": {
"tags": [
"transports"
],
"summary": "Get transports",
"description": "This method retrieves information about a list of available transports. This method is typically used by a service-producing application to discover transports provided by the MEC platform in the \"transport information query\" procedure",
"operationId": "Transports_GET",
"parameters": [],
"parameters": [
],
"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": {
......@@ -1570,7 +1645,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": {
......@@ -1588,7 +1664,8 @@
},
"403": {
"description": "Forbidden. The operation is not allowed given the current status of the resource.",
"headers": {},
"headers": {
},
"content": {
"application/problem+json": {
"schema": {
......@@ -1599,7 +1676,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": {
......@@ -1618,13 +1696,16 @@
},
"deprecated": false
},
"parameters": []
"parameters": [
]
},
"/resource_uri_allocated_by_MEC_platform": {
"get": {
"tags": [
"individualMECservice"
],
"summary": "get mecServiceLiveness",
"description": "This method retrieves information about an \"Individual mecServiceLiveness\" resource",
"operationId": "get_individual_MEC_service",
"responses": {
......@@ -1648,8 +1729,8 @@