diff --git a/.jenkins.sh b/.jenkins.sh deleted file mode 100644 index 448356cdee9aedf84853be89c4f39bbb1353304d..0000000000000000000000000000000000000000 --- a/.jenkins.sh +++ /dev/null @@ -1,18 +0,0 @@ -#!/bin/bash - -specfiles=$(ls | egrep "^[^.]*.(json|yaml)") - -fres=0 -for i in $specfiles ; do - echo "-- Validating and linting OpenAPI file $i..." - swagger-cli validate "$i" - res=$? - speccy lint "$i" - res2=$? - fres=$(($fres||$res||$res2)) - echo "--- Validator returned $res, linter returned $res2." -done - -echo "-- Final validation returns $fres." - -exit $fres \ No newline at end of file diff --git a/MecAppSupportApi.json b/MecAppSupportApi.json index 2daeee879462b331dd8c03c48d2a5c657ed2b96d..e36259c84b32173c1b5f58c2ea74c087a711f7cd 100644 --- a/MecAppSupportApi.json +++ b/MecAppSupportApi.json @@ -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": {}, + "headers": { + }, "content": { "application/problem+json": { "schema": { @@ -1414,7 +1495,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": { @@ -1432,7 +1514,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": { @@ -1450,7 +1533,8 @@ }, "429": { "description": "Too Many Requests. It is used when a rate limiter has triggered.", - "headers": {}, + "headers": { + }, "content": { "application/problem+json": { "schema": { @@ -1469,20 +1553,26 @@ }, "deprecated": false }, - "parameters": [] + "parameters": [ + + ] }, "/timing/timing_caps": { "get": { "tags": [ "timing" ], + "summary": "Retrieve timing capabilities", "description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query", "operationId": "TimingCaps_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": { @@ -1493,7 +1583,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 +1602,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 +1614,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 +1634,26 @@ }, "deprecated": false }, - "parameters": [] + "parameters": [ + + ] }, "/timing/current_time": { "get": { "tags": [ "timing" ], + "summary": "Retrieve current time", "description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure", "operationId": "TimingCurrentTime_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": { @@ -1565,7 +1664,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": { @@ -1583,7 +1683,8 @@ }, "403": { "description": "Forbidden. The operation is not allowed given the current status of the resource.", - "headers": {}, + "headers": { + }, "content": { "application/problem+json": { "schema": { @@ -1594,7 +1695,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": { @@ -1613,7 +1715,9 @@ }, "deprecated": false }, - "parameters": [] + "parameters": [ + + ] } }, "components": { @@ -2451,6 +2555,7 @@ } }, "security": [ - {} + { + } ] -} \ No newline at end of file +} diff --git a/MecAppSupportApi.yaml b/MecAppSupportApi.yaml index 7accb3796757f2f38f1225de1db574b17d559ec8..9a6ecdf2ab5f302b6b2863b8a22e371ecbaea6e2 100644 --- a/MecAppSupportApi.yaml +++ b/MecAppSupportApi.yaml @@ -30,6 +30,7 @@ paths: get: 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: @@ -132,7 +133,7 @@ paths: 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: @@ -214,7 +215,7 @@ paths: put: 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: @@ -317,6 +318,7 @@ paths: 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: @@ -404,6 +406,7 @@ paths: 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: @@ -473,6 +476,7 @@ paths: put: tags: - appDnsRules + summary: 'Update DNS rule' description: This method activates, de-activates or updates a traffic rule. operationId: ApplicationsDnsRule_PUT parameters: @@ -563,6 +567,7 @@ paths: 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: @@ -616,6 +621,7 @@ paths: post: 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: @@ -692,6 +698,7 @@ paths: operationId: AppTerminationNotification_POST tags: - callbacks + summary: 'Create callback' requestBody: $ref: '#/components/requestBodies/AppTerminationNotification' responses: @@ -702,7 +709,7 @@ paths: 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: @@ -763,7 +770,7 @@ paths: delete: 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: @@ -811,7 +818,7 @@ paths: 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: @@ -895,7 +902,7 @@ paths: 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: @@ -979,7 +986,7 @@ paths: get: tags: - timing - + summary: 'Retrieve timing capabilities' description: This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query operationId: TimingCaps_GET parameters: [] @@ -1028,7 +1035,7 @@ paths: get: tags: - timing - + summary: 'Retrieve current time' description: This method retrieves the information of the platform's current time which corresponds to the get platform time procedure operationId: TimingCurrentTime_GET parameters: [] diff --git a/MecServiceMgmtApi.json b/MecServiceMgmtApi.json index 928625900ff0ff52fae650641b68a0ed42b7dd8d..1e78b24bf1736abaf97397db4a627b161c92fd71 100644 --- a/MecServiceMgmtApi.json +++ b/MecServiceMgmtApi.json @@ -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 @@ } } }, - "403": { - "description": "The operation is not allowed given the current status of the resource. More information shall be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.", + "404": { + "description": "It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.", "content": { "application/problem+json": { "schema": { @@ -1658,8 +1739,8 @@ } } }, - "404": { - "description": "It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.", + "403": { + "description": "The operation is not allowed given the current status of the resource. More information shall be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.", "content": { "application/problem+json": { "schema": { @@ -1674,6 +1755,7 @@ "tags": [ "individualMECservice" ], + "summary": "Update mecServiceLiveness", "description": "This method updates a resource on top of the existing resource state with partial changes described by the client.", "operationId": "patch_individual_MEC_service", "requestBody": { @@ -1700,8 +1782,10 @@ }, "204": { "description": "Successful response sent when there is no need to provide a new liveness interval value to the service Instance.", - "headers": {}, - "content": {} + "headers": { + }, + "content": { + } }, "400": { "description": "It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.", @@ -1713,8 +1797,8 @@ } } }, - "403": { - "description": "The operation is not allowed given the current status of the resource. More information shall be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.", + "404": { + "description": "It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.", "content": { "application/problem+json": { "schema": { @@ -1723,8 +1807,8 @@ } } }, - "404": { - "description": "It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.", + "403": { + "description": "The operation is not allowed given the current status of the resource. More information shall be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.", "content": { "application/problem+json": { "schema": { @@ -2470,6 +2554,7 @@ } }, "security": [ - {} + { + } ] -} \ No newline at end of file +} diff --git a/MecServiceMgmtApi.yaml b/MecServiceMgmtApi.yaml index c3fbca09b99e300402a22538305cf95d469ab841..a325d529121e8a49b08e1dafeca7ee5c692b6474 100644 --- a/MecServiceMgmtApi.yaml +++ b/MecServiceMgmtApi.yaml @@ -30,7 +30,7 @@ paths: 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: @@ -84,7 +84,7 @@ paths: post: 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: @@ -168,6 +168,7 @@ paths: applications that are subscribed to the corresponding service availability notifications about the service availability changes.' operationId: ServiceAvailabilityNotification_POST + summary: "Create callback" tags: - callbacks requestBody: @@ -180,7 +181,7 @@ paths: 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: @@ -241,7 +242,7 @@ paths: delete: 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: @@ -289,6 +290,7 @@ paths: 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: @@ -460,6 +462,7 @@ paths: post: 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: @@ -562,6 +565,7 @@ paths: 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: @@ -650,6 +654,7 @@ paths: put: tags: - appServices + summary: update service description: This method updates the information about a mecService resource operationId: AppServicesServiceId_PUT parameters: @@ -757,6 +762,7 @@ paths: delete: 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: @@ -804,7 +810,7 @@ paths: 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: @@ -971,7 +977,7 @@ paths: 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: @@ -1055,7 +1061,7 @@ paths: 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: [] @@ -1109,6 +1115,7 @@ paths: get: tags: - individualMECservice + summary: get mecServiceLiveness description: This method retrieves information about an "Individual mecServiceLiveness" resource operationId: get_individual_MEC_service responses: @@ -1140,6 +1147,7 @@ paths: patch: tags: - individualMECservice + summary: Update mecServiceLiveness description: This method updates a resource on top of the existing resource state with partial changes described by the client. operationId: patch_individual_MEC_service requestBody: diff --git a/README.md b/README.md index 25983c60126b8fe620aac48266fbbd0b4126ff2e..b559bfdc3778313bfe8bda1ed3867f13a2f94690 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,12 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E ## Online resources * [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf) -* [Navigate the MEC Application Support API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/stf606-final/MecAppSupportApi.yaml). -* [Navigate the MEC Service Management API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/stf606-final/MecServiceMgmtApi.yaml). -* [Edit the MEC Application Support API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/stf606-final/MecAppSupportApi.yaml). -* [Edit the MEC Service Management API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/stf606-final/MecServiceMgmtApi.yaml). +* [Navigate the MEC Application Support API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/v2.2.1/MecAppSupportApi.yaml). +* [Navigate the MEC Service Management API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/v2.2.1/MecServiceMgmtApi.yaml). +* [Edit the MEC Application Support API online](https://redocly.github.io/redoc/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/v2.2.1/MecAppSupportApi.yaml). +* [Edit the MEC Service Management API online](https://redocly.github.io/redoc/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/v2.2.1/MecServiceMgmtApi.yaml). ## License Unless specified otherwise, the content of this repository and the files contained are released under the BSD-3-Clause license. -See the attached LICENSE file or visit https://forge.etsi.org/legal-matters. \ No newline at end of file +See the attached LICENSE file or visit https://forge.etsi.org/legal-matters.