docs: update renamed deviceauthn fields references#2692
Open
pcaillaudm wants to merge 2 commits into
Open
Conversation
Contributor
|
Isn't renaming fields in the API something that can break customer code? Have we added a note or given some heads up beyond updating the docs? |
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
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.
This PR updates the device authentication (
deviceauthn) documentation to match the renamed settings-flow API fields.Changes:
addpayload field is renamed todeviceauthn_register, and the SDKmodel
UpdateSettingsFlowWithDeviceAuthnMethodAddis nowUpdateSettingsFlowWithDeviceAuthnMethodRegister(method.add→method.deviceauthnRegister).deleteobject with a nestedclient_key_idis replaced by a flatdeviceauthn_removestring field, removing the need for theUpdateSettingsFlowWithDeviceAuthnMethodDeletewrapper in the SDKs.version: 1field,aligning them with the payload reference in the overview page.
All JSON payloads, Kotlin/Swift SDK snippets, and prose references to the old field names
were updated accordingly.