Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

(SCHEMAS) Fix/update for v3.0.0 release#734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation

michaeltlombardi
Copy link
Collaborator

@michaeltlombardimichaeltlombardi commentedApr 2, 2025
edited
Loading

PR Summary

This change set includes updates to the schema source files for various issues with the canonically published schemas, including:

  • Mismatched terminology
  • ErroneousminItems keyword forresources property of coniguration document
  • Incorrect enumeration values for resourcekind
  • Incorrect description and default definition forreturnKind forset, requiring updating shared definition,set.return,whatIf.return,test.return, and related documentation keywords.
  • Incorrect URIs for$schema property in both configuration document and resource manifest schemas

This change also adds JSON schemas for the expectedstdout JSON for various resource operations. This should help resource authors understand and validate their resource implementations.

TODO:

  • Regenerate schemas from source
  • Update and extend reference documentation (deferred to separate PR)

PR Context

Needed to address issues with the published schemas for thev3.0.0 release. These changes and the technical review of them are required for completing the regeneration and documentation efforts.

Gijsreyn reacted with rocket emoji
@michaeltlombardimichaeltlombardiforce-pushed theschema/main/v3.0.0-fix-update branch 2 times, most recently from36e770b to066f653CompareApril 29, 2025 20:00
@michaeltlombardi
Copy link
CollaboratorAuthor

@SteveL-MSFT - keeping this in draft, but it's ready for review - need to regenerate the schemas and add docs, but only want to do that after we're sure the actual schema implementations is accurate.

@michaeltlombardimichaeltlombardiforce-pushed theschema/main/v3.0.0-fix-update branch 2 times, most recently from78ca267 toef4c50fCompareMay 5, 2025 13:48
@michaeltlombardimichaeltlombardi changed the title(SCHEMAS) FIx/update for v3.0.0 release(SCHEMAS) Fix/update for v3.0.0 releaseMay 6, 2025
@michaeltlombardimichaeltlombardiforce-pushed theschema/main/v3.0.0-fix-update branch fromef4c50f to3845d4dCompareMay 6, 2025 13:38
Copy link
Member

@SteveL-MSFTSteveL-MSFT left a comment

Choose a reason for hiding this comment

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

Nothing stands out to me as an issue

michaeltlombardi reacted with thumbs up emoji
This change updates casing and terms to match the glossary. Thesechanges are colocated to make reviewing actual schema changessimpler.
This change sets the `minItems` keyword to `0` for the `resources` propertyof a configuration document. Prior to this change, the schema specified avalue of `1`, which was inaccurate.This changefixesPowerShell#717
Prior to this change, the enums in the schema source for the `kind` propertyof a DSC resource wasn't updated to reflect the change for camelCasing andnaming.This change updates the enumeration values and the associated documentationkeywords andfixesPowerShell#708.
This change breaks out the capabilities schema from the `dsc resource list`output schema into a separate definition file. This enables us to referencethe schema without using a JSON Pointer and provides us with a page fordocumenting the capabilities directly.This is a required precursor for a future change that defines stdoutschemas for resource operations.
Prior to this change, the `returnKind` shared definition set a defaultvalue. This was inaccurate, because `set.return` has different behaviorwhen `return` isn't defined - DSC invokes the **Get** operation toconstruct the result after the **Set** operation for the resourceconcludes.This change removes the default from the shared definition, adds itto the `test.return` property, and clarifies the behavior for the`set.return` property. Finally, this change also makes `whatIf.return`mandatory, as the synthetic after-state doesn't make sense for thisoperation, even if DSC will technically accept it.
Prior to this change, the instructions and information about howresources should return data to DSC for any given operation wassomewhat vague and not always helpful.This change defines a new set of schemas for the various operations,so resource authors can review their implementations and validate themagainst these schemas.
This change updates the documentation keywords for the various resourcecommands to point to the newly defined stdout JSON Schemas. This changewas kept separate from the implementation of those schemas to simplifyreview.
Prior to this change, the schemas erroneously included URIs for thepreview schemas and didn't include URIs for the various version foldersor `aka.ms` short link options.This change corrects the enumeration values and accompanying documentationkeywords.
Prior to this change, the output metadata erroneously required the`context` property, which is sent _to_ resources but not returnedfor configuration operations themselves.
Prior to this change, the bundling function for schemas wouldsometimes include a self-reference in the definitions, whichis invalid per the JSON Schema specification.This change ensures self-references are skipped instead ofinserted.
@michaeltlombardimichaeltlombardi marked this pull request as ready for reviewMay 12, 2025 17:26
@michaeltlombardimichaeltlombardiforce-pushed theschema/main/v3.0.0-fix-update branch 2 times, most recently fromce10c7d to272753dCompareMay 12, 2025 17:26
@SteveL-MSFTSteveL-MSFT added this pull request to themerge queueMay 17, 2025
Merged via the queue intoPowerShell:main with commit8fd7ef4May 17, 2025
4 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@SteveL-MSFTSteveL-MSFTSteveL-MSFT approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

2 participants
@michaeltlombardi@SteveL-MSFT

[8]ページ先頭

©2009-2025 Movatter.jp