Skip to content

(SCHEMA) Update schemas for v3.1.0 release #890

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

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

michaeltlombardi
Copy link
Collaborator

PR Summary

This changeset includes:

  • Updating and regenerating the schemas for the v3.0.1 and v3.0.2 releases. Neither of these releases required any schema changes except to extend the sets of valid schema URIs for resource manifests and configuration documents.
  • Updating and regenerating the schemas for the v3.1.0 release. This release required changes to support the addition of the exporter resource kind (and associated required output for the Export operation) and the addition of the extension manifest and expected output for the Discover extension operation.

Until the changes for v3.1.0 are reviewed, I haven't regenerated the schemas to reduce the noise in the commits. After those changes are reviewed, I'll regenerate the schemas for v3.1.0.

PR Context

$schema: https://json-schema.org/draft/2020-12/schema
$id: <HOST>/<PREFIX>/<VERSION>/extension/manifest.discover.yaml

title: Get Method
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be Discover Method?

manifests instead.
If initial discovery finds any extension manifests that have the `discover` capability, DSC uses
those extensions to recursively discover resources that aren't available in `PATH` or
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you should remove the word recursively here

$schema: https://json-schema.org/draft/2020-12/schema
$id: <HOST>/<PREFIX>/<VERSION>/extension/manifest.yaml

title: DSC resource manifest
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DSC extension manifest

emitted to stdout for the **Discover** operation to adhere to this schema. An extension indicates
that it supports the **Discover** operation by defining the [discover][01] field in its manifest.
The output must be a JSON object.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It may be worthwhile that if nothing is found, then emit nothing to STDOUT and have a 0 exit code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants