Write about @oneOf in the graphql-js documentation
#4290
Merged
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
|
Hi @JoviDeCroock, I'm @github-actions bot happy to help you with this PR 👋 Supported commandsPlease post this commands in separate comments and only one per comment:
|
JoviDeCroock
changed the title
@oneOf@oneOf in the graphql-js documentation
benjie
previously requested changes
Nov 8, 2024
website/pages/input-unions.mdx
Outdated
| @@ -0,0 +1,72 @@ | |||
| --- | |||
| title: Input Unions | |||
There was a problem hiding this comment.
@oneOf is not equivalent to "input union". You can use it to form an input union, but its use is broader than that. I would title it "OneOf input objects" or similar.
(Example: input UserSpecifier @oneOf { databaseId: Int, username: String, hospitalNumber: Int } - note that both databaseId and hospitalNumber are Int and can uniquely identify a user in different ways - so this isn't simply a union.)
There was a problem hiding this comment.
My hesitancy was mainly that it's less of a clickthrough as the name is opaque to people while a general known word helps. I do agree that they are not the same
There was a problem hiding this comment.
I agree; perhaps the URL would be oneof and the title would be "OneOf and input unions" or similar?
JoviDeCroock
force-pushed
the
input-unions
branch
from
aa90b7d to
a2658fa
Compare
JoviDeCroock
force-pushed
the
input-unions
branch
from
a2658fa to
b691508
Compare
JoviDeCroock
force-pushed
the
input-unions
branch
from
b691508 to
d96b462
Compare
|
The SDL changes need reflection in the code version I think? |
JoviDeCroock
force-pushed
the
input-unions
branch
from
d96b462 to
34a6ed7
Compare
Co-authored-by: Benjie <benjie@jemjie.com>
yaacovCR
pushed a commit
to yaacovCR/graphql-js
that referenced
this pull request
Nov 26, 2024
Currently input-unions and by extension the `@oneOf` directive aren't present in the documentation. I have opted to put this into the advanced section. The copy might be up for improvement, honestly fire away if there's more cases to cover, just wanted to get the ball rolling here. CC @benjie --------- Co-authored-by: Benjie <benjie@jemjie.com>
yaacovCR
pushed a commit
to yaacovCR/graphql-js
that referenced
this pull request
Dec 3, 2024
Currently input-unions and by extension the `@oneOf` directive aren't present in the documentation. I have opted to put this into the advanced section. The copy might be up for improvement, honestly fire away if there's more cases to cover, just wanted to get the ball rolling here. CC @benjie --------- Co-authored-by: Benjie <benjie@jemjie.com>
yaacovCR
pushed a commit
to yaacovCR/graphql-js
that referenced
this pull request
Dec 3, 2024
Currently input-unions and by extension the `@oneOf` directive aren't present in the documentation. I have opted to put this into the advanced section. The copy might be up for improvement, honestly fire away if there's more cases to cover, just wanted to get the ball rolling here. CC @benjie --------- Co-authored-by: Benjie <benjie@jemjie.com>
yaacovCR
pushed a commit
to yaacovCR/graphql-js
that referenced
this pull request
Dec 3, 2024
Currently input-unions and by extension the `@oneOf` directive aren't present in the documentation. I have opted to put this into the advanced section. The copy might be up for improvement, honestly fire away if there's more cases to cover, just wanted to get the ball rolling here. CC @benjie --------- Co-authored-by: Benjie <benjie@jemjie.com>
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.
Currently input-unions and by extension the
@oneOfdirective aren't present in the documentation. I have opted to put this into the advanced section. The copy might be up for improvement, honestly fire away if there's more cases to cover, just wanted to get the ball rolling here.CC @benjie