Clarify that the DeviceResponse schema is not mandatory #490
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eric-murray
requested review from
PedroDiez,
jlurien,
patrice-conil,
rartych and
shilpa-padgaonkar
as code owners
rartych
approved these changes
Jul 23, 2025
This was referenced Aug 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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:
The Design Guide states that the
DeviceResponseschema should be used to disambiguate which device identifier is being used by an implementation when an API consumer has provided more than one identifier, but it does not mandate it. Nor should it, as there will be APIs for which it is not appropriate. If it is used by an API, however, then it becomes mandatory to provide a single device identifier in the response when multiple are provided in the response.This PR clarifies that:
DeviceResponseschema is not mandatory for an APIWhich issue(s) this PR fixes:
Fixes #489
Does this PR introduce a breaking change?
Special notes for reviewers:
None
Changelog input
Additional documentation
None