gristlabs/grist-core

Some API endpoints are hidden from the reference documentation TOC

Open

#896 aberto em 14 de mar. de 2024

Ver no GitHub
 (1 comment) (2 reactions) (0 assignees)TypeScript (168 forks)batch import
good first issue

Métricas do repositório

Stars
 (3.613 stars)
Métricas de merge de PR
 (Mesclagem média 11d 9h) (47 fundiu PRs em 30d)

Description

Some API endpoint (such as sql) are hidden from the reference documentation TOC. The way it is presented makes it seems they are deprecated. I only discovered some of them while browsing the community forum.

Guia do colaborador

Direção de pesquisa
O problema é que alguns endpoints da API, como 'sql', estão faltando no sumário da documentação de referência. Para corrigir, investigue como o sumário da documentação é gerado neste projeto. Procure por arquivos de configuração que definem quais endpoints são listados. Possivelmente há um modelo ou script que precisa incluir todos os endpoints. Verifique a pasta de documentação do repositório e quaisquer issues ou PRs relacionados para contexto.
Pilha de tecnologia
typescript
Domain
documentationbackend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
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.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90