gristlabs/grist-core

[Enhancement] Display API endpoint on API key screen

Open

#741 opened on 2023年11月11日

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

説明

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.

コントリビューターガイド

技術スタック
typescript
領域
frontendbackend
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic understanding of API keysfamiliarity with Grist's API structure
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70
調査方針
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.