Update API definitions to fix CAMARA validation warnings and hint by bigludo7 · Pull Request #96 · camaraproject/DeviceSwap

bigludo7 · 2026-07-16T11:52:32Z

What type of PR is this?

Add one of the following kinds:

correction
cleanup
subproject management

What this PR does / why we need it:

CAMARA validation is reporting warnings and hints.

Which issue(s) this PR fixes:

Fixes #95

Special notes for reviewers:

Changelog input

 release-note
- Update API definitions to fix CAMARA validation warnings and hints

Additional documentation

This section can be blank.

docs

Updated error response references and added descriptions for request body properties in device-swap.yaml.

…klist.md

camara-validation · 2026-07-16T11:53:10Z

CAMARA Validation — PASS

0 errors, 0 warnings, 0 hints | Profile: standard

View full results

PedroDiez · 2026-07-30T11:42:53Z

                  $ref: "#/components/examples/RETRIEVE_MONITORED_NULL"
        "400":
-          $ref: "#/components/responses/Generic400"
+          $ref: "../common/CAMARA_common.yaml#/components/responses/Generic400"


Using here the generic reference adds the unused error "OUT_OF_RANGE"

Thanks @PedroDiez for the review
I can change but we will have a inconsistency with SIM Swap which use the generic for same operation.
WDYT?
adding @albertoramosmonagas

Understood @bigludo7, i left some comments below for aligment with Sim-Swap

For /retrieve-date. I think it would be needed to align with Sim-Swap approach https://github.com/camaraproject/SimSwap/blob/main/code/API_definitions/sim-swap.yaml#L192

So some error references keep to the local Device Swap error definition

PedroDiez · 2026-07-30T11:44:32Z

+          $ref: "../common/CAMARA_common.yaml#/components/responses/Generic401"
        "403":
-          $ref: "#/components/responses/Generic403"
+          $ref: "../common/CAMARA_common.yaml#/components/responses/Generic403"


Using in both endpoints local generic reference introduces undesired "INVALID_TOKEN_CONTEXT"

Better to keep the local reference within this API

Same comment than previous.
Perhaps the issue is on sim swap ;(

albertoramosmonagas · 2026-07-30T12:49:39Z

-          example: 120
+          format: int32
+          minimum: 1
+          maximum: 999


format: int32 and minimum: 1 seem reasonable. However, maximum: 999 introduces a functional restriction, as providers supporting a longer monitoring period would no longer be compliant. I would only add this maximum if there is an agreed requirement behind it.

I checked for SIM swap and we have:

type: integer format: int32 minimum: 1 maximum: 999

I propose to keep same - WDYT @albertoramosmonagas ?

I see that is a change to align with commonalities, okey for me!

PedroDiez · 2026-07-31T10:37:52Z

                  $ref: "#/components/examples/RETRIEVE_MONITORED_NULL"
        "400":
-          $ref: "#/components/responses/Generic400"
+          $ref: "../common/CAMARA_common.yaml#/components/responses/Generic400"


Understood @bigludo7, i left some comments below for aligment with Sim-Swap

PedroDiez · 2026-07-31T10:46:33Z

                  $ref: "#/components/examples/RETRIEVE_MONITORED_NULL"
        "400":
-          $ref: "#/components/responses/Generic400"
+          $ref: "../common/CAMARA_common.yaml#/components/responses/Generic400"


For /retrieve-date. I think it would be needed to align with Sim-Swap approach https://github.com/camaraproject/SimSwap/blob/main/code/API_definitions/sim-swap.yaml#L192

So some error references keep to the local Device Swap error definition

PedroDiez · 2026-07-31T10:47:12Z

            application/json:
              schema:
                $ref: "#/components/schemas/CheckDeviceSwapInfo"
        "400":


For /check. I think it would be needed to align with Sim-Swap approach
https://github.com/camaraproject/SimSwap/blob/main/code/API_definitions/sim-swap.yaml#L241

So some error references keep to the local Device Swap error definition

Updated response references to use local definitions instead of external common file.

PedroDiez

Change is fine, two minor comments

PedroDiez · 2026-07-31T14:11:38Z

+                status: 403
+                code: PERMISSION_DENIED
+                message: Client does not have sufficient permissions to perform this action.
+    Generic404:


local swagger 404 can be removed is not used

PedroDiez · 2026-07-31T14:12:27Z

+                status: 422
+                code: UNNECESSARY_IDENTIFIER
+                message: The device is already identified by the access token.
+    Generic429:


Idem can be removed, not used

Yes ! will do now

@PedroDiez done !

Removed Generic404 and Generic429 error definitions from the device-swap.yaml file.

PedroDiez

LGTM

bigludo7 · 2026-07-31T14:22:29Z

Up to you @jgarciahospital - Then we can merge and create the snapshot.

jgarciahospital

LGTM

bigludo7 added 2 commits July 16, 2026 13:46

Refactor device-swap.yaml for error handling and descriptions

e8f0629

Updated error response references and added descriptions for request body properties in device-swap.yaml.

Delete documentation/API_documentation/device-swap-API-Readiness-Chec…

1c576f6

…klist.md

bigludo7 requested review from jgarciahospital and krishvenkatachalam as code owners July 16, 2026 11:52

Update device-swap.yaml

d7e5558

bigludo7 changed the title ~~Fix95~~ Update API definitions to fix CAMARA validation warnings and hint Jul 16, 2026

PedroDiez reviewed Jul 30, 2026

View reviewed changes

albertoramosmonagas reviewed Jul 30, 2026

View reviewed changes

PedroDiez reviewed Jul 31, 2026

View reviewed changes

Change response references to local definitions for 404&422

1ea484f

Updated response references to use local definitions instead of external common file.

PedroDiez reviewed Jul 31, 2026

View reviewed changes

Remove Generic404 and Generic429 error definitions

f96225a

Removed Generic404 and Generic429 error definitions from the device-swap.yaml file.

PedroDiez approved these changes Jul 31, 2026

View reviewed changes

jgarciahospital approved these changes Aug 3, 2026

View reviewed changes

jgarciahospital merged commit a2b06c8 into main Aug 3, 2026
3 checks passed

Uh oh!

Conversation

bigludo7 commented Jul 16, 2026

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for reviewers:

Changelog input

Additional documentation

Uh oh!

camara-validation Bot commented Jul 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CAMARA Validation — PASS

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bigludo7 Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PedroDiez Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bigludo7 Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PedroDiez left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PedroDiez left a comment

Choose a reason for hiding this comment

Uh oh!

bigludo7 commented Jul 31, 2026

Uh oh!

jgarciahospital left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

camara-validation Bot commented Jul 16, 2026 •

edited

Loading

bigludo7 Jul 30, 2026 •

edited

Loading

PedroDiez Jul 30, 2026 •

edited

Loading

bigludo7 Jul 30, 2026 •

edited

Loading