Skip to content

[Changed] Update error response schema using new Commonalities r4.4 schemas #213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eric-murray merged 2 commits into from
Sep 22, 2026
Merged

[Changed] Update error response schema using new Commonalities r4.4 schemas #213

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6afc21
Update error response schema using new Commonalities r4.4 schema
eric-murray Sep 22, 2026
4a9a950
Merge branch 'camaraproject:main' into eric-murray-patch-1
eric-murray Sep 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 24 additions & 136 deletions code/API_definitions/device-identifier.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,17 +233,17 @@ paths:
"200":
$ref: '#/components/responses/200RetrieveIdentifier'
"400":
$ref: '#/components/responses/400BadRequest'
$ref: '../common/CAMARA_common.yaml#/components/responses/BadRequestWithRange400'
"401":
$ref: '../common/CAMARA_common.yaml#/components/responses/Generic401'
$ref: '../common/CAMARA_common.yaml#/components/responses/Unauthenticated401'
"403":
$ref: '#/components/responses/403Forbidden'
$ref: '../common/CAMARA_common.yaml#/components/responses/PermissionDenied403'
"404":
$ref: '#/components/responses/404NotFound'
$ref: '../common/CAMARA_common.yaml#/components/responses/IdentifierNotFound404'
"422":
$ref: '../common/CAMARA_common.yaml#/components/responses/Generic422'
$ref: '../common/CAMARA_common.yaml#/components/responses/DeviceIdentifier422'
"429":
$ref: '../common/CAMARA_common.yaml#/components/responses/Generic429'
$ref: '../common/CAMARA_common.yaml#/components/responses/TooManyRequests429'

"/retrieve-type":
post:
Expand Down Expand Up @@ -279,17 +279,17 @@ paths:
"200":
$ref: '#/components/responses/200RetrieveType'
"400":
$ref: '#/components/responses/400BadRequest'
$ref: '../common/CAMARA_common.yaml#/components/responses/BadRequestWithRange400'
"401":
$ref: '../common/CAMARA_common.yaml#/components/responses/Generic401'
$ref: '../common/CAMARA_common.yaml#/components/responses/Unauthenticated401'
"403":
$ref: '#/components/responses/403Forbidden'
$ref: '../common/CAMARA_common.yaml#/components/responses/PermissionDenied403'
"404":
$ref: '#/components/responses/404NotFound'
$ref: '../common/CAMARA_common.yaml#/components/responses/IdentifierNotFound404'
"422":
$ref: '../common/CAMARA_common.yaml#/components/responses/Generic422'
$ref: '../common/CAMARA_common.yaml#/components/responses/DeviceIdentifier422'
"429":
$ref: '../common/CAMARA_common.yaml#/components/responses/Generic429'
$ref: '../common/CAMARA_common.yaml#/components/responses/TooManyRequests429'

"/retrieve-ppid":
post:
Expand Down Expand Up @@ -325,17 +325,17 @@ paths:
"200":
$ref: '#/components/responses/200RetrievePPID'
"400":
$ref: '#/components/responses/400BadRequest'
$ref: '../common/CAMARA_common.yaml#/components/responses/BadRequestWithRange400'
"401":
$ref: '../common/CAMARA_common.yaml#/components/responses/Generic401'
$ref: '../common/CAMARA_common.yaml#/components/responses/Unauthenticated401'
"403":
$ref: '#/components/responses/403Forbidden'
$ref: '../common/CAMARA_common.yaml#/components/responses/PermissionDenied403'
"404":
$ref: '#/components/responses/404NotFound'
$ref: '../common/CAMARA_common.yaml#/components/responses/IdentifierNotFound404'
"422":
$ref: '../common/CAMARA_common.yaml#/components/responses/Generic422'
$ref: '../common/CAMARA_common.yaml#/components/responses/DeviceIdentifier422'
"429":
$ref: '../common/CAMARA_common.yaml#/components/responses/Generic429'
$ref: '../common/CAMARA_common.yaml#/components/responses/TooManyRequests429'

"/match-identifier":
post:
Expand Down Expand Up @@ -371,17 +371,17 @@ paths:
"200":
$ref: '#/components/responses/200MatchIdentifier'
"400":
$ref: '#/components/responses/400BadRequest'
$ref: '../common/CAMARA_common.yaml#/components/responses/BadRequestWithRange400'
"401":
$ref: '../common/CAMARA_common.yaml#/components/responses/Generic401'
$ref: '../common/CAMARA_common.yaml#/components/responses/Unauthenticated401'
"403":
$ref: '#/components/responses/403Forbidden'
$ref: '../common/CAMARA_common.yaml#/components/responses/PermissionDenied403'
"404":
$ref: '#/components/responses/404NotFound'
$ref: '../common/CAMARA_common.yaml#/components/responses/IdentifierNotFound404'
"422":
$ref: '../common/CAMARA_common.yaml#/components/responses/Generic422'
$ref: '../common/CAMARA_common.yaml#/components/responses/DeviceIdentifier422'
"429":
$ref: '../common/CAMARA_common.yaml#/components/responses/Generic429'
$ref: '../common/CAMARA_common.yaml#/components/responses/TooManyRequests429'

components:
securitySchemes:
Expand Down Expand Up @@ -527,118 +527,6 @@ components:
lastChecked: "2024-02-20T10:41:38.657Z"
match: true

400BadRequest:
description: |
Invalid request syntax or malformed JSON.
This status is reserved for:
- Malformed JSON in the request body
- Invalid data types
- Invalid format (not matching required patterns)
Business validation errors should return 422 instead.
headers:
x-correlator:
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "../common/CAMARA_common.yaml#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 400
code:
enum:
- INVALID_ARGUMENT
- OUT_OF_RANGE
examples:
Insufficient Parameters:
description: Sufficient parameters must be provided to allow the target UE to be identified
value:
status: 400
code: INVALID_ARGUMENT
message: "At least one of phoneNumber, networkAccessIdentifier, ipv4Address and ipv6Address must be specified"
Invalid Network Access Identifier:
value:
status: 400
code: INVALID_ARGUMENT
message: "Invalid format: networkAccessIdentifier"
Invalid Phone Number:
value:
status: 400
code: INVALID_ARGUMENT
message: "Invalid format: phoneNumber"
Invalid IPv4 Address:
value:
status: 400
code: INVALID_ARGUMENT
message: "Invalid format: ipv4Address"
Invalid IPv6 Address:
value:
status: 400
code: INVALID_ARGUMENT
message: "Invalid format: ipv6Address"
Invalid Port Value:
value:
status: 400
code: OUT_OF_RANGE
message: "Invalid value: ipv4Address.publicPort"

403Forbidden:
description: Forbidden
headers:
x-correlator:
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "../common/CAMARA_common.yaml#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 403
code:
enum:
- PERMISSION_DENIED
examples:
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.

404NotFound:
description: |
Subscription cannot be resolved from the provided device identifiers or access token.
The network cannot map the request to a known subscription.
headers:
x-correlator:
$ref: "../common/CAMARA_common.yaml#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "../common/CAMARA_common.yaml#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 404
code:
enum:
- IDENTIFIER_NOT_FOUND
examples:
Mobile Device Identifier Not Found:
description: The provided identifier cannot be matched to a device known to the API provider
value:
status: 404
code: IDENTIFIER_NOT_FOUND
message: The provided identifier cannot be matched to a device.

schemas:
Imei:
description: Schema for the International Mobile Equipment Identity (IMEI) of a physical mobile device
Expand Down
Loading