Add a @GraphQLIgnore annotation allowing field parameters to be ignored/excluded from a schema
#299
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
excluded from a schema.
mattjquinn
changed the title
@GraphQLIgnore annotation allowing field parameters to be ignored/excluded from a schema
tdraier
approved these changes
Dec 12, 2023
github-merge-queue bot
referenced
this pull request
in camunda/camunda
May 2, 2024
…ns to v21.2 (main) (#18186) [](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [io.github.graphql-java:graphql-java-annotations](https://github.com/graphql-java/graphql-java-annotations) | `21.1` -> `21.2` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>graphql-java/graphql-java-annotations (io.github.graphql-java:graphql-java-annotations)</summary> ### [`v21.2`](https://github.com/Enigmatis/graphql-java-annotations/releases/tag/v21.2) [Compare Source](https://github.com/graphql-java/graphql-java-annotations/compare/v21.1...v21.2) #### What's Changed - Upgrade graphql-java version to 21.2 by [@​geichelberger](https://github.com/geichelberger) in [https://github.com/Enigmatis/graphql-java-annotations/pull/297](https://github.com/Enigmatis/graphql-java-annotations/pull/297) - Support for inherited interfaces ([#​65](https://github.com/graphql-java/graphql-java-annotations/issues/65)) by [@​richharms](https://github.com/richharms) in [https://github.com/Enigmatis/graphql-java-annotations/pull/298](https://github.com/Enigmatis/graphql-java-annotations/pull/298) - Add a `@GraphQLIgnore` annotation allowing field parameters to be ignored/excluded from a schema by [@​mattjquinn](https://github.com/mattjquinn) in [https://github.com/Enigmatis/graphql-java-annotations/pull/299](https://github.com/Enigmatis/graphql-java-annotations/pull/299) #### New Contributors - [@​mattjquinn](https://github.com/mattjquinn) made their first contribution in [https://github.com/Enigmatis/graphql-java-annotations/pull/299](https://github.com/Enigmatis/graphql-java-annotations/pull/299) **Full Changelog**: Enigmatis/graphql-java-annotations@v21.1...v21.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/camunda/zeebe). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMzEuMCIsInVwZGF0ZWRJblZlciI6IjM3LjMzMS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJhdXRvbWVyZ2UiXX0=-->
](https://renovatebot.com){kind=link}
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 will enhance type safety in situations where the schema is built using
grapqhl-javaandgraphql-java-annotations, then provided to a different library (e.g.graphql-spring) for execution.Currently, oftentimes the runtime implementation of a schema (resolvers, controllers, etc.) can't implement some of the interfaces defining the schema, as the former requires runtime-specific arguments (context, environment, etc.). This means that an interface can change, and the schema will change as a result upon regeneration from the interfaces, but forgetting to change the runtime implementation won't be caught statically at compile-time, leading to eventual runtime errors.
With this change, interfaces can be modified to include those runtime-specific parameters, tagging them with
@GraphQLIgnore, so that runtime classes can implement them.