getredash/redash

Don't show simple results API usage examples for parameterized queries

Open

#3,815 建立於 2019年5月20日

在 GitHub 查看
 (7 留言) (1 反應) (0 負責人)Python (24,845 star) (4,236 fork)batch import
FrontendUXhelp wanted

描述

When you open the API Key dialog for a query, we show results API usage examples:

image

These examples will not work in the case of a parameterized query. We should at least replace the examples with a message explaining this or preferably show something along the lines of @rauchy's comment.

貢獻者指南

技術棧
pythonjavascriptrest api
領域
apidocumentation
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Familiarity with Redash's frontend codeUnderstanding of API key dialogKnowledge of parameterized queries
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
Review the frontend code for the API key dialog, likely in a React component. Identify where the results API usage examples are rendered. Determine how to check if the query is parameterized. Modify the component to hide the examples and show a message for parameterized queries, following the suggestion in @rauchy's comment.