Skip to content

Commit ab82f25

Browse files
(SCHEMA) Address review comments.
1 parent 8a1c1a8 commit ab82f25

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

schemas/src/extensions/manifest.discover.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
$schema: https://json-schema.org/draft/2020-12/schema
33
$id: <HOST>/<PREFIX>/<VERSION>/extension/manifest.discover.yaml
44

5-
title: Get Method
5+
title: Discover operation command
66
description: >-
77
Defines how DSC must call the DSC extension to discover the paths to resource manifests.
88
markdownDescription: | # VS Code only
@@ -18,8 +18,7 @@ markdownDescription: | # VS Code only
1818
manifests instead.
1919
2020
If initial discovery finds any extension manifests that have the `discover` capability, DSC uses
21-
those extensions to recursively discover resources that aren't available in `PATH` or
22-
`DSC_RESOURCE_PATH`.
21+
those extensions to discover resources that aren't available in `PATH` or `DSC_RESOURCE_PATH`.
2322
2423
For more information about the output DSC expects the extension to emit for this command, see
2524
[Discover extension operation stdout][01].

schemas/src/extensions/manifest.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
$schema: https://json-schema.org/draft/2020-12/schema
33
$id: <HOST>/<PREFIX>/<VERSION>/extension/manifest.yaml
44

5-
title: DSC resource manifest
5+
title: DSC extension manifest
66
description: >-
77
Defines the information DSC requires to process and surface a DSC extension.
88
markdownDescription: | # VS Code only

schemas/src/extensions/stdout/discover.yaml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,16 @@ markdownDescription: | # VS Code only
1010
[_Online Documentation_][00]
1111
***
1212
13-
Represents the full path a DSC resource manifest. DSC expects every JSON Line
14-
emitted to stdout for the **Discover** operation to adhere to this schema. An extension indicates
15-
that it supports the **Discover** operation by defining the [discover][01] field in its manifest.
13+
Represents the full path a DSC resource manifest. DSC expects every JSON Line emitted to stdout
14+
for the **Discover** operation to adhere to this schema. An extension indicates that it supports
15+
the **Discover** operation by defining the [discover][01] field in its manifest.
1616
17-
The output must be a JSON object.
17+
The output must be a JSON object that defines the `manifestPath` property.
18+
19+
If the extension doesn't discover any resources, it shouldn't emit any data to stdout.
20+
21+
Unless the extension raises an error, it should exit with code `0`, even when no resources are
22+
discovered.
1823
1924
[00]: <DOCS_BASE_URL>/reference/schemas/extension/stdout/discover?<DOCS_VERSION_PIN>
2025
[01]: <DOCS_BASE_URL>/reference/schemas/extension/manifest/discover?<DOCS_VERSION_PIN>

0 commit comments

Comments
 (0)