Skip to content
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

Jump to bottom

Update location-retrieval for Spring25 #283

Merged
merged 9 commits into from
Jan 22, 2025
Merged

Update location-retrieval for Spring25 #283

merged 9 commits into from
Jan 22, 2025

Conversation

bigludo7
Copy link
Collaborator

What type of PR is this?

Add one of the following kinds:

  • enhancement/feature

What this PR does / why we need it:

Updates location-retrieval API with the changes derived from Commonalities and ICM updates
x-camara-guidelines: 0.5.0

Which issue(s) this PR fixes:

Fixes #276, #279

Special notes for reviewers:

There are still some open discussions in Commonalities that may impact this PR, so we will keep it open until there is a final version for x-camara-guidelines: 0.5.0

Changelog input

* Error schemas updated with enums
* Some error status and codes have been updated
* Section with guidelines about how to identify the device from access token and request body has been updated 
*  Test definitions aligned with API specification update

Additional documentation

This section can be blank.

docs

@bigludo7
Align location-retrieval.yaml comm 0.5 for Error
455080c 
Align location-retrieval.yaml comm 0.5 for Error
@bigludo7
Align error code with comm.0.5
8327a2a 
Align error code with comm.0.5
@bigludo7 bigludo7 self-assigned this Dec 18, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 18, 2024 •
edited
Loading

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.03s
✅ OPENAPI spectral 3 0 4.98s
✅ REPOSITORY git_diff yes no 0.01s
✅ REPOSITORY secretlint yes no 0.82s
✅ YAML yamllint 3 0 0.67s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

maxl2287
maxl2287 previously approved these changes Jan 8, 2025
View reviewed changes
Copy link
Contributor

@maxl2287 maxl2287 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)

jlurien
jlurien reviewed Jan 14, 2025
View reviewed changes
code/API_definitions/location-retrieval.yaml Outdated
code:
enum:
- PERMISSION_DENIED
- INVALID_TOKEN_CONTEXT
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may need to remove INVALID_TOKEN_CONTEXT for our APIs. There is an ongoing discussion in Commonalities

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tend to prefer to remove it. What is your view @jlurien as we need probably to move forward with this PR? I remove it, we merge this one and we listen the Commonalities version in case we need to reintroduce it?

@bigludo7
Fix @location_retrieval_15_device_token_mismatch Test
47745d8 
fix @location_retrieval_15_device_token_mismatch to use 422 Unnecessary identifier instead of 403 access token mistmatch.
@bigludo7 bigludo7 requested review from jlurien and maxl2287 January 15, 2025 16:07
@bigludo7
Copy link
Collaborator Author

@jlurien & @maxl2287 403 INVALID_TOKEN_CONTEXT example removed & Test Case aligned accordingly.

@bigludo7
Copy link
Collaborator Author

@jlurien @maxl2287 Aligned with José work in #281

  • Applied the fixon the note about networkAccessIdentifier support
  • Removed 401 AUTHENTICATION_REQUIRED (403 INVALID_TOKEN_CONTEXT was already removed)
  • Updated the test plan.

maxl2287
maxl2287 previously approved these changes Jan 17, 2025
View reviewed changes
Copy link
Contributor

@maxl2287 maxl2287 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@maxl2287
Copy link
Contributor

@jlurien can we merge it from your side as well with an approve? :)

jlurien
jlurien reviewed Jan 22, 2025
View reviewed changes
Copy link
Collaborator

@jlurien jlurien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In location-verification PR, I copied from the artifact in Commonalities, the scenarios under

Error scenarios for management of input parameter device

_C01.XX series, and removed the old ones. This way is easier to maintain whatever is changed in the common artifact.

The rest LGTM

code/Test_definitions/location-retrieval.feature
@@ -140,7 +140,7 @@ Feature: CAMARA Device location retrieval API, v0.3.0 - Operation retrieveLocati
When the HTTP "POST" request is sent
Then the response status code is 422
And the response property "$.status" is 422
And the response property "$.code" is "UNSUPPORTED_DEVICE_IDENTIFIERS"
And the response property "$.code" is "UNSUPPORTED_IDENTIFIERS"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update lines 1 and 15 to vwip

jlurien
jlurien approved these changes Jan 22, 2025
View reviewed changes
Copy link
Collaborator

@jlurien jlurien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@maxl2287 maxl2287 self-requested a review January 22, 2025 12:46
@bigludo7 bigludo7 merged commit 22aec15 into main Jan 22, 2025
2 checks passed
@bigludo7 bigludo7 deleted the location-retrieval-alignement-spring25 branch January 22, 2025 13:04
@maxl2287 maxl2287 mentioned this pull request Jan 23, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maxl2287 maxl2287 maxl2287 approved these changes

@jlurien jlurien jlurien approved these changes

Assignees

@bigludo7 bigludo7

Labels
Spring25
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Error Alignement with Commonalities
3 participants
@bigludo7 @maxl2287 @jlurien