-
Notifications
You must be signed in to change notification settings - Fork 75
docs: Update shared definitions and Microsoft.DSC metadata reference #1704
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
Open
Gijs Reijn (Gijsreyn)
wants to merge
1
commit into
PowerShell:main
Choose a base branch
from
Gijsreyn:docs-schemas-definitions-metadata
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.
Open
Changes from all commits
Commits
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
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 |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| --- | ||
| description: JSON schema reference for the data types that DSC functions operate on. | ||
| ms.date: 07/03/2025 | ||
| ms.date: 09/01/2026 | ||
| ms.topic: reference | ||
| title: Function data types schema reference | ||
| --- | ||
|
|
@@ -14,24 +14,28 @@ Defines the available data types that DSC functions operate on. | |
| ## Metadata | ||
|
|
||
| ```yaml | ||
| SchemaDialect : https://json-schema.org/draft/2020-12/schema | ||
| SchemaID : https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.2.0/definitions/functions/builtin/dataTypes.json | ||
| Type : string | ||
| ValidValues : [ | ||
| 'array' | ||
| 'boolean' | ||
| 'lambda' | ||
| 'null' | ||
| 'number' | ||
| 'object' | ||
| 'string' | ||
| ] | ||
| SchemaDialect: https://json-schema.org/draft/2020-12/schema | ||
| SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/definitions/functions/builtin/argKind.json | ||
|
Collaborator
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. This holds for every file in this and other PRs, but the version segment of the ID should match the specific version of DSC that we're documenting, like |
||
| Type: string | ||
| ValidValues: [ | ||
| array, | ||
| boolean, | ||
| lambda, | ||
| null, | ||
| number, | ||
| object, | ||
| string | ||
| ] | ||
| ``` | ||
|
|
||
| ## Description | ||
|
|
||
| Functions in DSC only support a subset of possible data types for input arguments and output | ||
| values. The supported data types are: | ||
| values. The `dsc function list` command reports these data types in the `acceptedArgOrderedTypes`, | ||
| `remainingArgAcceptedTypes`, and `returnTypes` properties for each function. For more information, | ||
| see [dsc function list result schema reference][01]. | ||
|
|
||
| The supported data types are: | ||
|
|
||
| - `array` - A collection of items | ||
| - `boolean` - Either `true` or `false` | ||
|
|
@@ -40,3 +44,6 @@ values. The supported data types are: | |
| - `number` - A 64-bit integer | ||
| - `object` - A collection of key-value pairs | ||
| - `string` - UTF-8 text | ||
|
|
||
| <!-- Link reference definitions --> | ||
| [01]: ../../../outputs/function/list.md | ||
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
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
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.
This represents a bug in the
dsc_repo_schemaattribute onfunctions::FunctionArgKind- we can't change the ID for the public schema between minor/patch releases without significant extra work (functionally turning the original into an alias and writing it as a one-key schema like$ref: <new_id>).Instead, we should revert the ID change to
.../dataTypes.json.