Skip to content

Commit 97c2418

Browse files
(SCHEMA) Update schema source for terminology
This change updates casing and terms to match the glossary. These changes are colocated to make reviewing actual schema changes simpler.
1 parent ea2d0f3 commit 97c2418

36 files changed

+199
-198
lines changed

schemas/src/config/document.parameter.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
$schema: https://json-schema.org/draft/2020-12/schema
33
$id: <HOST>/<PREFIX>/<VERSION>/config/document.parameter.yaml
44
title: Parameter
5-
description: Defines a runtime option for a DSC Configuration Document.
5+
description: Defines a runtime option for a DSC configuration document.
66

77
markdownDescription: | # VS Code only
88
***
99
[_Online Documentation_][01]
1010
***
1111
12-
Defines a runtime option for a DSC Configuration Document.
12+
Defines a runtime option for a DSC configuration document.
1313
1414
[01]: <DOCS_BASE_URL>/reference/schemas/config/parameter?<DOCS_VERSION_PIN>
1515

schemas/src/config/document.resource.yaml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# yaml-language-server: $schema=https://json-schema.org/draft/2020-12/schema
22
$schema: https://json-schema.org/draft/2020-12/schema
33
$id: <HOST>/<PREFIX>/<VERSION>/config/document.resource.yaml
4-
title: DSC Resource instance
5-
description: Defines an instance of a DSC Resource in a configuration.
4+
title: DSC resource instance
5+
description: Defines an instance of a DSC resource in a configuration.
66

77
type: object
88
required:
@@ -16,7 +16,7 @@ properties:
1616
dependsOn:
1717
title: Instance depends on
1818
description: >-
19-
Defines a list of DSC Resource instances that DSC must successfully process before processing
19+
Defines a list of DSC resource instances that DSC must successfully process before processing
2020
this instance. Each value for this property must be the `resourceID()` lookup for another
2121
instance in the configuration. Multiple instances can depend on the same instance, but every
2222
dependency for an instance must be unique in that instance's `dependsOn` property.
@@ -47,7 +47,7 @@ properties:
4747
[_Online Documentation_][01]
4848
***
4949
50-
Defines a list of DSC Resource instances that DSC must successfully process before processing
50+
Defines a list of DSC resource instances that DSC must successfully process before processing
5151
this instance. Each value for this property must be the `resourceID()` lookup for another
5252
instance in the configuration. Multiple instances can depend on the same instance, but every
5353
dependency for an instance must be unique in that instance's `dependsOn` property.
@@ -67,17 +67,17 @@ properties:
6767
properties:
6868
title: Managed instance properties
6969
description: >-
70-
Defines the properties of the DSC Resource this instance manages. This property's value must
71-
be an object. DSC validates the property's value against the DSC Resource's schema.
70+
Defines the properties of the DSC resource this instance manages. This property's value must
71+
be an object. DSC validates the property's value against the DSC resource's schema.
7272
type: object
7373
# VS Code only
7474
markdownDescription: |
7575
***
7676
[_Online Documentation_][01]
7777
***
7878
79-
Defines the properties of the DSC Resource this instance manages. This property's value must
80-
be an object. DSC validates the property's value against the DSC Resource's schema.
79+
Defines the properties of the DSC resource this instance manages. This property's value must
80+
be an object. DSC validates the property's value against the DSC resource's schema.
8181
8282
[01]: <DOCS_BASE_URL>/reference/schemas/config/resource?<DOCS_VERSION_PIN>#properties-1
8383
@@ -87,9 +87,9 @@ markdownDescription: |
8787
[_Online Documentation_][01]
8888
***
8989
90-
Defines an instance of a DSC Resource in a configuration.
90+
Defines an instance of a DSC resource in a configuration.
9191
92-
The `resources` property of a DSC Configuration document always includes at least one DSC Resource
92+
The `resources` property of a DSC configuration document always includes at least one DSC resource
9393
instance. Together, the instances in a configuration define the desired state that DSC can get,
9494
test, and set on a machine.
9595
@@ -98,7 +98,7 @@ markdownDescription: |
9898
defaultSnippets:
9999
- label: ' New resource instance'
100100
markdownDescription: |-
101-
Defines a new instance of a DSC Resource for the configuration.
101+
Defines a new instance of a DSC resource for the configuration.
102102
103103
```yaml
104104
type: owner[.group][.area]/name
@@ -114,7 +114,7 @@ defaultSnippets:
114114

115115
- label: ' New dependent resource instance'
116116
markdownDescription: |-
117-
Defines a new instance of a DSC Resource for the configuration that depends on another
117+
Defines a new instance of a DSC resource for the configuration that depends on another
118118
instance.
119119
120120
```yaml

schemas/src/config/document.yaml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# yaml-language-server: $schema=https://json-schema.org/draft/2020-12/schema
22
$schema: https://json-schema.org/draft/2020-12/schema
33
$id: <HOST>/<PREFIX>/<VERSION>/config/document.yaml
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.
66

77
markdownDescription: | # VS Code only
88
***
99
[_Online Documentation_][01]
1010
***
1111
12-
Describes a valid DSC Configuration Document.
12+
Describes a valid DSC configuration document.
1313
14-
DSC Configurations enable users to define state by combining different DSC Resources. A
14+
DSC configurations enable users to define state by combining different DSC resources. A
1515
configuration document uses parameters and variables to pass to a set of one or more resources
1616
that define a desired state.
1717
@@ -26,7 +26,7 @@ properties:
2626
$schema:
2727
title: Schema
2828
description: >-
29-
This property must be the canonical URL of the DSC Configuration Document schema that the
29+
This property must be the canonical URL of the DSC configuration document schema that the
3030
document is implemented for.
3131
type: string
3232
format: uri
@@ -46,7 +46,7 @@ properties:
4646
[_Online Documentation_][01]
4747
***
4848
49-
This property must be the canonical URL of the DSC Configuration Document schema that the
49+
This property must be the canonical URL of the DSC configuration document schema that the
5050
document is implemented for.
5151
5252
For every version of the schema, there are three valid urls:
@@ -206,7 +206,7 @@ properties:
206206
> unexpected ways.
207207
208208
parameters:
209-
title: DSC Configuration document parameters
209+
title: DSC configuration document parameters
210210
description: >-
211211
Defines runtime options for the configuration. Users and integrating tools can override use
212212
the defined parameters to pass alternate values to the configuration.
@@ -318,8 +318,8 @@ properties:
318318
- ${3:secondValue}
319319

320320
resources:
321-
title: DSC Configuration document resources
322-
description: Defines a list of DSC Resource instances for the configuration to manage.
321+
title: DSC configuration document resources
322+
description: Defines a list of DSC resource instances for the configuration to manage.
323323
type: array
324324
minItems: 1
325325
items:
@@ -330,7 +330,7 @@ properties:
330330
[_Online Documentation_][01]
331331
***
332332
333-
Defines a list of DSC Resource instances for the configuration to manage.
333+
Defines a list of DSC resource instances for the configuration to manage.
334334
335335
[01]: <DOCS_BASE_URL>/reference/schemas/config/document?<DOCS_VERSION_PIN>#resources
336336

schemas/src/definitions/hadErrors.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ $id: <HOST>/<PREFIX>/<VERSION>/definitions/hadErrors.yaml
44

55
title: Had Errors
66
description: >-
7-
Indicates whether any of the DSC Resources returned a non-zero exit code.
7+
Indicates whether any of the DSC resources returned a non-zero exit code.
88
type: boolean

schemas/src/definitions/instanceName.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ $id: <HOST>/<PREFIX>/<VERSION>/definitions/instanceName.yaml
44

55
title: Instance name
66
description: >-
7-
The short, human-readable name for a DSC Resource instance. Must be unique within a DSC
7+
The short, human-readable name for a DSC resource instance. Must be unique within a DSC
88
Configuration document. Must be a non-empty string containing only letters, numbers, and spaces.
99
type: string
1010
pattern: ^[a-zA-Z0-9 ]+$
@@ -19,8 +19,8 @@ markdownDescription: |
1919
[_Online Documentation_][01]
2020
***
2121
22-
Defines the short, human-readable name for a DSC Resource instance. This property must be unique
23-
within a DSC Configuration document. If any resource instances share the same name, DSC raises an
22+
Defines the short, human-readable name for a DSC resource instance. This property must be unique
23+
within a DSC configuration document. If any resource instances share the same name, DSC raises an
2424
error.
2525
2626
The instance name must be a non-empty string containing only letters, numbers, and spaces.

schemas/src/definitions/message.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ $id: <HOST>/<PREFIX>/<VERSION>/definitions/message.yaml
44

55
title: Message
66
description: >-
7-
A message emitted by a DSC Resource with associated metadata.
7+
A message emitted by a DSC resource with associated metadata.
88
99
type: object
1010
required:
@@ -17,14 +17,14 @@ properties:
1717
title: Message source instance name
1818
description: >-
1919
The short, human-readable name for the instance that emitted the message,
20-
as defined in the DSC Configuration Document.
20+
as defined in the DSC configuration document.
2121
type: string
2222
type:
2323
$ref: /<PREFIX>/<VERSION>/definitions/resourceType.yaml
2424
message:
2525
title: Message content
2626
description: >-
27-
The actual content of the message as emitted by the DSC Resource.
27+
The actual content of the message as emitted by the DSC resource.
2828
type: string
2929
minLength: 1
3030
level:

schemas/src/definitions/messages.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ $id: <HOST>/<PREFIX>/<VERSION>/definitions/messages.yaml
44

55
title: Messages
66
description: >-
7-
A list of structured messages emitted by the DSC Resources during an
7+
A list of structured messages emitted by the DSC resources during an
88
operation.
99
1010
type: array

schemas/src/definitions/parameters/dataTypes.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ markdownEnumDescriptions:
7575
- | # int
7676
_Integer values are numbers without a fractional part._
7777
78-
> Integer values may be limited by integrating tools or the DSC Resources they're used with.
78+
> Integer values may be limited by integrating tools or the DSC resources they're used with.
7979
> DSC itself supports integer values between `-9223372036854775808` and `9223372036854775807`.
8080
>
8181
> For more information, see the [_Online Documentation_][01].

schemas/src/definitions/parameters/validValueTypes.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ $id: <HOST>/<PREFIX>/<VERSION>/definitions/parameters/validValueTypes.yaml
44

55
$comment: |
66
This schema fragment makes it a little easier to compose the valid properties
7-
for DSC Configuration document parameters. As-written, values must be one of
7+
for DSC configuration document parameters. As-written, values must be one of
88
those on this list - the schema definition for dataType excludes `null` and
99
numbers with fractional parts, like `3.5`.
1010

schemas/src/definitions/resourceKind.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ $id: <HOST>/<PREFIX>/<VERSION>/definitions/resourceKind.yaml
44

55
title: Resource kind
66
description: >-
7-
Defines whether the resource is a normal DSC Resource, a group resource, or an adapter
7+
Defines whether the resource is a normal DSC resource, a group resource, or an adapter
88
resource. This property is only required for group resources.
99
1010
type: string

0 commit comments

Comments
 (0)