Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Semantic vocabulary proposal: From "well-known properties" to "canonical properties" #633

Open
michaeltlombardi opened this issue Feb 4, 2025 · 3 comments
Labels
Issue-Enhancement The issue is a feature or idea Needs Triage

Comments

@michaeltlombardi
Copy link
Collaborator

michaeltlombardi commented Feb 4, 2025

Summary of the new feature / enhancement

Early in the design and implementation of DSC, I proposed that we use the term well-known properties to describe special properties that DSC Resources could use to participate in shared semantics and behaviors with the DSC engine, like _exist and _purge.

I now believe that the more semantically accurate and useful term for these properties is canonical properties_. If a resource defines a canonical property as part of its resource instance schema, the resource is opting into a contract about the possible values for that property, expectations for how the resource uses that property, and how DSC will interpret and use that property, especially for synthetic operations.

Proposed technical implementation details (optional)

Update the documentation (and types, if the dsc_lib crate is ever intended for public publishing) to use the term canonical property or canonical properties instead of well-known property or well-known properties.

@michaeltlombardi michaeltlombardi added Issue-Enhancement The issue is a feature or idea Needs Triage labels Feb 4, 2025
@SteveL-MSFT
Copy link
Member

Perhaps canonical properties?

@michaeltlombardi
Copy link
Collaborator Author

I think canonical is fine, semantically - updating the issue title/body.

@michaeltlombardi michaeltlombardi changed the title Semantic vocabulary proposal: From "well-known properties" to "conventional properties" Semantic vocabulary proposal: From "well-known properties" to "canonical properties" Feb 6, 2025
@SteveL-MSFT
Copy link
Member

Agree on the proposal along with some specific doc text to indicate that resources SHALL not use the underscore prefix unless they are implementing a canonical property

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue-Enhancement The issue is a feature or idea Needs Triage
Projects
None yet
Development

No branches or pull requests

2 participants