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 Error handling #111

Open
AccsoSG opened this issue Sep 22, 2022 · 1 comment
Open

Documentation Error handling #111

AccsoSG opened this issue Sep 22, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@AccsoSG
Copy link

AccsoSG commented Sep 22, 2022

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

  • Neo4jGraphQLForbiddenError
  • Neo4jGraphQLAuthenticationError
  • Neo4jGraphQLConstraintValidationError
  • Neo4jGraphQLCypherBuilderError
  • Neo4jGraphQLRelationshipValidationError

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
Copy link
Contributor

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.

@MacondoExpress MacondoExpress added the documentation Improvements or additions to documentation label Sep 22, 2022
@darrellwarde darrellwarde transferred this issue from neo4j/graphql Feb 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants