Sync reference schema for released v3.2.0 - #414
Open
Gijs Reijn (Gijsreyn) wants to merge 3 commits into
Open
Conversation
Gijs Reijn (Gijsreyn)
requested a review
from Mikey Lombardi (He/Him) (michaeltlombardi)
as a code owner
September 2, 2026 02:27
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
There was a problem hiding this comment.
🟡 Changes recommended
A few newly added/updated function reference examples and descriptions contain confirmed inaccuracies (including invalid example usage and mismatched documented output vs examples).
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the DSC v3.0 documentation’s JSON schema reference pages to match DSC behavior through v3.2.3 (with v3.3.0 additions explicitly called out), including refreshed operation stdout expectations, canonical property guidance, and expanded configuration function reference.
Changes:
- Refreshed multiple schema reference pages (resource stdout, outputs, definitions, config metadata/parameters) and updated schema/type patterns.
- Added extensive new configuration function reference pages plus CLI docs for
dsc functionanddsc function list. - Removed the
_rebootRequestedcanonical property schema page and added a docs redirect.
File summaries
| File | Description |
|---|---|
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/whatIf.md | Expands what-if stdout behavior description and updates metadata/links. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/validate.md | Updates doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/test.md | Updates test stdout behavior description and metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/set.md | Clarifies set vs what-if stdout guidance; adds cross-links. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/schema.md | Updates doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/resolve.md | Updates doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/index.md | Switches to reference-style links and updates metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/get.md | Updates doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/export.md | Updates doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/delete.md | Documents delete stdout behavior for actual vs what-if modes (incl. v3.3.0 capability). |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/properties/rebootRequested.md | Removes _rebootRequested property schema page (replaced/redirected). |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/properties/purge.md | Updates doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/properties/overview.md | Updates canonical properties overview (adds _restartRequired guidance, removes _rebootRequested). |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/properties/inDesiredState.md | Updates doc metadata date and adds link reference section. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/properties/exist.md | Updates doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/properties/ensure.md | Clarifies _ensure as legacy and updates metadata/links. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/schema/property.md | Expands schema property guidance and adds examples/arg kinds. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/schema/embedded.md | Fixes wording/typos and removes _rebootRequested from embedded schema guidance. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/test.md | Corrects test output description and adds execution info/restart fields. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/set.md | Updates set output shape (execution info, restart/what-if metadata, optional changedProperties). |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/get.md | Updates get output shape (execution info + restart fields, pattern tweak). |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/extension/list.md | Extends extension list output (capabilities/import/deprecation/description) and clarifies type pattern. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/extension/stdout/discover.md | Expands discover stdout schema details, adds manifestContent and exit-code guidance. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/extension/manifest/discover.md | Updates discover manifest schema guidance and adds examples/new arg kind notes. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/definitions/resourceType.md | Updates type-name regex and expands type-name semantics/constraints. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/definitions/resourceKind.md | Fixes schema hint, formatting, and type examples. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/definitions/resourceCapabilities.md | Fixes SchemaID and updates capability names/semantics (incl. v3.3.0 additions). |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/definitions/parameters/dataTypes.md | Updates secure type casing and clarifies case sensitivity. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/definitions/message.md | Adds description context and updates type-name regex. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/definitions/functions/builtin/dataTypes.md | Adds reference page for function argument/return data types. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/parameter.md | Updates valid parameter type casing and related validations. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/metadata.md | Expands metadata guidance; updates securityContext casing/deprecation notes/links. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/variables.md | Updates doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/utcNow.md | Adds new utcNow() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/uniqueString.md | Adds new uniqueString() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/true.md | Adds new true() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/toUpper.md | Adds new toUpper() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/systemRoot.md | Adds new systemRoot() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/sub.md | Formatting/metadata refresh for sub(). |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/stateChanged.md | Adds new stateChanged() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/startsWith.md | Adds new startsWith() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/skip.md | Adds new skip() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/restartRequired.md | Adds new restartRequired() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/resourceId.md | Updates resourceId() parameter metadata and documents output format. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/reference.md | Updates examples/output type guidance for reference(). |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/path.md | Adds new path() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/parameters.md | Clarifies error behavior and updates links/output types for parameters(). |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/or.md | Adds new or() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/null.md | Adds new null() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/not.md | Adds new not() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/mul.md | Formatting/metadata refresh for mul(). |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/mod.md | Updates doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/min.md | Updates doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/max.md | Updates doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/lessOrEquals.md | Adds new lessOrEquals() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/less.md | Adds new less() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/length.md | Adds new length() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/lastIndexOf.md | Adds new lastIndexOf() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/last.md | Adds new last() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/join.md | Adds new join() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/items.md | Adds new items() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/int.md | Updates doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/indexOf.md | Adds new indexOf() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/if.md | Updates if() accepted types and documents boolean/null error conditions. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/greaterOrEquals.md | Adds new greaterOrEquals() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/greater.md | Adds new greater() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/format.md | Updates doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/first.md | Adds new first() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/false.md | Adds new false() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/equals.md | Fixes syntax section and updates equality semantics/accepted types. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/envvar.md | Updates links and doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/endsWith.md | Adds new endsWith() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/empty.md | Adds new empty() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/div.md | Formatting/metadata refresh for div(). |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/dataUri.md | Adds new dataUri() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/createArray.md | Improves createArray() example text and formatting. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/contains.md | Adds new contains() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/concat.md | Formatting/metadata refresh for concat(). |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/coalesce.md | Adds new coalesce() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/bool.md | Adds new bool() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/base64.md | Updates doc metadata date. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/array.md | Adds new array() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/and.md | Adds new and() function reference page. |
| dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/add.md | Formatting/metadata refresh for add(). |
| dsc/docs-conceptual/dsc-3.0/reference/cli/toc.yml | Adds TOC entries for dsc function subcommands. |
| dsc/docs-conceptual/dsc-3.0/reference/cli/function/index.md | Adds CLI reference page for dsc function. |
| .openpublishing.redirection.json | Adds redirect for removed rebootRequested.md page. |
Review details
Suppressed comments (1)
dsc/docs-conceptual/dsc-3.0/reference/schemas/config/functions/dataUri.md:183
- The output format string includes
;charset=utf8, but all examples omit it. Align the documented output format with the examples.
- Files reviewed: 116/144 changed files
- Comments generated: 3
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- contains: objects are checked by key only; replace the invalid number-as-collection example and re-run it against dsc 3.4.0-preview.1 - dataUri: remove the charset claim; output has no charset parameter - systemRoot: fix 'overriden' and 'Windows system' typos Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
Contributor
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
Contributor
|
Learn Build status updates of commit 8e5ae2c:
|
This was referenced Sep 4, 2026
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
This pull request brings the JSON schema reference up to date with the code on DSC's
mainbranch. The docs were last accurate around v3.0/v3.1, so this PR closes the gap through v3.2.3, labeling v3.3.0 additions explicitly ("This property was added in DSC version 3.3.0")A short summary of what was added:
filter(),map(),lambda(),lambdaVariables(),stdout()dsc schema --typeoutput: missing fields added (
condition,deprecationMessage,metadata,requireSecurityContext,whatIfReturns,inputKind,contentVersion,outputs,functions,copy,executionInformation, extensionimport/secretand more$schemaversion lists now include v3.1.1–v3.2.3;SchemaIDpins stay atv3.1.0because nonewer schema folder is published under
schemas/Note
I recognize that GA 3.3.0 is around the corner, so the additions can also be removed already from the PR if that's better.
PR Checklist