Skip to content

Commit 7826058

Browse files
michaeltlombardimichaeltlombardi
committed
(DOCS) Update schema docs for v3.1.0
1 parent 4e1b700 commit 7826058

34 files changed

+809
-305
lines changed

‎docs/reference/schemas/config/document.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: JSON schema reference for a Desired State Configuration document.
3-
ms.date: 02/28/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: DSC Configuration document schema reference
66
---
@@ -15,7 +15,7 @@ The YAML or JSON file that defines a DSC Configuration.
1515

1616
```yaml
1717
SchemaDialect: https://json-schema.org/draft/2020-12/schema
18-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.json
18+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/config/document.json
1919
Type: object
2020
```
2121
@@ -104,18 +104,42 @@ ValidValues: [
104104
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/config/document.json
105105
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/config/document.json
106106
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3/bundled/config/document.vscode.json
107+
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/config/document.json
108+
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/config/document.json
109+
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1/bundled/config/document.vscode.json
110+
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/config/document.json
111+
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/config/document.json
112+
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/bundled/config/document.vscode.json
107113
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/config/document.json
108114
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/config/document.json
109115
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0/bundled/config/document.vscode.json
116+
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/config/document.json
117+
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/config/document.json
118+
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.2/bundled/config/document.vscode.json
119+
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/config/document.json
120+
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/config/document.json
121+
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.1/bundled/config/document.vscode.json
110122
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.json
111123
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/config/document.json
112124
https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/bundled/config/document.vscode.json
113125
https://aka.ms/dsc/schemas/v3/config/document.json
114126
https://aka.ms/dsc/schemas/v3/bundled/config/document.json
115127
https://aka.ms/dsc/schemas/v3/bundled/config/document.vscode.json
128+
https://aka.ms/dsc/schemas/v3.1/config/document.json
129+
https://aka.ms/dsc/schemas/v3.1/bundled/config/document.json
130+
https://aka.ms/dsc/schemas/v3.1/bundled/config/document.vscode.json
131+
https://aka.ms/dsc/schemas/v3.1.0/config/document.json
132+
https://aka.ms/dsc/schemas/v3.1.0/bundled/config/document.json
133+
https://aka.ms/dsc/schemas/v3.1.0/bundled/config/document.vscode.json
116134
https://aka.ms/dsc/schemas/v3.0/config/document.json
117135
https://aka.ms/dsc/schemas/v3.0/bundled/config/document.json
118136
https://aka.ms/dsc/schemas/v3.0/bundled/config/document.vscode.json
137+
https://aka.ms/dsc/schemas/v3.0.2/config/document.json
138+
https://aka.ms/dsc/schemas/v3.0.2/bundled/config/document.json
139+
https://aka.ms/dsc/schemas/v3.0.2/bundled/config/document.vscode.json
140+
https://aka.ms/dsc/schemas/v3.0.1/config/document.json
141+
https://aka.ms/dsc/schemas/v3.0.1/bundled/config/document.json
142+
https://aka.ms/dsc/schemas/v3.0.1/bundled/config/document.vscode.json
119143
https://aka.ms/dsc/schemas/v3.0.0/config/document.json
120144
https://aka.ms/dsc/schemas/v3.0.0/bundled/config/document.json
121145
https://aka.ms/dsc/schemas/v3.0.0/bundled/config/document.vscode.json

‎docs/reference/schemas/config/metadata.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: JSON schema reference for metadata in a Desired State Configuration document.
3-
ms.date: 02/28/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: DSC Configuration document metadata schema
66
---
@@ -15,7 +15,7 @@ Defines a set of informational key-value pairs for the configuration.
1515

1616
```yaml
1717
SchemaDialect: https://json-schema.org/draft/2020-12/schema
18-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.metadata.json
18+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/config/document.metadata.json
1919
Type: object
2020
```
2121

‎docs/reference/schemas/config/parameter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: JSON schema reference for a parameter in a Desired State Configuration document.
3-
ms.date: 02/28/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: DSC Configuration document parameter schema
66
---
@@ -15,7 +15,7 @@ Defines runtime options for a configuration.
1515

1616
```yaml
1717
SchemaDialect: https://json-schema.org/draft/2020-12/schema
18-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.parameter.json
18+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/config/document.parameter.json
1919
Type: object
2020
```
2121

‎docs/reference/schemas/config/resource.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: JSON schema reference for a resource instance in a Desired State Configuration document.
3-
ms.date: 02/28/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: DSC Configuration document resource instance schema
66
---
@@ -15,7 +15,7 @@ Defines a DSC Resource instance in a configuration document.
1515

1616
```yaml
1717
SchemaDialect: https://json-schema.org/draft/2020-12/schema
18-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/config/document.resource.json
18+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/config/document.resource.json
1919
Type: object
2020
```
2121

‎docs/reference/schemas/definitions/message.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: JSON schema reference for a structured message returned from a 'dsc config' command.
3-
ms.date: 02/28/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: Structured message schema reference
66
---
@@ -15,7 +15,7 @@ A message emitted by a DSC Resource with associated metadata.
1515

1616
```yaml
1717
SchemaDialect: https://json-schema.org/draft/2020-12/schema
18-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/definitions/message.json
18+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/message.json
1919
Type: object
2020
```
2121

‎docs/reference/schemas/definitions/parameters/dataTypes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: JSON schema reference for valid parameter data types in a configuration document.
3-
ms.date: 02/28/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: DSC configuration parameter data type schema reference
66
---
@@ -15,7 +15,7 @@ Defines valid data types for a DSC configuration parameter
1515

1616
```yaml
1717
SchemaDialect: https://json-schema.org/draft/2020-12/schema
18-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/definitions/parameters/dataTypes.json
18+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/parameters/dataTypes.json
1919
Type: string
2020
ValidValues: [array, bool, int, object, string, secureobject, securestring]
2121
```

‎docs/reference/schemas/definitions/resourceKind.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: JSON schema reference for resource kind
3-
ms.date: 02/28/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: DSC Resource kind schema reference
66
---
@@ -15,7 +15,7 @@ Identifies whether a resource is an adapter resource, a group resource, or a nor
1515

1616
```yaml
1717
SchemaDialect: https://json-schema.org/draft/2020-12/schema
18-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/definitions/resourceKind.json
18+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/resourceKind.json
1919
Type: string
2020
ValidValues: [resource, adapter, group, importer]
2121
```

‎docs/reference/schemas/definitions/resourceType.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: JSON schema reference for a resource instance type name
3-
ms.date: 02/28/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: DSC Resource fully qualified type name schema reference
66
---
@@ -15,7 +15,7 @@ Identifies a DSC Resource.
1515

1616
```yaml
1717
SchemaDialect: https://json-schema.org/draft/2020-12/schema
18-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/definitions/resourceType.json
18+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/resourceType.json
1919
Type: string
2020
Pattern: ^\w+(\.\w+){0,2}\/\w+$
2121
```

‎docs/reference/schemas/metadata/Microsoft.DSC/properties.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: JSON schema reference for the metadata field Microsoft.DSC
3-
ms.date: 02/28/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: Microsoft.DSC metadata property schema reference
66
---
@@ -26,7 +26,7 @@ For example, `PT0.611216S` represents a duration of about `0.61` seconds.
2626

2727
```yaml
2828
SchemaDialect: https://json-schema.org/draft/2020-12/schema
29-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/metadata/Microsoft.DSC/duration.json
29+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/duration.json
3030
Type: string
3131
Format: duration
3232
```
@@ -40,7 +40,7 @@ For example: `2024-04-14T08:49:51.395686600-07:00`
4040

4141
```yaml
4242
SchemaDialect: https://json-schema.org/draft/2020-12/schema
43-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/metadata/Microsoft.DSC/endDateTime.json
43+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/endDateTime.json
4444
Type: string
4545
Format: date-time
4646
```
@@ -53,7 +53,7 @@ this value is `WhatIf` when DSC is invoked with the `--whatIf` argument.
5353

5454
```yaml
5555
SchemaDialect: https://json-schema.org/draft/2020-12/schema
56-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/metadata/Microsoft.DSC/executionType.json
56+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/executionType.json
5757
Type: string
5858
ValidValues: [Actual, WhatIf]
5959
```
@@ -65,7 +65,7 @@ Defines the operation that DSC applied to the configuration document: `Get`, `Se
6565

6666
```yaml
6767
SchemaDialect: https://json-schema.org/draft/2020-12/schema
68-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/metadata/Microsoft.DSC/operation.json
68+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/operation.json
6969
Type: string
7070
ValidValues: [Get, Set, Test, Export]
7171
```
@@ -79,7 +79,7 @@ non-elevated session.
7979

8080
```yaml
8181
SchemaDialect: https://json-schema.org/draft/2020-12/schema
82-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/metadata/Microsoft.DSC/securityContext.json
82+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/securityContext.json
8383
Type: string
8484
ValidValues: [Current, Elevated, Restricted]
8585
```
@@ -93,7 +93,7 @@ For example: `2024-04-14T08:49:51.395686600-07:00`
9393

9494
```yaml
9595
SchemaDialect: https://json-schema.org/draft/2020-12/schema
96-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/metadata/Microsoft.DSC/startDatetime.json
96+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/startDatetime.json
9797
Type: string
9898
Format: date-time
9999
```
@@ -105,7 +105,7 @@ DSC command, like `3.0.0-preview.7`.
105105

106106
```yaml
107107
SchemaDialect: https://json-schema.org/draft/2020-12/schema
108-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/metadata/Microsoft.DSC/version.json
108+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/metadata/Microsoft.DSC/version.json
109109
Type: object
110110
```
111111

‎docs/reference/schemas/outputs/config/get.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: JSON schema reference for the data returned by the 'dsc config get' command.
3-
ms.date: 02/28/2025
3+
ms.date: 07/03/2025
44
ms.topic: reference
55
title: dsc config get result schema reference
66
---
@@ -15,7 +15,7 @@ The result output from the `dsc config get` command.
1515

1616
```yaml
1717
SchemaDialect: https://json-schema.org/draft/2020-12/schema
18-
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.0.0/outputs/config/get.json
18+
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/outputs/config/get.json
1919
Type: object
2020
```
2121

0 commit comments

Comments
 (0)