-
-
Notifications
You must be signed in to change notification settings - Fork 43
Created TaggedInputObject #1226
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
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
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 is a feature currently under consideration to be included in the GraphQL spec: graphql/graphql-spec#733, and already implemented for the GraphQL API for WordPress.
The Tagged Input Object introduces a form of polymorphism for inputs in GraphQL. It defines a list of named members each with an associated type (like the fields in Object types and Input Object types), where exactly one of those members must be provided as an input when resolving the query (or otherwise it returns a validation error).
The benefit is that a single mutation field can be used to tackle different use cases, so we can avoid creating a different mutation field for each use case.
For instance, the field
Root.loginUser
now receives a field argumentcredentials
, which is a tagged input object allowing to provide several methods to log into the website. Currently it accepts only 1 method, via the named memberwebsite
(which accepts theusernameOrEmail
andpassword
entries), and other methods can be added in the future (such asjwt
andapplicationPasswords
):This way,
loginUser
can tackle all methods of logging the user, which makes the GraphQL schema leaner and more elegant (otherwise, we would need fieldsloginUserByWebsiteData
,loginUserByJWT
andloginUserByApplicationPassword
).