Search code examples
jsonyamljsonschema

How to distribute JSON Schema to users?

I am working on a Python application that gets a YAML file from users as input. The YAML file is pretty complex; therefore, I have a JSON Schema for it. However, I don't know how to distribute this JSON Schema to potential users of my application.

Should I create extensions for popular IDEs? Or should I give step-by-step tutorials on how to set up the JSON schema in their IDEs? I would like to find the most user-friendly way of doing it.

Solution

  • You can provide it a multitude of ways.

    • serve it statically from an endpoint e.g. www.example.com/schema using the header content-type: application/schema+json
    • You can host it in a git repo
    • You can host it on your own site
    • You can add it to www.schemastore.org
    • You can bundle it with your package