Skip to content

Update Device object handling and description#87

Merged
eric-murray merged 16 commits intocamaraproject:mainfrom
eric-murray:eric-murray-patch-1
Jan 15, 2025
Merged

Update Device object handling and description#87
eric-murray merged 16 commits intocamaraproject:mainfrom
eric-murray:eric-murray-patch-1

Conversation

@eric-murray
Copy link
Collaborator

@eric-murray eric-murray commented Dec 5, 2024

What type of PR is this?

  • enhancement/feature
  • documentation

What this PR does / why we need it:

Other APIs passing a Device object do this by passing a separate parameter named device, even if that is the only object passed in the request. This PR:

  • Updates the Device Identifier API to use this pattern
  • Updates documentation on identifying the device from the access token following the current agreement in Commonalities
  • Updates the API error responses following the current agreement in Commonalities
  • Removes 406, and 5XX errors from the OAS definition, as these errors do not need to be explicitly documented and are not relevant to the API use case

Which issue(s) this PR fixes:

Fixes # N/A

Special notes for reviewers:

None

Changelog input

 release-note
 - Update Device object handling and description
 - Remove errors not required to be documented
 - Update examples for remaining errors

Additional documentation

None

@eric-murray eric-murray requested a review from Kevsy as a code owner December 5, 2024 21:56
Copy link
Collaborator

@Kevsy Kevsy left a comment

Choose a reason for hiding this comment

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

Added suggestions inline to match the latest common.yaml changes for the error names/descriptions

eric-murray and others added 3 commits January 2, 2025 21:04
Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
Co-authored-by: Kevin Smith <Kevsy@users.noreply.github.com>
@eric-murray
Copy link
Collaborator Author

M3 date is 17th January, so this PR needs to be approved and merged before then so that I can create the release candidate.

So, please add any comments you may have before next Wednesday 15th January. Thanks.

@eric-murray eric-murray added the Spring'25 Issues / PRs for Spring '25 Meta-Release label Jan 10, 2025
@AxelNennker
Copy link
Collaborator

I deleted my comment/suggestion on error handling. Maybe the API Design Guidelines could be clarified. I wanted to make clear that if a valid three-legged access token is used but still the subject cannot be identified then that is a server error (500) of the authorization server. But that is not a topic of this PR.

@eric-murray eric-murray merged commit d788517 into camaraproject:main Jan 15, 2025
1 check passed
@eric-murray eric-murray deleted the eric-murray-patch-1 branch January 15, 2025 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Spring'25 Issues / PRs for Spring '25 Meta-Release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants