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

Improve validation of mappings in GraphQL app definition #472

Open
ujibang opened this issue Aug 2, 2023 · 0 comments
Open

Improve validation of mappings in GraphQL app definition #472

ujibang opened this issue Aug 2, 2023 · 0 comments
Assignees
Milestone

Comments

@ujibang
Copy link
Contributor

ujibang commented Aug 2, 2023

Brief overview

Improve the validation of mappings in GraphQL app definition to improve the developer experience.

Example of possibile improvements are:

  • Name of the GraphQL field of a mapping is not validated which makes debugging any problems with missing data when querying during development very time-consuming.
    Example: If data is missing when querying, it is currently hard to tell if there is a typo in a GraphQL field mapping (i.e., the field simply isn't mapped) or if the underlying document data is missing.
  • Name/path of the document field of a mapping is not validated which also makes debugging any problems with data fetching very time-consuming.
    Example: If data is missing when querying, it is currently hard to tell if there is a typo in the name/path of the document field or if the underlying document data is missing.

Perform some basic validation when the gql-app definition is created and either reject the request completely or at least include some warnings in the response.

Rationale

Improve the developer experience

Detailed documentation

TBD

@ujibang ujibang added this to the 7.6 milestone Aug 2, 2023
@ujibang ujibang self-assigned this Aug 2, 2023
@ujibang ujibang modified the milestones: 7.6, 7.7 Sep 11, 2023
@ujibang ujibang modified the milestones: 7.6, 8.0 Dec 15, 2023
@ujibang ujibang modified the milestones: 8.0, 8.1 Apr 17, 2024
@ujibang ujibang modified the milestones: 8.1, 8.2 Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant