Add support for custom operation-level examples for queries and mutations #1058
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
- add support for normalizing different example formats in pre-process - implement getOperationExamples function to extract custom examples - handle OBJECT and alternative example formats from metadata - add fallback to auto-generation when no custom examples exist - modify pre-process to use first custom example or generate automatically - support multiple examples with first example used for display - maintain backwards compatibility with existing metadata structures
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.
This PR adds support for custom operation-level examples for GraphQL queries and mutations in metadata files. Previously, SpectaQL would ignore custom examples provided in metadata and generate auto-examples with placeholder values instead.
Fixes #1048
Key Changes
Supported Formats
The implementation prioritizes custom examples when available, and falls back to auto-generation when not provided, maintaining backward compatibility.
All tests pass.