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 (1,965 forks)batch import
api:graphqlhelp wanted

Repository metrics

Stars
 (19,563 stars)
PR merge metrics
 (Avg merge 5d 16h) (138 merged PRs in 30d)

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

Research direction
Investigate how Cube generates GraphQL schema and identify where to add comments for dimensions and measures. Look at the schema generation code and find a way to pass documentation annotations from the Cube data model to the GraphQL schema definitions.
Tech stack
graphql
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GraphQL
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60