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 (168 forks)batch import
good first issue

Métriques du dépôt

Stars
 (3 613 stars)
Métriques de merge PR
 (Merge moyen 11j 9h) (47 PRs mergées en 30 j)

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

Direction de recherche
Le problème est que certains points de terminaison d'API comme 'sql' sont absents de la table des matières de la documentation de référence. Pour corriger cela, étudiez comment la table des matières de la documentation est générée dans ce projet. Recherchez les fichiers de configuration qui définissent quels points de terminaison sont listés. Il peut y avoir un modèle ou un script qui doit inclure tous les points de terminaison. Vérifiez le dossier de documentation du dépôt et tout issue ou PR connexe pour le contexte.
Stack technique
typescript
Domaine
documentationbackend
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.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90