cube-js/cube

Facilitate comments in GraphQL schema generation flow

Open

#6.246 aberto em 6 de mar. de 2023

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (1.965 forks)batch import
api:graphqlhelp wanted

Métricas do repositório

Stars
 (19.563 stars)
Métricas de merge de PR
 (Mesclagem média 5d 16h) (138 fundiu PRs em 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

Guia do colaborador

Direção de pesquisa
Investigue como o Cube gera o esquema GraphQL e identifique onde adicionar comentários para dimensões e métricas. Analise o código de geração de esquema e encontre uma maneira de passar anotações de documentação do modelo de dados do Cube para as definições do esquema GraphQL.
Pilha de tecnologia
graphql
Domain
backendapi
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
GraphQL
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60