getredash/redash

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

Open

#3.815 geöffnet am 20. Mai 2019

Auf GitHub ansehen
 (7 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Python (24.845 Stars) (4.236 Forks)batch import
FrontendUXhelp wanted

Beschreibung

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.

Contributor Guide

Tech Stack
pythonjavascriptrest api
Domain
apidocumentation
Issue Type
bug
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Familiarity with Redash's frontend codeUnderstanding of API key dialogKnowledge of parameterized queries
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
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.