cube-js/cube

Facilitate comments in GraphQL schema generation flow

Open

#6,246 opened on Mar 6, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (19,563 stars) (1,965 forks)batch import
api:graphqlhelp wanted

Description

Is your feature request related to a problem? Please describe. The GraphQL schema that is generated has no comments/documentation. It does not suit inclusion into a well documented federated graph.

Describe the solution you'd like A way to annotate dimensions such that the generated GraphQL types have some degree of documentation.

Describe alternatives you've considered Manual documentation post-generation. It does not suit our needs as we scale up

Contributor guide

Tech stack
graphqlrust
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
GraphQL fundamentalsCube schema generation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the current GraphQL schema generation code in the Cube codebase, likely in the cube backend module. Identify where dimensions are mapped to GraphQL types. Explore how to add comments or descriptions to these types, potentially via a new dimension annotation or configuration option. Check existing tests for schema generation to understand expected behavior.