Fix type mismatch error in property substitution #4814
+45
−2
Conversation
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
added 3 commits
January 16, 2026 13:32
… }}` was returning string instead of the correct type ([microsoft#4813](microsoft#4813))
JC-wk
changed the title
Unit Test Results669 tests 669 ✅ 7s ⏱️ Results for commit d7f6117. ♻️ This comment has been updated with latest results. |
…JC-wk/AzureTRE into fix-property-substitution-types
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a type mismatch error where property substitution in pipeline templates was converting boolean and integer values to strings instead of preserving their original types. This resolves an issue where substituting parent resource properties like {{ resource.parent.properties.enable_backup }} would return "True" (string) instead of True (boolean), causing validation errors.
Changes:
- Modified substitution logic to preserve primitive types (bool, int, etc.) when the entire value is a single substitution token
- Added comprehensive tests for boolean, integer, and string concatenation scenarios
- Enhanced documentation with parent resource property access examples and reference table
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| api_app/service_bus/substitutions.py | Added type preservation logic: returns original type when value is exactly one token, otherwise falls back to string concatenation |
| api_app/tests_ma/test_service_bus/test_substitutions.py | Added tests verifying boolean and integer type preservation, plus string concatenation fallback |
| docs/tre-templates/pipeline-templates/pipeline-schema.md | Added parent resource property access documentation with table showing available references for each resource type |
| docs/tre-workspace-authors/authoring-workspace-templates.md | Added reference to pipeline schema documentation and minor fix to mention both install and uninstall pipelines |
| api_app/_version.py | Incremented API version from 0.25.10 to 0.25.11 (PATCH version for bug fix) |
| CHANGELOG.md | Added bug fix entry referencing issue #4813 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Resolves #4813 #4284
What is being addressed
Substituted properties will now retain their types unless they are part of a longer string see the issue for more detail
How is this addressed