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.

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

Update error responses and test cases to comply with Commonalities 0.5.0 #391

Merged
merged 60 commits into from
Jan 17, 2025

Conversation

eric-murray
Copy link
Collaborator

@eric-murray eric-murray commented Jan 10, 2025

What type of PR is this?

  • correction

What this PR does / why we need it:

Commonalities 0.5.0-alpha.1 updates the error response codes associated with device handling.

This PR:

  • Updates the error response codes and schemas as necessary in the OAS definitions
  • Updates the test cases as necessary
  • Removes the 403 INVALID_TOKEN_CONTEXT error from the OAS definitions
  • Removes all 5XX errors as these no longer require to be explicitly documented
  • Updates info.description text on device object handling in each OAS definition
  • Ensures date-time examples are enclosed by quotation marks

Which issue(s) this PR fixes:

Fixes #390, #392, #389, #394

Special notes for reviewers:

None

Changelog input

 release-note
 - Updates the error response codes and schemas as necessary in the OAS definitions
 - Updates the test cases as necessary
 - Removes the `403 INVALID_TOKEN_CONTEXT` error from the OAS definitions
 - Removes all 5XX errors as these no longer require to be explicitly documented
 - Updates `info.description` text on device object handling in each OAS definition
 - Ensures `date-time` examples are enclosed by quotation marks

Additional documentation

None

Copy link
Collaborator

@RandyLevensalor RandyLevensalor left a comment

Choose a reason for hiding this comment

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

LGTM - Thanks @eric-murray

Copy link
Collaborator

@hdamker hdamker left a comment

Choose a reason for hiding this comment

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

further changes looking good as well, thanks for taking also #394

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.

Let's see if 401 AUTHENTICATION_REQUIRED is also deprecated. But we can create a new PR for the latest changes in Commonalities

@hdamker
Copy link
Collaborator

hdamker commented Jan 17, 2025

@eric-murray Ready to merge here ... further changes coming from Commonalities (in their release candidate) can go into a new PR.

@eric-murray eric-murray merged commit 977fab7 into camaraproject:main Jan 17, 2025
2 checks passed
@eric-murray eric-murray deleted the eric-murray-patch-1 branch January 17, 2025 14:54
@eric-murray
Copy link
Collaborator Author

OK, now merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Spring25 Issue in scope of Spring25 meta-release cycle
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update error codes in API definitions and test cases
5 participants