gristlabs/grist-core

Some API endpoints are hidden from the reference documentation TOC

Open

#896 ouverte le 14 mars 2024

Voir sur GitHub
 (1 commentaire) (2 réactions) (0 assignés)TypeScript (3 613 stars) (168 forks)batch import
good first issue

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.

Guide contributeur

Stack technique
typescript
Domaine
apidocumentation
Type d'issue
documentation
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.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic knowledge of Grist APIDocumentation generation tools
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
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.