docs: Update shared definitions and Microsoft.DSC metadata reference - #1704
Open
Gijs Reijn (Gijsreyn) wants to merge 1 commit into
Open
docs: Update shared definitions and Microsoft.DSC metadata reference#1704Gijs Reijn (Gijsreyn) wants to merge 1 commit into
Gijs Reijn (Gijsreyn) wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Multiple updated docs diverge from (or reference missing) schema artifacts in this repo, creating broken/unverifiable schema contracts.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates several DSC schema reference docs (synced from Microsoft Learn) to reflect newer schema groupings and refreshed metadata, type-name, capability, and function/type definitions documentation.
Changes:
- Refreshes
Microsoft.DSCmetadata property reference content (including new restart/copy-loop related documentation). - Updates resource type-name pattern guidance and propagates the new pattern into related schema docs.
- Expands resource capabilities and function data-type schema reference docs with additional explanatory content.
File summaries
| File | Description |
|---|---|
| docs/reference/schemas/metadata/Microsoft.DSC/properties.md | Updates Microsoft.DSC metadata property reference and adds restart/copy-loop guidance. |
| docs/reference/schemas/definitions/resourceType.md | Revises the documented type-name pattern and explains namespace segmentation. |
| docs/reference/schemas/definitions/resourceKind.md | Reflows and updates examples/schema references for resource kind documentation. |
| docs/reference/schemas/definitions/resourceCapabilities.md | Updates documented resource capability values and adds a manifest-to-capability mapping table. |
| docs/reference/schemas/definitions/parameters/dataTypes.md | Updates parameter data type casing and clarifies case sensitivity. |
| docs/reference/schemas/definitions/message.md | Adds description context and updates documented resource type-name pattern usage. |
| docs/reference/schemas/definitions/functions/builtin/dataTypes.md | Updates function data types schema reference metadata and adds context about where types appear in output. |
Review details
Suppressed comments (2)
docs/reference/schemas/definitions/resourceCapabilities.md:55
- The capability descriptions list
setWhatIfanddeleteWhatIf, but the referenced v3.1.0 schema only defines a singlewhatIfcapability (and no delete simulation capability). The bullets should align with the schema this page documents.
- `setWhatIf` - The resource supports simulating the **Set** operation directly, reporting how it
would change the state of an instance without changing it. This capability was added in DSC
version 3.3.0. Through DSC version 3.2.x, this capability was reported as `whatIf`.
- `test` - The resource implements the **Test** operation and doesn't rely on synthetic testing.
- `delete` - The resource supports removing an instance.
- `deleteWhatIf` - The resource supports simulating the **Delete** operation directly, reporting
how it would remove an instance without removing it. This capability was added in DSC version
3.3.0.
docs/reference/schemas/definitions/resourceType.md:59
- This page is scoped to the v3.1.0 schema, but the text claims the number of namespace segments is unlimited starting with DSC 3.2.0; there is no corresponding schema version in this repo, and the v3/v3.1 schemas still enforce a maximum segment count. This statement should be removed or moved to versioned docs that include the updated schema.
Earlier versions of the schema limited the number of namespace segments. The schemas published for
DSC 3.0 allow up to three segments and the schemas published for DSC 3.1 allow up to four. Starting
with DSC 3.2.0, the number of segments is unlimited.
- Files reviewed: 7/7 changed files
- Comments generated: 5
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| 'string' | ||
| ] | ||
| SchemaDialect: https://json-schema.org/draft/2020-12/schema | ||
| SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/definitions/functions/builtin/argKind.json |
| Type: string | ||
| Required: true | ||
| Pattern: ^\w+(\.\w+){0,2}\/\w+$ | ||
| Pattern: ^\w+(\.\w+)*\/\w+$ |
Comment on lines
26
to
+30
| setHandlesExist, | ||
| whatIf, | ||
| setWhatIf, | ||
| test, | ||
| delete, | ||
| deleteWhatIf, |
| SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/resourceType.json | ||
| Type: string | ||
| Pattern: ^\w+(\.\w+){0,2}\/\w+$ | ||
| Pattern: ^\w+(\.\w+)*\/\w+$ |
Comment on lines
+112
to
+114
| Type: array | ||
| ItemsType: object | ||
| ValidItemSchema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/executionInformation/restartRequired.json |
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
As requested, shortened the number of files and updated it based on separate schema groups.
PR context
Synced docs from Microsoft Learn: MicrosoftDocs/PowerShell-Docs-DSC#414