gristlabs/grist-core

[Enhancement] Display API endpoint on API key screen

Open

#741 geöffnet am 11. Nov. 2023

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (3.613 Stars) (168 Forks)batch import
enhancementgood first issue

Beschreibung

Display the endpoint for API requests next to the API key. This will help to get started with using the API. Perhaps even display the curl command to test the API.

Contributor Guide

Tech Stack
typescript
Domain
frontendbackend
Issue Type
feature
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.
1-3 hours
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 understanding of API keysfamiliarity with Grist's API structure
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
Start by locating the API key screen component in the Grist frontend codebase, likely under a directory like 'app/client/components' or similar. Look for where the API key is displayed and consider how to add the endpoint URL next to it. The backend API endpoints are defined in the server side; you may need to confirm the correct endpoints from the documentation or by looking at server routes. Optionally, adding a curl command could be done by constructing it from the endpoint and API key. Check existing comments for any hints from maintainers.