Update from code changes: document labeled parameter options#920
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
cc @dtaniwaki |
Contributor
🤖 Documentation BotStatus🔗 Broken Links (Manual Fix Required)Click to view details |
ZeRego
reviewed
Jul 3, 2026
Contributor
🤖 Documentation BotStatus🔗 Broken Links (Manual Fix Required)Click to view details |
Contributor
🤖 Documentation BotStatus🔗 Broken Links (Manual Fix Required)Click to view details |
3 similar comments
Contributor
🤖 Documentation BotStatus🔗 Broken Links (Manual Fix Required)Click to view details |
Contributor
🤖 Documentation BotStatus🔗 Broken Links (Manual Fix Required)Click to view details |
Contributor
🤖 Documentation BotStatus🔗 Broken Links (Manual Fix Required)Click to view details |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document the new
{ label, value }object form for parameteroptions, which lets the UI display a human-readable label while a separate value is substituted into SQL.Changes
references/lightdash-config-yml.mdx: updated the project-level parameters table to note thatoptionsaccepts{ label, value }objects, added a "Labeled options" subsection with an example, and clarifieddefaultbehavior with labeled options.references/tables.mdx: same updates for the model-level parameters reference.guides/developer/using-parameters.mdx: added a labeled-options example to the project-level parameters walkthrough with a short explanation of when to use each form.Context
Upstream source PR: lightdash/lightdash#20639 ("feat: introduce parameter labels"). The bucket brief mentioned a
label_dimensionfield onoptions_from_dimension, but the shipped code only adds labeled objects to the staticoptionsarray — nolabel_dimensionfield exists — so only that change is documented here. Plain string/numberoptionsremain fully backward compatible.