cube-js/cube

Facilitate comments in GraphQL schema generation flow

Aperta

#6246 aperta il 6 mar 2023

Vedi su GitHubGuida contributor
 (3 commenti) (0 reazioni) (0 assegnatari)Rust (1965 fork)batch import
api:graphqlhelp wanted

Metriche repository

Star
 (19.563 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Investiga come Cube genera lo schema GraphQL e individua dove aggiungere commenti per dimensioni e misure. Esamina il codice di generazione dello schema e trova un modo per passare annotazioni di documentazione dal modello dati Cube alle definizioni dello schema GraphQL.
Tech stack
graphql
Dominio
backendapi
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
GraphQL
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60