Skip to content

Commit 2b3ce80

Browse files
(DOCS) Fix docs for resource kind
Prior to this change, the reference documentation for the `kind` property of a resource was only partially updated to reflect the newly available kinds. This change corrects the documentation to reflect the available kinds.
1 parent b64465a commit 2b3ce80

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

docs/reference/schemas/definitions/resourceKind.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,35 +9,33 @@ title: DSC Resource kind schema reference
99

1010
## Synopsis
1111

12-
Identifies whether a resource is an adapter resource, a group resource, or a normal resource.
12+
Identifies whether a resource is an adapter resource, a group resource, an importer resource, an exporter resource, or a normal resource.
1313

1414
## Metadata
1515

1616
```yaml
1717
SchemaDialect: https://json-schema.org/draft/2020-12/schema
1818
SchemaID: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/v3.1.0/definitions/resourceKind.json
1919
Type: string
20-
ValidValues: [resource, adapter, group, importer]
20+
ValidValues: [resource, adapter, group, importer, exporter]
2121
```
2222
2323
## Description
2424
25-
DSC supports three kinds of command-based DSC Resources:
25+
DSC supports several kinds of command resources:
2626
27-
- `resource` - Indicates that the manifest isn't for a group or adapter resource.
27+
- `resource` - Indicates that the manifest is for a typical resource.
2828
- `group` - Indicates that the manifest is for a [group resource](#group-resources).
2929
- `adapter` - Indicates that the manifest is for an [adapter resource](#adapter-resources).
3030
- `importer` - Indicates that the manifest is for an [importer resource](#importer-resources).
3131
- `exporter` - Indicates that the manifest is for an [exporter resource](#exporter-resources).
3232

33-
When `kind` isn't defined in the resource manifest, DSC infers the value for the property. If the
34-
`adapter` property is defined in the resource manifest, DSC infers the value of `kind` as
35-
`adapter`. If the `adapter` property isn't defined, DSC infers the value of `kind` as `resource`.
36-
DSC can't infer whether a manifest is for a group or importer resource.
33+
When `kind` isn't defined in the resource manifest for a command resource, DSC infers the value for
34+
the property. If the `adapter` property is defined in the resource manifest, DSC infers the value
35+
of `kind` as `adapter`. If the `adapter` property isn't defined, DSC infers the value of `kind` as
36+
`resource`. DSC can't infer whether a manifest is for a group, importer, or exporter resource.
3737

38-
When defining a group resource, always explicitly define the `kind` property in the manifest as
39-
`group`. When defining an importer resource, always explicitly define the `kind` property in the
40-
manifest as `importer`.
38+
When defining a group, importer, or exporter resource with a resource manifest, always explicitly define `kind`.
4139

4240
### Adapter resources
4341

0 commit comments

Comments
 (0)