-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Schema Coordinates #794
Open
magicmark
wants to merge
20
commits into
graphql:main
Choose a base branch
from
magicmark:schema_coordinates_spec_edit
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Schema Coordinates #794
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
cb24f17
Add Schema Coordinates RFC
magicmark 99474ad
Update schema coordinates spec edit
magicmark bb3098c
implement PR suggestions
magicmark ac5318f
Tweak example table wording
magicmark c56e2dd
Apply suggestions from code review
magicmark 5b18981
enumName -> enumValueName
magicmark 641a15b
- Add PR feedback
magicmark 2d06a79
Update Section 3 -- Type System.md
magicmark 0e1aa3d
Editorial on grammar and semantics
leebyron b1ab1b0
Move section
leebyron 9eb52da
Simplify examples
leebyron 82edbeb
standalone
leebyron 1f5668b
update numbers
leebyron 7a017fe
clarify element
leebyron 9673f8c
Update Punctuator grammar
leebyron a705593
specify schema element
leebyron 2992dc7
fix example
leebyron 1fcbbe5
clarify metafields
leebyron 4666032
Better Punctator
leebyron e6f7939
Minor algo variable name refinements
leebyron File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this section should also specify the behaviour for Union types.
At the moment the spec does not define the behaviour for
Union.UnionTypeMember
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps I'm misunderstanding your question, but to clarify:
The definition for this would live somewhere else in the schema, outside of the context of the union. You would write the schema coordinate to that instead.
i.e.
Union.UnionTypeMember
is not a valid schema coordinate.The rule of thumb is: there should only be one way to reference a thing with Schema Coordinates
Is there still some ambiguity in this spec?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@magicmark Makes sense to me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@leebyron is it worth keeping in the clarification (or something similar) from a previous commit?
https://github.com/magicmark/graphql-spec/blob/ac5318f9a9f04d0f8dd03d3758d5ca2654f7f7d7/spec/Section%203%20--%20Type%20System.md?plain=1#L391-L399
My gut says this may crop up again and cause some confusion - worth the counter example?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just chiming in. From my perspective the counter example would be ideal (maybe even clarify that directives on types are also invalid?).
Maybe add a line on why union members are not valid schema coordinates, instead of solely stating that they are not?
...or something along those lines
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fwiw this is all sort of encapsulated by the following line the spec:
++ for the explainer, I would maybe try and reuse this language (e.g. "as stated above, each schema element...."), or hyperlink back to this source of truth somehow