getredash/redash

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

Open

#3.815 aberto em 20 de mai. de 2019

Ver no GitHub
 (7 comments) (1 reaction) (0 assignees)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.

Guia do colaborador

Pilha de tecnologia
pythonjavascriptrest api
Domain
apidocumentation
Tipo Issue
bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
half day
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
mostly clear
Prerequisites
Familiarity with Redash's frontend codeUnderstanding of API key dialogKnowledge of parameterized queries
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60
Direção de pesquisa
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.