Publish jsonschema with documention
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
cloud-init |
Fix Released
|
Undecided
|
Unassigned |
Bug Description
Hey there, I saw that you folks already use jsonschema so I would like to propose to publish together with the docs so IDEs can validate cloudinit files without calling an external service or code.
This is really helpful when you are writing cloud-init files because your schemas are quite rich and have good documentation in them.
I thought of using already existing tox doc to do it but it won't have the dependencies necessary to dump the schemas, do you suggest something there?
To make it work locally, I just generated the schema offline with the following command:
python -c 'import json; from cloudinit.
But if that was online it could be added to https:/
Thank you in advance!
Changed in cloud-init: | |
status: | New → Triaged |
Good feature request, our team has talked about this a bit and how we'd like to instrument publishing these versioned docs. This is on our roadmap, but haven't had runway to put this into practice yet. Agree that it's a feature we need to address and as we make progress on that we will update this bug.
Our plan prior to publishing the docs was to round out jsonschema definitions for the 50+ other uncovered cloudinit.config modules, but maybe it's not worth waiting for complete coverage before starting this publishing effort.