chore: clarify drawbacks of introspection publish #866
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
docs/source/graphs.md
Outdated
| @@ -89,6 +89,8 @@ If your schema isn't stored in a compatible file, you can provide `-` as the val | |||
| rover graph introspect http://localhost:4000 | rover graph publish my-graph@dev --schema - | |||
| ``` | |||
|
|
|||
| We recommend publishing a `.graphql` file directly over publishing from introspection because introspection will strip comments and most directive usages. | |||
There was a problem hiding this comment.
"Whenever possible, we recommend publishing a .graphql file directly instead of using introspection. An introspection result omits schema comments and most uses of directives."
StephenBarlow
approved these changes
Oct 7, 2021
EverlastingBugstopper
force-pushed
the
avery/clarify-introspection-publish
branch
from
9c49b07 to
5771920
Compare
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.
publishing via introspection is a bit more lossy than publishing SDL directly