getredash/redash

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

Open

#3,815 opened on May 20, 2019

View on GitHub
 (7 comments) (1 reaction) (0 assignees)Python (4,236 forks)batch import
FrontendUXhelp wanted

Repository metrics

Stars
 (24,845 stars)
PR merge metrics
 (Avg merge 6d 17h) (2 merged PRs in 30d)

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.

Contributor guide

Research direction
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.
Tech stack
pythonjavascriptrest api
Domain
apidocumentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Familiarity with Redash's frontend codeUnderstanding of API key dialogKnowledge of parameterized queries
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60