gristlabs/grist-core

[Enhancement] Display API endpoint on API key screen

Open

#741 opened on Nov 11, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (3,613 stars) (168 forks)batch import
enhancementgood first issue

Description

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
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic understanding of API keysfamiliarity with Grist's API structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.
[Enhancement] Display API endpoint on API key screen · gristlabs/grist-core#741 | Good First Issue