-
Notifications
You must be signed in to change notification settings - Fork 89
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
Documentation updates #1612
Documentation updates #1612
Conversation
Mention error extensions
|
💻 Website PreviewThe latest changes are available as preview in: https://aab9acd5.sofa.pages.dev |
@@ -21,3 +21,26 @@ api.use( | |||
}) | |||
); | |||
``` | |||
|
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.
that's nice
can you also on the top section show an example of the default response response that you'll get if you don't add anything and there is an error?
and also for each example - can you also show the actual full response that would be sent?
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.
How about now?
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.
nice!
I would also add the full json itself, easier to read
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 added more details including the expected response fully.
maybe also add error handling to the example on the repo? |
Done @Urigo 👍 |
what about partial queries? |
@Urigo I added an example with more details and showing the partially failed response. Let me know what do you think? |
I added a link to SOFA docs @Urigo . What do you think? |
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.
@ardatan this is some high level PR and documentation!
Super impressive!
Mention error extensions handling as we do in Yoga
https://the-guild.dev/graphql/yoga-server/docs/features/error-masking#modifying-http-status-codes-and-headers
Related dotansimha/graphql-yoga#3559 (review)
Mention how to extend OpenAPI document
dotansimha/graphql-yoga#2015 (reply in thread)