cube-js/cube

Facilitate comments in GraphQL schema generation flow

Ouverte

#6 246 ouverte le 6 mars 2023

Voir sur GitHubGuide contributeur
 (3 commentaires) (0 réaction) (0 personne assignée)Rust (1 965 forks)batch import
api:graphqlhelp wanted

Métriques du dépôt

Stars
 (19 563 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Examinez comment Cube génère le schéma GraphQL et identifiez où ajouter des commentaires pour les dimensions et les mesures. Regardez le code de génération de schéma et trouvez un moyen de transmettre les annotations de documentation du modèle de données Cube aux définitions du schéma GraphQL.
Stack technique
graphql
Domaine
backendapi
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
GraphQL
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60