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

Glossary: add "error" and "field error" #1597

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

martinbonnin
Copy link
Contributor

Add error and field error to the Glossary.

I contemplated the possibility to include internal error as well but TBH I'm not sure I understand the nuance between error and internal error.

rfcs/glossary/Appendix C -- Glossary.md Outdated Show resolved Hide resolved
Comment on lines +183 to +185
### (GraphQL) field error

**Definition**: A field error is an error raised during the execution of a particular field which results in partial response data. This may occur due to an internal error during value resolution or failure to coerce the resulting value.
Copy link
Member

Choose a reason for hiding this comment

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

When the spec itself already includes an explicit hyperlinked definition for a term, is it necessary to duplicate it in the appendix manually?

I think many of the definitions in this appendix can be (and have been) migrated to the spec via :: definitions. Perhaps working on a spec-md feature that lists all the definitions as part of the output would be a good idea.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think many of the definitions in this appendix can be (and have been) migrated to the spec via :: definitions.

100% agree. No need to manually maintain 2 source of truth. I forgot we had the :: definitions.

I still see the Glossary as a good "incubating" place to discuss the terminology and allow PRs to be discussed/merged more easily while they make their way to something more official.

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