Azure / Azure/bicep

Inherit description of resource-derived parameter

Open
#13,545 2 comments 2 reactions 0 assignees View on GitHub
enhancement Needs: Upvote
Dominant language
Bicep
Stars
3.6k
Forks
830
Avg merge
1d 21m
Merged PRs (30d)
79

Description

**Is your feature request related to a problem? Please describe.**
Properties of a resource-derived parameter inherits attributes like minLength and description and so I'd expected that the description of the parameter will also be inherited.

On creation of the param it has a description:
![image](https://github.com/Azure/bicep/assets/55690746/86295b8d-b034-4a40-b176-174fdaa67952)

But when the param is used in a bicepparam, the description is lost:
![image](https://github.com/Azure/bicep/assets/55690746/5e6a437a-52a2-4171-8a0b-ff552a655692)

**Describe the solution you'd like**
1) Inherit the description by default, unless you'd decide to provide your own.

Or

2) Make description text nullable, like: `@description()` so you explicitly express that you want a description.

Contributor guide

Open the contributing guide

Research direction

Start by tracing how descriptions and other attributes are propagated from resource-derived parameters into bicepparam usage; the issue names no source files or tests. Confirm the chosen inheritance or override behavior with a regression test covering the displayed scenario.

Written by the indexing model from the issue text.

Assessment

Domain
cloud, infrastructure
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.