Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[AVM CI Environment Issue]: The Set-AVMModule script is not documenting properties of types using a discriminator #4128

Open
1 task done
AlexanderSehr opened this issue Jan 7, 2025 · 1 comment · May be fixed by #4146
Open
1 task done

[AVM CI Environment Issue]: The Set-AVMModule script is not documenting properties of types using a discriminator #4128

AlexanderSehr opened this issue Jan 7, 2025 · 1 comment · May be fixed by #4146
Assignees
@AlexanderSehr
Labels
Needs: Core Team 🧞 This item needs the AVM Core Team to review it Type: AVM 🅰️ ✌️ Ⓜ️ This is an AVM related issue Type: Bug 🐛 Something isn't working Type: CI 🚀 This issue is related to the AVM CI

Comments

@AlexanderSehr
Copy link
Contributor

Check for previous/existing GitHub issues

  • I have checked for previous/existing GitHub issues

Issue Type?

Bug

Description

If using a discriminator for a User-defined-type,

bicep-registry-modules/avm/res/digital-twins/digital-twins-instance/endpoint/main.bicep

Lines 149 to 152 in 199010b

@description('The type for the Digital Twin Endpoint.')
@discriminator('endpointType')
@export()
type propertiesType = eventGridPropertiesType | eventHubPropertiesType | serviceBusPropertiesType

the ReadMe function currently does not break the property down beyond the property using a discriminator.

Image
(source)
@AlexanderSehr AlexanderSehr added Needs: Core Team 🧞 This item needs the AVM Core Team to review it Needs: Triage 🔍 Maintainers need to triage still Type: AVM 🅰️ ✌️ Ⓜ️ This is an AVM related issue Type: CI 🚀 This issue is related to the AVM CI labels Jan 7, 2025
@github-project-automation github-project-automation bot moved this to Needs: Triage in AVM - Issue Triage Jan 7, 2025
@AlexanderSehr AlexanderSehr removed the Needs: Triage 🔍 Maintainers need to triage still label Jan 7, 2025
@microsoft-github-policy-service microsoft-github-policy-service bot added the Needs: Triage 🔍 Maintainers need to triage still label Jan 7, 2025
@microsoft-github-policy-service Microsoft GitHub Policy Service
Copy link

Important

The "Needs: Triage 🔍" label must be removed once the triage process is complete!

Tip

For additional guidance on how to triage this issue/PR, see the BRM Issue Triage documentation.

@microsoft-github-policy-service microsoft-github-policy-service bot added the Type: Bug 🐛 Something isn't working label Jan 7, 2025
@AlexanderSehr AlexanderSehr self-assigned this Jan 12, 2025
@AlexanderSehr AlexanderSehr removed the Needs: Triage 🔍 Maintainers need to triage still label Jan 12, 2025
@AlexanderSehr AlexanderSehr linked a pull request Jan 12, 2025 that will close this issue
Open
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AlexanderSehr AlexanderSehr

Labels
Needs: Core Team 🧞 This item needs the AVM Core Team to review it Type: AVM 🅰️ ✌️ Ⓜ️ This is an AVM related issue Type: Bug 🐛 Something isn't working Type: CI 🚀 This issue is related to the AVM CI
Projects
AVM - Issue Triage
Status: Needs: Triage
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Added support for Discrimintor-based variants to readme utility Azure/bicep-registry-modules
1 participant
@AlexanderSehr