From 01b722de5514593660ed9b666db7edecae53c8ea Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 23 Oct 2026 10:10:55 +0200 Subject: [PATCH] Refactor error response references in API definition Updated references to error responses in the call forwarding API definition to use centralized definitions from CAMARA_common.yaml. --- .../call-forwarding-signal.yaml | 142 +----------------- 1 file changed, 8 insertions(+), 134 deletions(-) diff --git a/code/API_definitions/call-forwarding-signal.yaml b/code/API_definitions/call-forwarding-signal.yaml index aa4c077..6da73da 100644 --- a/code/API_definitions/call-forwarding-signal.yaml +++ b/code/API_definitions/call-forwarding-signal.yaml @@ -201,15 +201,15 @@ paths: schema: $ref: '#/components/schemas/UnconditionalCallForwardingSignal' "400": - $ref: "#/components/responses/Generic400" + $ref: '../common/CAMARA_common.yaml#/components/responses/BadRequest400' '404': $ref: '#/components/responses/Generic404' "401": - $ref: "#/components/responses/Generic401" + $ref: "../common/CAMARA_common.yaml#/components/responses/Unauthenticated401" "403": - $ref: "#/components/responses/Generic403" + $ref: "../common/CAMARA_common.yaml#/components/responses/PermissionDenied403" "422": - $ref: "#/components/responses/Generic422" + $ref: "../common/CAMARA_common.yaml#/components/responses/PhoneNumberIdentifier422" "429": $ref: "#/components/responses/Generic429" /retrieve-forwardings: @@ -246,15 +246,15 @@ paths: schema: $ref: '#/components/schemas/CallForwardingSignal' "400": - $ref: "#/components/responses/Generic400" + $ref: '../common/CAMARA_common.yaml#/components/responses/BadRequest400' '404': $ref: '#/components/responses/Generic404' "401": - $ref: "#/components/responses/Generic401" + $ref: "../common/CAMARA_common.yaml#/components/responses/Unauthenticated401" "403": - $ref: "#/components/responses/Generic403" + $ref: "../common/CAMARA_common.yaml#/components/responses/PermissionDenied403" "422": - $ref: "#/components/responses/Generic422" + $ref: "../common/CAMARA_common.yaml#/components/responses/PhoneNumberIdentifier422" "429": $ref: "#/components/responses/Generic429" "501": @@ -344,86 +344,6 @@ components: ErrorInfo: $ref: "../common/CAMARA_common.yaml#/components/schemas/ErrorInfo" responses: - Generic400: - description: Bad Request - headers: - x-correlator: - $ref: "#/components/headers/x-correlator" - content: - application/json: - schema: - allOf: - - $ref: "#/components/schemas/ErrorInfo" - - type: object - properties: - status: - enum: - - 400 - code: - enum: - - INVALID_ARGUMENT - examples: - GENERIC_400_INVALID_ARGUMENT: - description: Invalid Argument. Generic Syntax Exception - value: - status: 400 - code: INVALID_ARGUMENT - message: Client specified an invalid argument, request body or - query param. - Generic401: - description: Unauthorized - headers: - x-correlator: - $ref: "#/components/headers/x-correlator" - content: - application/json: - schema: - allOf: - - $ref: "#/components/schemas/ErrorInfo" - - type: object - properties: - status: - enum: - - 401 - code: - enum: - - UNAUTHENTICATED - examples: - GENERIC_401_UNAUTHENTICATED: - description: Request cannot be authenticated and a new authentication - is required - value: - status: 401 - code: UNAUTHENTICATED - message: Request not authenticated due to missing, invalid, or expired - credentials. A new authentication is required. - Generic403: - description: Forbidden - headers: - x-correlator: - $ref: "#/components/headers/x-correlator" - content: - application/json: - schema: - allOf: - - $ref: "#/components/schemas/ErrorInfo" - - type: object - properties: - status: - enum: - - 403 - code: - enum: - - PERMISSION_DENIED - examples: - GENERIC_403_PERMISSION_DENIED: - 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. Generic404: description: Not found headers: @@ -457,52 +377,6 @@ components: status: 404 code: IDENTIFIER_NOT_FOUND message: Device identifier not found. - Generic422: - description: Unprocessable Content - headers: - x-correlator: - $ref: "#/components/headers/x-correlator" - content: - application/json: - schema: - allOf: - - $ref: "#/components/schemas/ErrorInfo" - - type: object - properties: - status: - enum: - - 422 - code: - enum: - - SERVICE_NOT_APPLICABLE - - MISSING_IDENTIFIER - - UNNECESSARY_IDENTIFIER - examples: - GENERIC_422_SERVICE_NOT_APPLICABLE: - description: Service not applicable for the provided - identifier - value: - status: 422 - code: SERVICE_NOT_APPLICABLE - message: The service is not available for the - provided identifier. - GENERIC_422_MISSING_IDENTIFIER: - description: An identifier is not included in the - request and the device or phone number identification - cannot be derived from the 3-legged access token - value: - status: 422 - code: MISSING_IDENTIFIER - message: The phone number cannot be identified. - GENERIC_422_UNNECESSARY_IDENTIFIER: - description: An explicit identifier is provided when - a device or phone number has already been identified - from the access token - value: - status: 422 - code: UNNECESSARY_IDENTIFIER - message: The phone number is already identified by the - access token. Generic429: description: Too Many Requests headers: