Fix misleading and misspelled property/metadata key descriptions#1109
Open
blankse wants to merge 4 commits into
Open
Fix misleading and misspelled property/metadata key descriptions#1109blankse wants to merge 4 commits into
blankse wants to merge 4 commits into
Conversation
The 'keys' argument is a listOf(string) and the resolver matches via in_array(), so it expects an array of key names, not a comma-separated string. Corrected the description text (and the 'seperated' typo) across all GraphQL types. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
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
2 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.
The
keysargument onproperties/hotspotdatafields is defined asType::listOf(Type::string())and the resolvers match viain_array($name, $args['keys'])— so the API expects an array of key names, not a comma-separated string.The descriptions claimed "comma separated list of key names" (several with the typo "seperated"), which is both misleading and inconsistent. This corrects the wording across all affected GraphQL types:
propertiesfields → "List of property key names to include (if omitted, all properties are returned)."data(metadata) fields → "List of metadata key names to include (if omitted, all entries are returned)."Follow-up to the same issue spotted by Copilot in #1001 (which covers
DocumentFolderType).🤖 Generated with Claude Code