Glossary: add "error" and "field error"#1597
Conversation
| ### (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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
I have added a few links to redirect to the official spec when possible. Turns out, a lot of this glossary is also present in the spec but the glossary includes more information. In "request" for an example, there is mention of HTTP and I think it helps the overall understanding.
2 participants
Add
errorandfield errorto the Glossary.I contemplated the possibility to include
internal erroras well but TBH I'm not sure I understand the nuance betweenerrorandinternal error.