Update OAS and test definitions to remove IDENTIFIER_MISMATCH error code #52
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What this PR does / why we need it:
Commonalities has removed the
IDENTIFIER_MISMATCHerror for Fall25. Instead, a device identifier should not normally be included in responses. It should only be included to disambiguate the identity of the device when:The response then includes the device identifier that was used by the implementation
This PR:
DeviceResponseobject for the device-data-volume API to limit device identifiers in responses to exactly oneIDENTIFIER_MISMATCHerror code option from 422 responsesNote; For subscriptions, the
CreateSubscriptionDetailschema is used in both requests and responses, so modifying the responses to use theDeviceResponsewould require a general update of the subscription schema in Commonalities. For the moment, the existing schema is left unmodified, which means that multiple device identifiers could be provided in responses, but should not.Which issue(s) this PR fixes:
Fixes #50
Special notes for reviewers:
I think both GET endpoints should never return a device identifier in the responses, but haven't thought through all possible scenarios, so will raise this as a separate issue.
Changelog input
Additional documentation
None