Fix misleading documentation for List Connections config field#77
Closed
runleonarun wants to merge 1 commit intomasterfrom
Closed
Fix misleading documentation for List Connections config field#77runleonarun wants to merge 1 commit intomasterfrom
runleonarun wants to merge 1 commit intomasterfrom
Conversation
The config field in the List Account Connections endpoint was documented as "(only included when annotated)" which was confusing and misleading. In reality, this field is always null in list responses for performance reasons. Updated the description to: - Clarify that config is always null in list responses - Direct users to the Retrieve Account Connection endpoint to get config - Added nullable: true to properly indicate the field will be null This resolves confusion reported by customers (e.g., Fivetran/Dexcom) who expected the config field to be returned when using query params like include_related or adapter_version. Refs: ZD-114337
Contributor
Author
|
Closing in favor of opening an PR in code source! |
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
1 participant
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.
The config field in the List Account Connections endpoint was documented as "(only included when annotated)" which was confusing and misleading. In reality, this field is always null in list responses for performance reasons.
Updated the description to:
This resolves confusion reported by customers (e.g., Fivetran/Dexcom) who expected the config field to be returned when using query params like include_related or adapter_version.