docs: Update output schemas, schema URIs, and dsc function CLI reference - #1709
Open
Gijs Reijn (Gijsreyn) wants to merge 1 commit into
Open
docs: Update output schemas, schema URIs, and dsc function CLI reference#1709Gijs 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
Several updated “schema reference” pages introduce broken link anchors and content that does not align with the schema versions/SchemaID they cite.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates DSC documentation to align schema/URI groupings and refresh CLI reference content, based on the linked Microsoft Learn sync.
Changes:
- Expanded the schema overview to include new subschema groupings for configuration documents, extensions, resources, and stdout schemas.
- Updated multiple output schema reference pages with new/renamed fields (for example,
executionInformation) and revised property requirements. - Updated
dsc function listCLI docs and added a newdsc function listoutput schema reference page content (examples + new fields likesyntax/constraints).
File summaries
| File | Description |
|---|---|
| docs/reference/schemas/overview.md | Reorganizes schema index and adds many new reference links across schema groups. |
| docs/reference/schemas/outputs/resource/test.md | Updates dsc resource test output schema reference content and property list. |
| docs/reference/schemas/outputs/resource/set.md | Updates dsc resource set output schema reference content (notably execution metadata + changedProperties semantics). |
| docs/reference/schemas/outputs/resource/list.md | Expands dsc resource list schema reference with new fields and clarifications. |
| docs/reference/schemas/outputs/resource/get.md | Updates dsc resource get output schema reference content and execution metadata guidance. |
| docs/reference/schemas/outputs/function/list.md | Adds/updates the dsc function list output schema reference page (including examples and new fields). |
| docs/reference/schemas/outputs/extension/list.md | Updates extension list output schema reference with capabilities/import/deprecation fields. |
| docs/reference/schemas/outputs/config/test.md | Updates config test output schema reference (execution metadata + outputs). |
| docs/reference/schemas/outputs/config/set.md | Updates config set output schema reference (execution metadata + outputs). |
| docs/reference/schemas/outputs/config/get.md | Updates config get output schema reference (execution metadata + outputs). |
| docs/reference/cli/function/list.md | Updates CLI reference for dsc function list (output table changes + new filter options docs). |
Review details
- Files reviewed: 11/12 changed files
- Comments generated: 9
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
27
to
33
| ## Required properties | ||
|
|
||
| The output always includes these properties: | ||
|
|
||
| - [metadata](#metadata-1) | ||
| - [results](#results) | ||
| - [messages](#messages) | ||
| - [hadErrors](#haderrors) |
| [10]: ../../definitions/resourceType.md | ||
| [11]: ../resource/get.md | ||
| [12]: ../../definitions/message.md | ||
| [10]: ../../metadata/Microsoft.DSC/properties.md#restartrequired |
| [10]: ../../definitions/resourceType.md | ||
| [11]: ../resource/set.md | ||
| [12]: ../../definitions/message.md | ||
| [10]: ../../metadata/Microsoft.DSC/properties.md#restartrequired |
| [10]: ../../definitions/resourceType.md | ||
| [11]: ../resource/test.md | ||
| [12]: ../../definitions/message.md | ||
| [10]: ../../metadata/Microsoft.DSC/properties.md#restartrequired |
Comment on lines
16
to
20
| ```yaml | ||
| SchemaDialect: https://json-schema.org/draft/2020-12/schema | ||
| SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.2.0/outputs/function/list.json | ||
| SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/outputs/function/list.json | ||
| Type: object | ||
| ``` |
Comment on lines
69
to
74
| ### Required properties | ||
|
|
||
| - [metadata](#metadata-1) | ||
| - [name](#name) | ||
| - [type](#type) | ||
| - [result](#result) | ||
|
|
| [01]: ../../metadata/Microsoft.DSC/properties.md#duration | ||
| [02]: https://datatracker.ietf.org/doc/html/rfc3339#appendix-A | ||
| [03]: ../../definitions/resourceType.md | ||
| [03]: ../../metadata/Microsoft.DSC/properties.md#restartrequired |
| [01]: ../../metadata/Microsoft.DSC/properties.md#duration | ||
| [02]: https://datatracker.ietf.org/doc/html/rfc3339#appendix-A | ||
| [03]: ../../definitions/resourceType.md | ||
| [03]: ../../metadata/Microsoft.DSC/properties.md#restartrequired |
| [01]: ../../metadata/Microsoft.DSC/properties.md#duration | ||
| [02]: https://datatracker.ietf.org/doc/html/rfc3339#appendix-A | ||
| [03]: ../../definitions/resourceType.md | ||
| [03]: ../../metadata/Microsoft.DSC/properties.md#restartrequired |
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 them based on separate schema groups.
PR context
Synced docs from Microsoft Learn: MicrosoftDocs/PowerShell-Docs-DSC#414