Skip to content
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

Merged
merged 4 commits into from
Dec 19, 2024
Merged

Documentation updates #1612

merged 4 commits into from
Dec 19, 2024

Conversation

ardatan
Copy link
Collaborator

@ardatan ardatan commented Dec 18, 2024

Mention error extensions
Copy link

changeset-bot bot commented Dec 18, 2024

⚠️ No Changeset found

Latest commit: 9685c3c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

github-actions bot commented Dec 18, 2024

💻 Website Preview

The latest changes are available as preview in: https://aab9acd5.sofa.pages.dev

@@ -21,3 +21,26 @@ api.use(
})
);
```

Copy link
Owner

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?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about now?

Copy link
Owner

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

Copy link
Collaborator Author

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.

@Urigo
Copy link
Owner

Urigo commented Dec 18, 2024

maybe also add error handling to the example on the repo?

@ardatan
Copy link
Collaborator Author

ardatan commented Dec 18, 2024

Done @Urigo 👍

@Urigo
Copy link
Owner

Urigo commented Dec 18, 2024

what about partial queries?
like, in case some resolvers are ok and some fire an error?

@ardatan
Copy link
Collaborator Author

ardatan commented Dec 19, 2024

@Urigo I added an example with more details and showing the partially failed response. Let me know what do you think?

@ardatan ardatan changed the title Update Error Handling in SOFA Documentation updates Dec 19, 2024
@ardatan ardatan requested a review from Urigo December 19, 2024 13:19
@ardatan
Copy link
Collaborator Author

ardatan commented Dec 19, 2024

I added a link to SOFA docs @Urigo . What do you think?

Copy link
Owner

@Urigo Urigo left a 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!

@ardatan ardatan merged commit 5daf648 into master Dec 19, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants