neo4j / docs-graphql

GraphQL docs
5 stars 9 forks source link

Documentation Error handling #111

Open AccsoSG opened 2 years ago

AccsoSG commented 2 years ago

I searched the documentation for which erros are currently being thrown by neo4j/graphql, and under what circumstances. Unfortunately, there is currently no documentation for this.

I found the following errors in the code:

Neo4jGraphQLError

Most of these are actually self-explanatory, but what is the Neo4jGraphQLRelationshipValidationError for, for example?. Under what circumstances is this error triggered? How should this error be handled?

MacondoExpress commented 2 years ago

Hi @AccsoSG , This is valuable feedback, thank you for opening it, We recognize that our documentation and our error messages are far from perfect, and for this reason, we have planned to do some work around it. For the specific case of Neo4jGraphQLRelationshipValidationError, this happens when the cardinality of a relationship described in the GraphQL Schema differs from the related cardinality present in the Neo4j instance.