gristlabs/grist-core

Some API endpoints are hidden from the reference documentation TOC

Open

#896 aperta il 14 mar 2024

Vedi su GitHub
 (1 commento) (2 reazioni) (0 assegnatari)TypeScript (168 fork)batch import
good first issue

Metriche repository

Star
 (3613 star)
Metriche merge PR
 (Merge medio 11g 9h) (47 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Il problema è che alcuni endpoint API come 'sql' mancano dal sommario della documentazione di riferimento. Per risolvere, indaga su come viene generato il sommario della documentazione in questo progetto. Cerca file di configurazione che definiscono quali endpoint sono elencati. Potrebbe esserci un template o uno script che deve includere tutti gli endpoint. Controlla la cartella della documentazione del repository e eventuali issue o PR correlate per contesto.
Tech stack
typescript
Dominio
documentationbackend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90