← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1917626] [NEW] Publish jsonschema with documention

 

Public bug reported:

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.config.schema import get_schema; print(json.dumps(get_schema(), indent=4))'
But if that was online it could be added to https://www.schemastore.org/ which seems to be a central location for a bunch of schemas.
Thank you in advance!

** Affects: cloud-init
     Importance: Undecided
         Status: New

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to cloud-init.
https://bugs.launchpad.net/bugs/1917626

Title:
  Publish jsonschema with documention

Status in cloud-init:
  New

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.config.schema import get_schema; print(json.dumps(get_schema(), indent=4))'
  But if that was online it could be added to https://www.schemastore.org/ which seems to be a central location for a bunch of schemas.
  Thank you in advance!

To manage notifications about this bug go to:
https://bugs.launchpad.net/cloud-init/+bug/1917626/+subscriptions


Follow ups