Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(SCHEMAS) FIx/update for v3.0.0 release #734

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
4 changes: 2 additions & 2 deletions schemas/src/config/document.parameter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
$schema: https://json-schema.org/draft/2020-12/schema
$id: <HOST>/<PREFIX>/<VERSION>/config/document.parameter.yaml
title: Parameter
description: Defines a runtime option for a DSC Configuration Document.
description: Defines a runtime option for a DSC configuration document.

markdownDescription: | # VS Code only
***
[_Online Documentation_][01]
***

Defines a runtime option for a DSC Configuration Document.
Defines a runtime option for a DSC configuration document.

[01]: <DOCS_BASE_URL>/reference/schemas/config/parameter?<DOCS_VERSION_PIN>

Expand Down
24 changes: 12 additions & 12 deletions schemas/src/config/document.resource.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# yaml-language-server: $schema=https://json-schema.org/draft/2020-12/schema
$schema: https://json-schema.org/draft/2020-12/schema
$id: <HOST>/<PREFIX>/<VERSION>/config/document.resource.yaml
title: DSC Resource instance
description: Defines an instance of a DSC Resource in a configuration.
title: DSC resource instance
description: Defines an instance of a DSC resource in a configuration.

type: object
required:
Expand All @@ -16,7 +16,7 @@ properties:
dependsOn:
title: Instance depends on
description: >-
Defines a list of DSC Resource instances that DSC must successfully process before processing
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.
Expand Down Expand Up @@ -47,7 +47,7 @@ properties:
[_Online Documentation_][01]
***

Defines a list of DSC Resource instances that DSC must successfully process before processing
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.
Expand All @@ -67,17 +67,17 @@ properties:
properties:
title: Managed instance properties
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.
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.
type: object
# VS Code only
markdownDescription: |
***
[_Online Documentation_][01]
***

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.
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.

[01]: <DOCS_BASE_URL>/reference/schemas/config/resource?<DOCS_VERSION_PIN>#properties-1

Expand All @@ -87,9 +87,9 @@ markdownDescription: |
[_Online Documentation_][01]
***

Defines an instance of a DSC Resource in a configuration.
Defines an instance of a DSC resource in a configuration.

The `resources` property of a DSC Configuration document always includes at least one DSC Resource
The `resources` property of a DSC configuration document always includes at least one DSC resource
instance. Together, the instances in a configuration define the desired state that DSC can get,
test, and set on a machine.

Expand All @@ -98,7 +98,7 @@ markdownDescription: |
defaultSnippets:
- label: ' New resource instance'
markdownDescription: |-
Defines a new instance of a DSC Resource for the configuration.
Defines a new instance of a DSC resource for the configuration.

```yaml
type: owner[.group][.area]/name
Expand All @@ -114,7 +114,7 @@ defaultSnippets:

- label: ' New dependent resource instance'
markdownDescription: |-
Defines a new instance of a DSC Resource for the configuration that depends on another
Defines a new instance of a DSC resource for the configuration that depends on another
instance.

```yaml
Expand Down
340 changes: 262 additions & 78 deletions schemas/src/config/document.yaml

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion schemas/src/definitions/hadErrors.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ $id: <HOST>/<PREFIX>/<VERSION>/definitions/hadErrors.yaml

title: Had Errors
description: >-
Indicates whether any of the DSC Resources returned a non-zero exit code.
Indicates whether any of the DSC resources returned a non-zero exit code.
type: boolean
6 changes: 3 additions & 3 deletions schemas/src/definitions/instanceName.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ $id: <HOST>/<PREFIX>/<VERSION>/definitions/instanceName.yaml

title: Instance name
description: >-
The short, human-readable name for a DSC Resource instance. Must be unique within a DSC
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.
type: string
pattern: ^[a-zA-Z0-9 ]+$
Expand All @@ -19,8 +19,8 @@ markdownDescription: |
[_Online Documentation_][01]
***

Defines the short, human-readable name for a DSC Resource instance. This property must be unique
within a DSC Configuration document. If any resource instances share the same name, DSC raises an
Defines the short, human-readable name for a DSC resource instance. This property must be unique
within a DSC configuration document. If any resource instances share the same name, DSC raises an
error.

The instance name must be a non-empty string containing only letters, numbers, and spaces.
Expand Down
6 changes: 3 additions & 3 deletions schemas/src/definitions/message.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ $id: <HOST>/<PREFIX>/<VERSION>/definitions/message.yaml

title: Message
description: >-
A message emitted by a DSC Resource with associated metadata.
A message emitted by a DSC resource with associated metadata.

type: object
required:
Expand All @@ -17,14 +17,14 @@ properties:
title: Message source instance name
description: >-
The short, human-readable name for the instance that emitted the message,
as defined in the DSC Configuration Document.
as defined in the DSC configuration document.
type: string
type:
$ref: /<PREFIX>/<VERSION>/definitions/resourceType.yaml
message:
title: Message content
description: >-
The actual content of the message as emitted by the DSC Resource.
The actual content of the message as emitted by the DSC resource.
type: string
minLength: 1
level:
Expand Down
2 changes: 1 addition & 1 deletion schemas/src/definitions/messages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ $id: <HOST>/<PREFIX>/<VERSION>/definitions/messages.yaml

title: Messages
description: >-
A list of structured messages emitted by the DSC Resources during an
A list of structured messages emitted by the DSC resources during an
operation.

type: array
Expand Down
2 changes: 1 addition & 1 deletion schemas/src/definitions/parameters/dataTypes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ markdownEnumDescriptions:
- | # int
_Integer values are numbers without a fractional part._

> Integer values may be limited by integrating tools or the DSC Resources they're used with.
> Integer values may be limited by integrating tools or the DSC resources they're used with.
> DSC itself supports integer values between `-9223372036854775808` and `9223372036854775807`.
>
> For more information, see the [_Online Documentation_][01].
Expand Down
2 changes: 1 addition & 1 deletion schemas/src/definitions/parameters/validValueTypes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ $id: <HOST>/<PREFIX>/<VERSION>/definitions/parameters/validValueTypes.yaml

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

Expand Down
Loading