Canonical property schema refs
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 523
- Forks
- 75
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 24
Description
Prerequisites
- Write a descriptive title.
- Make sure you are able to repro it on the latest version
- Search the existing issues.
Summary
The current documentation for resource authors is that canonical properties should use the $ref keyword to link out to GitHub for the property reference. However, that won't work if the system is air-gapped.
Excerpt from _exist canonical property.
To add this property to a resource's instance schema, define the property with the following snippet:
"_exist": {
"$ref": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/resource/properties/exist.json"
}
To better support air-gapped systems, the documentation should be updated to return the full schema without internet refs and update the canonical property docs with a snippet to include.
Steps to reproduce
n/a
Expected behavior
n/a
Actual behavior
n/a
Error details
n/a
Environment data
n/a
Version
n/a
Visuals
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the resource-author documentation and the _exist canonical property example, then inspect schemas/v3/resource/properties/exist.json. Update the guidance to show the full schema without internet references and add an air-gapped-safe snippet for canonical properties.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100