-
Notifications
You must be signed in to change notification settings - Fork 43
(SCHEMA) Update schemas for v3.1.0 release #890
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
Draft
michaeltlombardi
wants to merge
8
commits into
PowerShell:main
Choose a base branch
from
michaeltlombardi:schema/main/v3.1.0
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
b077acb
(SCHEMA) Update source for v3.0.1
michaeltlombardi ad4f547
(SCHEMA) Regenerate schemas for v3.0.1
michaeltlombardi 7f17f9f
(SCHEMA) Update source for v3.0.2
michaeltlombardi 03c21fd
(SCHEMA) Regenerate schemas for v3.0.2
michaeltlombardi de6685d
(SCHEMA) Update schema source for v3.1.0 release
michaeltlombardi 14b066c
(SCHEMA) Update schema source for `exporter` resource kind.
michaeltlombardi 0f5bb6a
(SCHEMA) Add extension manifest to schema source
michaeltlombardi bd559a5
(SCHEMA) Fix required properties for resource kinds
michaeltlombardi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# yaml-language-server: $schema=https://json-schema.org/draft/2020-12/schema | ||
$schema: https://json-schema.org/draft/2020-12/schema | ||
$id: <HOST>/<PREFIX>/<VERSION>/definitions/extensionType.yaml | ||
|
||
title: DSC extension fully qualified type name | ||
description: | | ||
The namespaced name of the DSC extension, using the syntax: | ||
|
||
owner[.group][.area]/name | ||
|
||
For example: | ||
|
||
- Microsoft.DSC/Docs | ||
- Microsoft.Windows.Appx/Discover | ||
|
||
type: string | ||
pattern: ^\w+(\.\w+){0,2}\/\w+$ | ||
|
||
# VS Code only | ||
markdownDescription: | | ||
*** | ||
[_Online Documentation_][01] | ||
*** | ||
|
||
The namespaced name of the DSC extension, using the syntax: | ||
|
||
```yaml | ||
owner[.group][.area]/name | ||
``` | ||
|
||
For example: | ||
|
||
- `Microsoft.DSC/Docs` | ||
- `Microsoft.Windows.Appx/Discover` | ||
|
||
[01]: <DOCS_BASE_URL>/reference/schemas/definitions/extensiontype?<DOCS_VERSION_PIN> | ||
patternErrorMessage: | | ||
Invalid type name. Valid extension type names always define an owner and a name separated by a | ||
slash, like `Microsoft/Example`. Type names may optionally include a group and area to namespace | ||
the extension under the owner, like `Microsoft.Windows.Appx/Discover`. |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
# yaml-language-server: $schema=https://json-schema.org/draft/2020-12/schema | ||
$schema: https://json-schema.org/draft/2020-12/schema | ||
$id: <HOST>/<PREFIX>/<VERSION>/extension/manifest.discover.yaml | ||
|
||
title: Get Method | ||
description: >- | ||
Defines how DSC must call the DSC extension to discover the paths to resource manifests. | ||
markdownDescription: | # VS Code only | ||
*** | ||
[_Online Documentation_][00] | ||
*** | ||
Defines how DSC must call the DSC extension to discover the paths to resource manifests. An | ||
extension that defines this field in its manifest has the `discover` capability. | ||
By default, DSC only discovers resource manifests in the `PATH` environment variable. If the | ||
`DSC_RESOURCE_PATH` environment variable is defined, DSC searches those paths for resource | ||
manifests instead. | ||
If initial discovery finds any extension manifests that have the `discover` capability, DSC uses | ||
those extensions to recursively discover resources that aren't available in `PATH` or | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think you should remove the word |
||
`DSC_RESOURCE_PATH`. | ||
For more information about the output DSC expects the extension to emit for this command, see | ||
[Discover extension operation stdout][01]. | ||
[00]: <DOCS_BASE_URL>/reference/schemas/extension/manifest/discover?<DOCS_VERSION_PIN> | ||
[00]: <DOCS_BASE_URL>/reference/schemas/extension/stdout/discover?<DOCS_VERSION_PIN> | ||
type: object | ||
required: | ||
- executable | ||
properties: | ||
executable: | ||
$ref: /<PREFIX>/<VERSION>/definitions/commandExecutable.yaml | ||
markdownDescription: | | ||
*** | ||
[_Online Documentation_][01] | ||
*** | ||
Defines the name of the command to run. The value must be the name of a command discoverable | ||
in the system's `PATH` environment variable or the full path to the command. A file extension | ||
is only required when the command isn't recognizable by the operating system as an | ||
executable. | ||
[01]: <DOCS_BASE_URL>/reference/schemas/extension/manifest/discover?<DOCS_VERSION_PIN>#executable | ||
args: | ||
$ref: /<PREFIX>/<VERSION>/definitions/commandArgs.yaml | ||
markdownDescription: | | ||
*** | ||
[_Online Documentation_][01] | ||
*** | ||
Defines an array of strings to pass as arguments to the command. DSC passes the arguments to | ||
the command in the order they're specified. | ||
For example, the given the following definition: | ||
```json | ||
{ | ||
"executable": "myextension", | ||
"args": ["discover", "--all"], | ||
} | ||
``` | ||
DSC invokes the command for the resource as: | ||
```bash | ||
myextension discover --all | ||
``` | ||
[01]: <DOCS_BASE_URL>/reference/schemas/extension/manifest/discover?<DOCS_VERSION_PIN>#args | ||
defaultSnippets: # VS Code only | ||
- label: ' Define without arguments' | ||
markdownDescription: | | ||
Define the `discover` command for the extension when no arguments are required. | ||
body: | ||
executable: ${2:executable_name} | ||
- label: ' Define with arguments' | ||
markdownDescription: |- | ||
Define the `discover` command for the extension when at least one argument is required. | ||
body: | ||
executable: ${2:executable_name} | ||
args: | ||
- ${3:--first-argument} |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't this be
Discover Method
?