docs: Add JSON Schema information #8011
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds information about JSON Schema for
meltano.yml
and how to use it for things like generating Pydantic types and such. This process is useful for embedded ETL circumstances where you're modifyingmeltano.yml
at runtime and want to validate the format of each write to fail fast, like we are at Akkio. Another potential use case for even non-embedded use cases is to add an automated test that validates yourmeltano.yml
, which prevents you from pushing a broken file to higher environments or even production.Attempted to follow PR guidelines at https://docs.meltano.com/contribute/merge, including semver PR name.