Skip to content

Commit

Permalink
Merge pull request #327 from urvika-v/286-eds-api-application-endpoin…
Browse files Browse the repository at this point in the history
…ts-functionality-to-be-a-new-api

AER: Fixed Linting issues
  • Loading branch information
maheshc01 authored Dec 1, 2024
2 parents 158bfe3 + 4b710b2 commit ce21596
Showing 1 changed file with 25 additions and 21 deletions.
46 changes: 25 additions & 21 deletions code/API_definitions/Application-endpoint-registration.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: 3.0.3
info:
title: Application Endpoints Registration
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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/).
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit ce21596

Please sign in to comment.