Skip to content

Conversation

michaeltlombardi
Copy link
Contributor

PR Summary

This change:

PR Checklist

  • Descriptive Title: This PR's title is a synopsis of the changes it proposes.
  • Summary: This PR's summary describes the scope and intent of the change.
  • Contributor's Guide: I have read the contributors guide.
  • Style: This PR adheres to the style guide.

This change:

- Adds reference documentation for the expected output
  for resource operations
- Mirrors the PR in the code repository (PowerShell/DSC#1016)
- Fixes MicrosoftDocs#367
- Fixes MicrosoftDocs#368
- Fixes MicrosoftDocs#369
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. 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 found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

Copy link

Learn Build status updates of commit 6b16995:

⚠️ Validation status: warnings

File Status Preview URL Details
dsc/docs-conceptual/dsc-3.0/reference/cli/resource/list.md ⚠️Warning View (dsc-3.0) Details
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/set.md ⚠️Warning View (dsc-3.0) Details
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/whatif.md ⚠️Warning View (dsc-3.0) Details
dsc/docs-conceptual/dsc-3.0/reference/schemas/definitions/resourceCapabilities.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/definitions/resourceKind.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/list.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/root.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/delete.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/export.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/get.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/index.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/list.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/resolve.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/schema.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/set.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/test.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/validate.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/stdout/whatIf.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/toc.yml ✅Succeeded

dsc/docs-conceptual/dsc-3.0/reference/cli/resource/list.md

  • Line 307, Column 45: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#capability-get' in 'docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/list.md', did you mean '#capabilities'?
  • Line 308, Column 45: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#capability-set' in 'docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/list.md', did you mean '#capabilities'?
  • Line 309, Column 45: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#capability-sethandlesexist' in 'docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/list.md'.
  • Line 310, Column 45: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#capability-whatif' in 'docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/list.md'.
  • Line 311, Column 45: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#capability-test' in 'docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/list.md', did you mean '#capabilities'?
  • Line 312, Column 45: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#capability-delete' in 'docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/list.md'.
  • Line 313, Column 45: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#capability-export' in 'docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/list.md'.
  • Line 314, Column 45: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#capability-resolve' in 'docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/list.md'.

dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/set.md

  • Line 227, Column 77: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#capability-sethandlesexist' in 'docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/list.md'.

dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/whatif.md

  • Line 246, Column 77: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#capability-sethandlesexist' in 'docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/list.md'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

Copy link
Contributor

@sdwheeler sdwheeler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sdwheeler sdwheeler merged commit df9c4cc into MicrosoftDocs:main Aug 21, 2025
3 checks passed
@michaeltlombardi michaeltlombardi mentioned this pull request Aug 21, 2025
4 tasks
sdwheeler added a commit that referenced this pull request Aug 21, 2025
* Add description to Microsoft.DSC metadata (#371)

* (SYNC) Draft reference for expected resource stdout JSON Schemas (#373)

This change:

- Adds reference documentation for the expected output
  for resource operations
- Mirrors the PR in the code repository (PowerShell/DSC#1016)
- Fixes #367
- Fixes #368
- Fixes #369

* (MAINT) Fix bookmark links (#374)

---------

Co-authored-by: Gijs Reijn <gijsreijn@hotmail.com>
Co-authored-by: Mikey Lombardi (He/Him) <mlombardi@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

What is the required return What is the required return What is the required return
2 participants