Skip to content

Commit 9f36ab4

Browse files
(GH-708) Fix enums for kind
Prior to this change, the enums in the schema source for the `kind` property of a DSC resource wasn't updated to reflect the change for camelCasing and naming. This change updates the enumeration values and the associated documentation keywords and fixes #708.
1 parent 4ef25bc commit 9f36ab4

File tree

2 files changed

+26
-23
lines changed

2 files changed

+26
-23
lines changed

schemas/src/definitions/resourceKind.yaml

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ description: >-
99
1010
type: string
1111
enum:
12-
- Resource
13-
- Adapter
14-
- Group
15-
- Import
12+
- resource
13+
- adapter
14+
- group
15+
- importer
1616

1717
# VS Code only
1818

@@ -21,35 +21,38 @@ markdownDescription: |
2121
[_Online Documentation_][01]
2222
***
2323
24-
Defines whether the resource is a normal DSC Resource, a group resource, or an adapter
25-
resource. This property is only required for group resources.
24+
Defines how DSC should interpret the resource - as a typical resource, an adapter, a group, or an
25+
importer. This property is required for group, exporter, and importer resources.
2626
2727
DSC infers the default value for this property based on whether the [adapter][02] property is
2828
defined in the manifest:
2929
30-
- If the `adapter` property is defined in the manifest, the default `kind` is `Adapter`.
31-
- If the `adapter` property is not defined in the manifest, the default `kind` is `Resource`.
30+
- If the `adapter` property is defined in the manifest, the default `kind` is `adapter`.
31+
- If the `adapter` property is not defined in the manifest, the default `kind` is `resource`.
32+
33+
For more information about the different kinds of DSC resources, see [DSC resource kinds][01]
3234
3335
[01]: <DOCS_BASE_URL>/reference/schemas/resource/manifest/root?<DOCS_VERSION_PIN>#kind
36+
[01]: <DOCS_BASE_URL>/concepts/resources/kinds?<DOCS_VERSION_PIN>
3437
3538
markdownEnumDescriptions:
36-
- | # Resource
39+
- | # resource
3740
<!-- force a line break -->
3841
39-
Indicates that the manifest is for a standard command-based DSC Resource.
40-
- | # Adapter
42+
Indicates that the manifest is for a typical DSC command resource.
43+
- | # adapter
4144
<!-- force a line break -->
4245
43-
Indicates that the manifest is for an adapter resource that enables the use of
44-
non-command-based resources with DSC.
45-
- | # Group
46+
Indicates that the manifest is for a resource that enables the use of non-command resources
47+
with DSC.
48+
- | # group
4649
<!-- force a line break -->
4750
48-
Indicates that the manifest is for a group resource that processes an array of nested
49-
resource instances.
50-
- | # Import
51+
Indicates that the manifest is for a resource that processes an array of nested resource
52+
instances.
53+
- | # importer
5154
<!-- force a line break -->
5255
53-
Indicates that the manifest is for an import resource that resolves an external source to DSC
54-
resource instances. The resolved instances are processed as nested instances for the import
56+
Indicates that the manifest is for a resource that resolves an external source to DSC
57+
resource instances. DSC processes the resolved instances as nested instances for the importer
5558
resource.

schemas/src/resource/manifest.resolve.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ title: Resolve method
66
description: >-
77
Defines how DSC must call the DSC resource to resolve a nested configuration document from an
88
external source. Define this method for importer resources where the resource kind is set to
9-
`Import`.
9+
`importer`.
1010
1111
markdownDescription: | # VS Code only
1212
***
1313
[_Online Documentation_][01]
1414
***
1515
16-
Defines how DSC must call the DSC Resource to resolve an external source to nested DSC
17-
Configuration Document. Define this method for [importer resources][02] and set the [kind][03]
18-
property in the manifest root to `Import`.
16+
Defines how DSC must call the DSC resource to resolve an external source to nested DSC
17+
configuration document. Define this method for [importer resources][02] and set the [kind][03]
18+
property in the manifest root to `importer`.
1919
2020
DSC sends data to the command in three ways:
2121

0 commit comments

Comments
 (0)