gristlabs/grist-core

Some API endpoints are hidden from the reference documentation TOC

Open

#896 geöffnet am 14. März 2024

Auf GitHub ansehen
 (1 Kommentar) (2 Reaktionen) (0 zugewiesene Personen)TypeScript (3.613 Stars) (168 Forks)batch import
good first issue

Beschreibung

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.

Contributor Guide

Tech Stack
typescript
Domain
apidocumentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic knowledge of Grist APIDocumentation generation tools
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
The issue is that some API endpoints like 'sql' are missing from the reference documentation TOC. To fix this, investigate how the documentation TOC is generated in this project. Look for configuration files that define which endpoints are listed. Possibly there is a template or script that needs to include all endpoints. Check the repository's documentation folder and any related issues or PRs for context.