Replace apiVersion with requireVersion#1399
Open
SteveL-MSFT wants to merge 2 commits intoPowerShell:mainfrom
Open
Replace apiVersion with requireVersion#1399SteveL-MSFT wants to merge 2 commits intoPowerShell:mainfrom
apiVersion with requireVersion#1399SteveL-MSFT wants to merge 2 commits intoPowerShell:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Renames the configuration document resource version requirement field from apiVersion to the clearer requireVersion, while preserving backward compatibility by accepting apiVersion as an alias during deserialization.
Changes:
- Update configurator resource discovery to use
require_versioninstead ofapi_version. - Update config document model to serialize as
requireVersionand acceptapiVersionas an alias. - Update PowerShell versioning tests to use
requireVersionand add coverage for theapiVersionalias.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| lib/dsc-lib/src/configure/mod.rs | Switches discovery/filtering to read the version requirement from require_version. |
| lib/dsc-lib/src/configure/config_doc.rs | Renames the serialized field to requireVersion and adds apiVersion as a serde alias; updates related unit assertions. |
| dsc/tests/dsc_config_version.tests.ps1 | Updates YAML to requireVersion and adds a test ensuring apiVersion still works as an alias. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
PR Summary
Rename
apiVersiontorequireVersionbut keepapiVersionas an aliasPR Context
Fix #1376