From 0fa6ffa768e6195b658c55b02cd0b6b9f3cd794d Mon Sep 17 00:00:00 2001 From: urvika-v Date: Thu, 28 Nov 2024 08:02:49 +0530 Subject: [PATCH 1/2] Fixed linting issues- Application-endpoint-registration.yaml --- .../Application-endpoint-registration.yaml | 48 ++++++++++--------- 1 file changed, 26 insertions(+), 22 deletions(-) diff --git a/code/API_definitions/Application-endpoint-registration.yaml b/code/API_definitions/Application-endpoint-registration.yaml index 08af65b..fe7b36f 100644 --- a/code/API_definitions/Application-endpoint-registration.yaml +++ b/code/API_definitions/Application-endpoint-registration.yaml @@ -1,3 +1,4 @@ +--- openapi: 3.0.3 info: title: Application Endpoints Registration @@ -9,7 +10,7 @@ info: # Introduction - The API registers the Edge Application Endpoints. + The API registers the Edge Application Endpoint. This information can be used for various use cases like optimal endpoint discovery to help end users connect to the most optimal instance of the application which is distributed across various Edge Cloud Zones. @@ -30,8 +31,8 @@ info: The API provides 4 operations: - POST registerApplicationEndpoints: Registers the Application Endpoints of a deployed application to a specified edge cloud zone. - - GET getAllRegisteredApplicationEndpoints: Returns endpoint information - for all registered Applications. + - GET getAllRegisteredApplicationEndpoints: Returns endpoint information for + all registered Applications. - GET getApplicationEndpointsByID: Returns endpoint information for all Applications registered to a specified applicationEndpointId. - PUT updateApplicationEndpoint: Update registered application endpoint @@ -64,7 +65,8 @@ info: [GSMA Mobile Connect Account Takeover Protection specification] (https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.24-Mobile- - Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements-v2.0.pdf) + Connect-Account-Takeover-Protection-Definition-and-Technical-Requirements- + v2.0.pdf) was used as source of input for this API. For more about Mobile Connect, please see [Mobile Connect website](https://mobileconnect.io/). @@ -483,8 +485,8 @@ components: value: status: 400 code: INVALID_ARGUMENT - message: Client specified an invalid argument, request - body or query param. + message: Client specified an invalid argument, request body or + query param. Generic401: description: Unauthorized headers: @@ -500,8 +502,8 @@ components: value: status: 401 code: UNAUTHENTICATED - message: Request not authenticated due to missing, invalid, - or expired credentials. + message: Request not authenticated due to missing, invalid, or + expired credentials. Generic403: description: Forbidden headers: @@ -513,22 +515,23 @@ components: $ref: '#/components/schemas/ErrorInfo' examples: GENERIC_403_PERMISSION_DENIED: - description: Permission denied. OAuth2 token access does not - have the required scope or when the user fails operational - security + description: | + Permission denied. OAuth2 token access does not have the required + scope or when the user fails operational security value: status: 403 code: PERMISSION_DENIED - message: Client does not have sufficient permissions to - perform this action. + message: Client does not have sufficient permissions to perform + this action. GENERIC_403_INVALID_TOKEN_CONTEXT: - description: Reflect some inconsistency between information in - some field of the API and the related OAuth2 Token + description: | + Reflect some inconsistency between information in some field + of the API and the related OAuth2 Token value: status: 403 code: INVALID_TOKEN_CONTEXT - message: applicationProfileId is not consistent with access - token + message: applicationProfileId is not consistent with + access token Generic404: description: Not found headers: @@ -562,9 +565,10 @@ components: code: NOT_SUPPORTED message: Service not supported for this applicationProfileId UNIDENTIFIABLE_APPLICATION_PROFILE: - description: The Application Profile is not included in the - request and the profile information cannot be derived from - the 3-legged access token + description: | + The Application Profile is not included in the request + and the profile information cannot be derived + from the 3-legged access token value: status: 422 code: UNIDENTIFIABLE_APPLICATION_PROFILE @@ -597,8 +601,8 @@ components: examples: GENERIC_503_UNAVAILABLE: description: Service is not available. - Temporary situation usually related to maintenance process - in the server side + Temporary situation usually related to maintenance process in + the server side value: status: 503 code: UNAVAILABLE From 4b710b259a465e19b83f5fe49886873017826521 Mon Sep 17 00:00:00 2001 From: urvika-v Date: Thu, 28 Nov 2024 08:07:50 +0530 Subject: [PATCH 2/2] Update Application-endpoint-registration.yaml --- code/API_definitions/Application-endpoint-registration.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/Application-endpoint-registration.yaml b/code/API_definitions/Application-endpoint-registration.yaml index fe7b36f..3ce2ef3 100644 --- a/code/API_definitions/Application-endpoint-registration.yaml +++ b/code/API_definitions/Application-endpoint-registration.yaml @@ -10,7 +10,7 @@ info: # Introduction - The API registers the Edge Application Endpoint. + The API registers the Edge Application Endpoints. This information can be used for various use cases like optimal endpoint discovery to help end users connect to the most optimal instance of the application which is distributed across various Edge Cloud Zones.