getredash/redash

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

Open

Aperta il 20 mag 2019

Vedi su GitHub
 (7 commenti) (1 reazione) (0 assegnatari)Python (24.845 star) (4236 fork)batch import
FrontendUXhelp wanted

Descrizione

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.

Guida contributor

Tech stack
pythonjavascriptrest api
Dominio
apidocumentation
Tipo issue
bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Familiarity with Redash's frontend codeUnderstanding of API key dialogKnowledge of parameterized queries
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60
Direzione di ricerca
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.