getredash/redash

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

Open

#3 815 ouverte le 20 mai 2019

Voir sur GitHub
 (7 commentaires) (1 réaction) (0 assignés)Python (24 845 stars) (4 236 forks)batch import
FrontendUXhelp wanted

Description

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.

Guide contributeur

Stack technique
pythonjavascriptrest api
Domaine
apidocumentation
Type d'issue
bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Familiarity with Redash's frontend codeUnderstanding of API key dialogKnowledge of parameterized queries
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
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.