vinishjail97 opened a new issue, #890:
URL: https://github.com/apache/incubator-xtable/issues/890

   ### Feature Request / Improvement
   
   Publish a JSON Schema for `datasetConfig.yaml`, generated from the 
`DatasetConfig` class rather than written by hand.
   
   ## Why
   
   Writing a valid `datasetConfig` is the first thing a new user does and the 
first place they get stuck: `sourceFormat`, `targetFormats`, `tableBasePath`, 
`tableName`, `namespace`, `partitionSpec`, and the right 
`conversionSourceProviderClass`. Today the only description of that shape is 
prose in the docs, so it drifts from the code silently.
   
   A generated schema gives three things at once:
   
   - Editors and IDEs validate and complete the file.
   - Any agent or script can check a config before running a sync, instead of 
discovering problems from a stack trace.
   - The documentation stops being a second source of truth that can go stale.
   
   PR #829 includes a hand-written `config-schema.md` for exactly this purpose. 
That is the thing to replace with something generated.
   
   ## Scope
   
   - Generate a JSON Schema from `DatasetConfig` and its nested types at build 
time.
   - Publish it as a release artifact and at a stable URL, so `$schema` 
references keep working.
   - Fail the build when the schema is out of date with the model, so it cannot 
silently drift.
   - Reference it from the docs in place of any hand-maintained field list.
   
   ### Are you willing to submit PR?
   
   - [x] Yes I am willing to submit a PR!
   
   ### Code of Conduct
   
   - [x] I agree to follow this project's [Code of 
Conduct](https://www.apache.org/foundation/policies/conduct)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to