|
1 | 1 | { |
2 | 2 | "$schema": "https://json-schema.org/draft/2020-12/schema", |
3 | 3 | "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.json", |
4 | | - "title": "DSC Configuration Document schema", |
5 | | - "description": "Describes a valid DSC Configuration Document.", |
| 4 | + "title": "DSC configuration document schema", |
| 5 | + "description": "Describes a valid DSC configuration document.", |
6 | 6 | "type": "object", |
7 | 7 | "required": [ |
8 | 8 | "$schema", |
|
11 | 11 | "properties": { |
12 | 12 | "$schema": { |
13 | 13 | "title": "Schema", |
14 | | - "description": "This property must be the canonical URL of the DSC Configuration Document schema that the document is implemented for.", |
| 14 | + "description": "Indicates the URI that resolves to the version of this schema that the document adheres to. DSC uses this property when validating and processing the configuration document.", |
15 | 15 | "type": "string", |
16 | 16 | "format": "uri", |
17 | 17 | "enum": [ |
| 18 | + "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/config/document.json", |
| 19 | + "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/config/document.json", |
| 20 | + "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/config/document.vscode.json", |
| 21 | + "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/config/document.json", |
| 22 | + "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/config/document.json", |
| 23 | + "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/config/document.vscode.json", |
18 | 24 | "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.json", |
19 | 25 | "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/config/document.json", |
20 | 26 | "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/config/document.vscode.json", |
21 | | - "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/10/config/document.json", |
22 | | - "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/10/bundled/config/document.json", |
23 | | - "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/10/bundled/config/document.vscode.json", |
24 | | - "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json", |
25 | | - "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/bundled/config/document.json", |
26 | | - "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/bundled/config/document.vscode.json" |
| 27 | + "https://aka.ms/dsc/schemas/v3/config/document.json", |
| 28 | + "https://aka.ms/dsc/schemas/v3/bundled/config/document.json", |
| 29 | + "https://aka.ms/dsc/schemas/v3/bundled/config/document.vscode.json", |
| 30 | + "https://aka.ms/dsc/schemas/v3.0/config/document.json", |
| 31 | + "https://aka.ms/dsc/schemas/v3.0/bundled/config/document.json", |
| 32 | + "https://aka.ms/dsc/schemas/v3.0/bundled/config/document.vscode.json", |
| 33 | + "https://aka.ms/dsc/schemas/v3.0.0/config/document.json", |
| 34 | + "https://aka.ms/dsc/schemas/v3.0.0/bundled/config/document.json", |
| 35 | + "https://aka.ms/dsc/schemas/v3.0.0/bundled/config/document.vscode.json" |
27 | 36 | ] |
28 | 37 | }, |
29 | 38 | "parameters": { |
30 | | - "title": "DSC Configuration document parameters", |
| 39 | + "title": "DSC configuration document parameters", |
31 | 40 | "description": "Defines runtime options for the configuration. Users and integrating tools can override use the defined parameters to pass alternate values to the configuration.", |
32 | 41 | "type": "object", |
33 | 42 | "additionalProperties": { |
|
40 | 49 | "type": "object" |
41 | 50 | }, |
42 | 51 | "resources": { |
43 | | - "title": "DSC Configuration document resources", |
44 | | - "description": "Defines a list of DSC Resource instances for the configuration to manage.", |
| 52 | + "title": "DSC configuration document resources", |
| 53 | + "description": "Defines a list of DSC resource instances for the configuration to manage.", |
45 | 54 | "type": "array", |
46 | | - "minItems": 1, |
| 55 | + "minItems": 0, |
47 | 56 | "items": { |
48 | 57 | "$ref": "/PowerShell/DSC/main/schemas/v3.0.0/config/document.resource.json" |
49 | 58 | } |
|
57 | 66 | "$schema": "https://json-schema.org/draft/2020-12/schema", |
58 | 67 | "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.parameter.json", |
59 | 68 | "title": "Parameter", |
60 | | - "description": "Defines a runtime option for a DSC Configuration Document.", |
| 69 | + "description": "Defines a runtime option for a DSC configuration document.", |
61 | 70 | "type": "object", |
62 | 71 | "required": [ |
63 | 72 | "type" |
|
284 | 293 | "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.resource.json": { |
285 | 294 | "$schema": "https://json-schema.org/draft/2020-12/schema", |
286 | 295 | "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.resource.json", |
287 | | - "title": "DSC Resource instance", |
288 | | - "description": "Defines an instance of a DSC Resource in a configuration.", |
| 296 | + "title": "DSC resource instance", |
| 297 | + "description": "Defines an instance of a DSC resource in a configuration.", |
289 | 298 | "type": "object", |
290 | 299 | "required": [ |
291 | 300 | "type", |
|
300 | 309 | }, |
301 | 310 | "dependsOn": { |
302 | 311 | "title": "Instance depends on", |
303 | | - "description": "Defines a list of DSC Resource instances that DSC must successfully process before processing this instance. Each value for this property must be the `resourceID()` lookup for another instance in the configuration. Multiple instances can depend on the same instance, but every dependency for an instance must be unique in that instance's `dependsOn` property.", |
| 312 | + "description": "Defines a list of DSC resource instances that DSC must successfully process before processing this instance. Each value for this property must be the `resourceID()` lookup for another instance in the configuration. Multiple instances can depend on the same instance, but every dependency for an instance must be unique in that instance's `dependsOn` property.", |
304 | 313 | "type": "array", |
305 | 314 | "items": { |
306 | 315 | "type": "string", |
|
310 | 319 | }, |
311 | 320 | "properties": { |
312 | 321 | "title": "Managed instance properties", |
313 | | - "description": "Defines the properties of the DSC Resource this instance manages. This property's value must be an object. DSC validates the property's value against the DSC Resource's schema.", |
| 322 | + "description": "Defines the properties of the DSC resource this instance manages. This property's value must be an object. DSC validates the property's value against the DSC resource's schema.", |
314 | 323 | "type": "object" |
315 | 324 | } |
316 | 325 | } |
|
356 | 365 | "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/definitions/parameters/validValueTypes.json": { |
357 | 366 | "$schema": "https://json-schema.org/draft/2020-12/schema", |
358 | 367 | "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/definitions/parameters/validValueTypes.json", |
359 | | - "$comment": "This schema fragment makes it a little easier to compose the valid properties\nfor DSC Configuration document parameters. As-written, values must be one of\nthose on this list - the schema definition for dataType excludes `null` and\nnumbers with fractional parts, like `3.5`.\n", |
| 368 | + "$comment": "This schema fragment makes it a little easier to compose the valid properties\nfor DSC configuration document parameters. As-written, values must be one of\nthose on this list - the schema definition for dataType excludes `null` and\nnumbers with fractional parts, like `3.5`.\n", |
360 | 369 | "type": [ |
361 | 370 | "string", |
362 | 371 | "integer", |
|
368 | 377 | "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/definitions/resourceType.json": { |
369 | 378 | "$schema": "https://json-schema.org/draft/2020-12/schema", |
370 | 379 | "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/definitions/resourceType.json", |
371 | | - "title": "DSC Resource fully qualified type name", |
372 | | - "description": "The namespaced name of the DSC Resource, using the syntax:\n\nowner[.group][.area]/name\n\nFor example:\n\n - Microsoft.SqlServer/Database\n - Microsoft.SqlServer.Database/User\n", |
| 380 | + "title": "DSC resource fully qualified type name", |
| 381 | + "description": "The namespaced name of the DSC resource, using the syntax:\n\nowner[.group][.area]/name\n\nFor example:\n\n - Microsoft.SqlServer/Database\n - Microsoft.SqlServer.Database/User\n", |
373 | 382 | "type": "string", |
374 | 383 | "pattern": "^\\w+(\\.\\w+){0,2}\\/\\w+$" |
375 | 384 | }, |
376 | 385 | "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/definitions/instanceName.json": { |
377 | 386 | "$schema": "https://json-schema.org/draft/2020-12/schema", |
378 | 387 | "$id": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/definitions/instanceName.json", |
379 | 388 | "title": "Instance name", |
380 | | - "description": "The short, human-readable name for a DSC Resource instance. Must be unique within a DSC Configuration document. Must be a non-empty string containing only letters, numbers, and spaces.", |
| 389 | + "description": "The short, human-readable name for a DSC resource instance. Must be unique within a DSC Configuration document. Must be a non-empty string containing only letters, numbers, and spaces.", |
381 | 390 | "type": "string", |
382 | 391 | "pattern": "^[a-zA-Z0-9 ]+$", |
383 | 392 | "minLength": 1 |
|
0 commit comments