Update Device object handling and description #87
Conversation
This file contains 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
This was referenced Dec 6, 2024
Kevsy
reviewed
Dec 20, 2024
| value: | ||
| status: 404 | ||
| code: NOT_FOUND | ||
| message: The specified resource is not found. | ||
| GENERIC_404_DEVICE_NOT_FOUND: | ||
| description: Device identifier not found |
There was a problem hiding this comment.
Suggested change
| description: Device identifier not found | |
| description: Some identifier cannot be matched to a device | |
Kevsy
reviewed
Dec 20, 2024
| code: DEVICE_NOT_FOUND | ||
| message: Device identifier not found. | ||
| code: IDENTIFIER_NOT_FOUND | ||
| message: The supplied device identifier cannot be matched to a device. |
There was a problem hiding this comment.
Suggested change
| message: The supplied device identifier cannot be matched to a device. | |
| message: Device identifier not found. | |
Kevsy
reviewed
Dec 20, 2024
| @@ -437,18 +438,34 @@ components: | |||
| schema: | |||
| $ref: "#/components/schemas/ErrorResponse" | |||
| examples: | |||
| GENERIC_422_DEVICE_IDENTIFIERS_MISMATCH: | |||
| description: Inconsistency between device identifiers not pointing to the same device | |||
| DeviceIdentifiersMismatch: | |||
There was a problem hiding this comment.
Suggested change
| DeviceIdentifiersMismatch: | |
| GENERIC_422_IDENTIFIER_MISMATCH: | |
Kevsy
reviewed
Dec 20, 2024
| GENERIC_422_DEVICE_IDENTIFIERS_MISMATCH: | ||
| description: Inconsistency between device identifiers not pointing to the same device | ||
| DeviceIdentifiersMismatch: | ||
| description: Inconsistency between device identifiers not identifying the same device |
There was a problem hiding this comment.
Suggested change
| description: Inconsistency between device identifiers not identifying the same device | |
| description: Inconsistency between identifiers not pointing to the same device | |
Kevsy
reviewed
Dec 20, 2024
| value: | ||
| status: 404 | ||
| code: NOT_FOUND | ||
| message: The specified resource is not found. | ||
| GENERIC_404_DEVICE_NOT_FOUND: |
There was a problem hiding this comment.
Suggested change
| GENERIC_404_DEVICE_NOT_FOUND: | |
| GENERIC_404_IDENTIFIER_NOT_FOUND: | |
Kevsy
reviewed
Dec 20, 2024
| value: | ||
| status: 422 | ||
| code: DEVICE_IDENTIFIERS_MISMATCH | ||
| code: IDENTIFIER_MISMATCH | ||
| message: Provided device identifiers are not consistent. |
There was a problem hiding this comment.
Suggested change
| message: Provided device identifiers are not consistent. | |
| message: Provided identifiers are not consistent. | |
Kevsy
reviewed
Dec 20, 2024
| message: Provided device identifiers are not consistent. | ||
| GENERIC_422_DEVICE_NOT_APPLICABLE: | ||
| description: Service is not available for the provided device | ||
| ServiceNotApplicableForDevice: |
There was a problem hiding this comment.
Suggested change
| ServiceNotApplicableForDevice: | |
| GENERIC_422_SERVICE_NOT_APPLICABLE: | |
Kevsy
reviewed
Dec 20, 2024
| GENERIC_422_DEVICE_NOT_APPLICABLE: | ||
| description: Service is not available for the provided device | ||
| ServiceNotApplicableForDevice: | ||
| description: Service is not available for the identified device |
There was a problem hiding this comment.
Suggested change
| description: Service is not available for the identified device | |
| description: Service not applicable for the provided identifier | |
Kevsy
reviewed
Dec 20, 2024
| code: SERVICE_NOT_APPLICABLE | ||
| message: The service is not applicable to the identified device. | ||
| UnsupportedDeviceIdentifier: | ||
| description: Service is not available for the identified device |
There was a problem hiding this comment.
Suggested change
| description: Service is not available for the identified device | |
| description: The service is not available for the provided identifier. | |
Kevsy
reviewed
Dec 20, 2024
| status: 422 | ||
| code: SERVICE_NOT_APPLICABLE | ||
| message: The service is not applicable to the identified device. | ||
| UnsupportedDeviceIdentifier: |
There was a problem hiding this comment.
Suggested change
| UnsupportedDeviceIdentifier: | |
| GENERIC_422_UNSUPPORTED_IDENTIFIER: | |
Kevsy
reviewed
Dec 20, 2024
| value: | ||
| status: 422 | ||
| code: UNSUPPORTED_IDENTIFIER | ||
| message: None of the provided device identifiers is supported by the implementation. |
There was a problem hiding this comment.
Suggested change
| message: None of the provided device identifiers is supported by the implementation. | |
| message: None of the provided identifiers is supported by the implementation. | |
Kevsy
reviewed
Dec 20, 2024
| status: 422 | ||
| code: UNSUPPORTED_IDENTIFIER | ||
| message: None of the provided device identifiers is supported by the implementation. | ||
| UnnecessaryDeviceIdentifier: |
There was a problem hiding this comment.
Suggested change
| UnnecessaryDeviceIdentifier: | |
| GENERIC_422_UNNECESSARY_IDENTIFIER: | |
Kevsy
reviewed
Dec 20, 2024
| value: | ||
| status: 422 | ||
| code: UNNECESSARY_IDENTIFIER | ||
| message: The device is already identified by the access token |
There was a problem hiding this comment.
Suggested change
| message: The device is already identified by the access token | |
| message: An explicit identifier is provided when a device or phone number has already been identified from the access token |
Kevsy
reviewed
Dec 20, 2024
| status: 422 | ||
| code: UNNECESSARY_IDENTIFIER | ||
| message: The device is already identified by the access token | ||
| MissingIdentifier: |
There was a problem hiding this comment.
Suggested change
| MissingIdentifier: | |
| GENERIC_422_MISSING_IDENTIFIER: | |
Kevsy
reviewed
Dec 20, 2024
| code: DEVICE_NOT_APPLICABLE | ||
| message: The service is not available for the provided device. | ||
| code: MISSING_IDENTIFIER | ||
| message: The device cannot be identified |
There was a problem hiding this comment.
Suggested change
| message: The device cannot be identified | |
| message: An identifier is not included in the request and the device or phone number identification cannot be derived from the 3-legged access token | |
Kevsy
reviewed
Dec 20, 2024
| code: DEVICE_NOT_APPLICABLE | ||
| message: The service is not available for the provided device. | ||
| code: MISSING_IDENTIFIER | ||
| message: The device cannot be identified | ||
|
|
||
| 429TooManyRequests: |
There was a problem hiding this comment.
Suggested change
| 429TooManyRequests: | |
| Generic429: | |
Kevsy
requested changes
Dec 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
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:Which issue(s) this PR fixes:
Fixes # N/A
Special notes for reviewers:
None
Changelog input
Additional documentation
None