Skip to content

Commit e741bae

Browse files
michaeltlombardimichaeltlombardi
committed
(SCHEMA) Regenerate schemas for v3.1.0
1 parent c366055 commit e741bae

File tree

300 files changed

+40304
-134
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

300 files changed

+40304
-134
lines changed

‎schemas/v3.1.0/bundled/config/document.json

Lines changed: 431 additions & 0 deletions
Large diffs are not rendered by default.

‎schemas/v3.1.0/bundled/config/document.vscode.json

Lines changed: 683 additions & 0 deletions
Large diffs are not rendered by default.

‎schemas/v3.1.0/bundled/extension/manifest.json

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
{
2+
"$schema": "https://json-schema.org/draft/2020-12/schema",
3+
"$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/extension/manifest.json",
4+
"title": "DSC extension manifest",
5+
"description": "Defines the information DSC requires to process and surface a DSC extension.",
6+
"type": "object",
7+
"required": [
8+
"$schema",
9+
"type",
10+
"version"
11+
],
12+
"properties": {
13+
"$schema": {
14+
"title": "Manifest Schema",
15+
"description": "This property must be the canonical URL of the Command-based DSC resource Manifest schema that the manifest is implemented for.",
16+
"type": "string",
17+
"format": "uri",
18+
"enum": [
19+
"https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/extension/manifest.json",
20+
"https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/extension/manifest.json",
21+
"https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/extension/manifest.vscode.json",
22+
"https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/extension/manifest.json",
23+
"https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/extension/manifest.json",
24+
"https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/extension/manifest.vscode.json",
25+
"https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/extension/manifest.json",
26+
"https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/extension/manifest.json",
27+
"https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/extension/manifest.vscode.json",
28+
"https://aka.ms/dsc/schemas/v3/extension/manifest.json",
29+
"https://aka.ms/dsc/schemas/v3/bundled/extension/manifest.json",
30+
"https://aka.ms/dsc/schemas/v3/bundled/extension/manifest.vscode.json",
31+
"https://aka.ms/dsc/schemas/v3.1/extension/manifest.json",
32+
"https://aka.ms/dsc/schemas/v3.1/bundled/extension/manifest.json",
33+
"https://aka.ms/dsc/schemas/v3.1/bundled/extension/manifest.vscode.json",
34+
"https://aka.ms/dsc/schemas/v3.1.0/extension/manifest.json",
35+
"https://aka.ms/dsc/schemas/v3.1.0/bundled/extension/manifest.json",
36+
"https://aka.ms/dsc/schemas/v3.1.0/bundled/extension/manifest.vscode.json"
37+
]
38+
},
39+
"type": {
40+
"$ref": "/PowerShell/DSC/main/schemas/v3.1.0/definitions/extensionType.json"
41+
},
42+
"version": {
43+
"title": "Extension Semantic Version",
44+
"description": "The semantic version (semver) of the DSC extension.",
45+
"$ref": "/PowerShell/DSC/main/schemas/v3.1.0/definitions/semver.json"
46+
},
47+
"description": {
48+
"title": "Extension description",
49+
"description": "A short synopsis of the DSC extension's purpose.",
50+
"type": "string"
51+
},
52+
"tags": {
53+
"title": "Tags",
54+
"description": "Defines a list of searchable terms for the extension.",
55+
"type": "array",
56+
"uniqueItems": true,
57+
"items": {
58+
"type": "string",
59+
"pattern": "^\\w+$"
60+
}
61+
},
62+
"discover": {
63+
"$ref": "/PowerShell/DSC/main/schemas/v3.1.0/extension/manifest.discover.json"
64+
},
65+
"exitCodes": {
66+
"title": "Exit codes",
67+
"description": "This property defines a map of valid exit codes for the DSC extension. DSC always interprets exit code `0` as a successful operation and any other exit code as an error. Use this property to indicate human-readable semantic meanings for the DSC extension's exit codes.",
68+
"type": "object",
69+
"propertyNames": {
70+
"pattern": "^-?[0-9]+$"
71+
},
72+
"patternProperties": {
73+
"^-?[0-9]+$": {
74+
"type": "string"
75+
}
76+
},
77+
"unevaluatedProperties": false,
78+
"default": {
79+
"0": "Success",
80+
"1": "Error"
81+
},
82+
"examples": [
83+
{
84+
"0": "Success",
85+
"1": "Invalid parameter",
86+
"2": "Invalid input",
87+
"3": "JSON serialization failed"
88+
}
89+
]
90+
}
91+
},
92+
"$defs": {
93+
"https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/extensionType.json": {
94+
"$schema": "https://json-schema.org/draft/2020-12/schema",
95+
"$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/extensionType.json",
96+
"title": "DSC extension fully qualified type name",
97+
"description": "The namespaced name of the DSC extension, using the syntax:\n\n<owner>[.<group>][.<area>][.<subarea>]/<name>\n\nFor example:\n\n - Microsoft/Example\n - Microsoft.DSC/Docs\n - Microsoft.Windows.Appx/Discover\n",
98+
"type": "string",
99+
"pattern": "^\\w+(\\.\\w+){0,3}\\/\\w+$"
100+
},
101+
"https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/semver.json": {
102+
"$schema": "https://json-schema.org/draft/2020-12/schema",
103+
"$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/semver.json",
104+
"type": "string",
105+
"title": "Semantic Version",
106+
"description": "A valid semantic version (semver) string.\n\nFor reference, see https://semver.org/\n",
107+
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
108+
"$comment": "A valid semantic version ([semver][01]) string.\n\nThis value uses the [suggested regular expression][02] to validate whether the string is valid\nsemver. This is the same pattern, made multi-line for easier readability:\n\n```regex\n^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\n(?:-(\n (?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)\n (?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))\n*))?\n(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$\n```\n\nThe first line matches the `major.minor.patch` components of the version. The middle lines match\nthe pre-release components. The last line matches the build metadata component.\n\n[01]: https://semver.org/\n[02]: https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string\n"
109+
},
110+
"https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/extension/manifest.discover.json": {
111+
"$schema": "https://json-schema.org/draft/2020-12/schema",
112+
"$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/extension/manifest.discover.json",
113+
"title": "Discover operation command",
114+
"description": "Defines how DSC must call the DSC extension to discover the paths to resource manifests.",
115+
"type": "object",
116+
"required": [
117+
"executable"
118+
],
119+
"properties": {
120+
"executable": {
121+
"$ref": "/PowerShell/DSC/main/schemas/v3.1.0/definitions/commandExecutable.json"
122+
},
123+
"args": {
124+
"$ref": "/PowerShell/DSC/main/schemas/v3.1.0/definitions/commandArgs.json"
125+
}
126+
}
127+
},
128+
"https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/commandExecutable.json": {
129+
"$schema": "https://json-schema.org/draft/2020-12/schema",
130+
"$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/commandExecutable.json",
131+
"title": "Executable Command Name",
132+
"description": "The name of the command to run.",
133+
"type": "string"
134+
},
135+
"https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/commandArgs.json": {
136+
"$schema": "https://json-schema.org/draft/2020-12/schema",
137+
"$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/commandArgs.json",
138+
"title": "Executable Command Arguments",
139+
"description": "The list of arguments to pass to the command. The arguments can be any number of strings. If you want to pass the JSON object representing the property bag for the resource to an argument, you can define a single item in the array as a JSON object, indicating the name of the argument with the `jsonInputArg` string property and whether the argument is mandatory for the command with the `mandatory` boolean property.",
140+
"type": "array",
141+
"items": {
142+
"oneOf": [
143+
{
144+
"type": "string",
145+
"title": "String argument",
146+
"description": "Any item in the argument array can be a string representing a static argument to pass to the command."
147+
},
148+
{
149+
"type": "object",
150+
"title": "JSON input argument",
151+
"description": "Defines an argument for the command that accepts the JSON input object as a string. DSC passes the JSON input to the named argument when available. You can define the `mandatory` property to indicate whether DSC should always pass the argument to the command, even when there's no JSON input for the command. In that case, DSC passes an empty string to the JSON input argument. You can only define one JSON input argument per arguments array.",
152+
"required": [
153+
"jsonInputArg"
154+
],
155+
"unevaluatedProperties": false,
156+
"properties": {
157+
"jsonInputArg": {
158+
"title": "JSON input argument name",
159+
"description": "Defines the argument that accepts the JSON property bag for the resource as input.",
160+
"type": "string"
161+
},
162+
"mandatory": {
163+
"title": "Mandatory argument",
164+
"description": "Defines whether the argument is mandatory. If this property is set to `true`, DSC passes an empty string when no JSON input is provided. The default value is `false`.",
165+
"type": "boolean",
166+
"default": false
167+
}
168+
}
169+
}
170+
]
171+
}
172+
}
173+
}
174+
}

0 commit comments

Comments
 (0)