Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to JSON-Schema v6 #13

Closed
pjcozzi opened this issue Apr 23, 2017 · 7 comments
Closed

Update to JSON-Schema v6 #13

pjcozzi opened this issue Apr 23, 2017 · 7 comments

Comments

@pjcozzi
Copy link
Contributor

pjcozzi commented Apr 23, 2017

Contributions are very welcome for this one!

See KhronosGroup/glTF#929

@paulmeems-waterwatchfoundation

Any progress on this?
I just stumbled on the tool and it seems the right tool for what I need: document my json schema without having two sources of content.
But my schema is based on draft-07

@pjcozzi
Copy link
Contributor Author

pjcozzi commented Feb 2, 2019

@paulmeems-waterwatchfoundation I'm not aware of anyone working on this, but the contribution would be welcome if you want to make the changes. We may still need to keep a branch for the older JSON schema until glTF updates, KhronosGroup/glTF#929

@Relequestual
Copy link

I've been trying to do a little work with Adobe on their version of a similar tool, https://github.com/adobe/jsonschema2md
It's much more up to date, supporting draft-7.

There's still a lot to be done to make it ready for general use, but if anyone is looking to put in work to have a JSON Schema to markdown tool, I'd look there rather than here, probably.

@pjcozzi
Copy link
Contributor Author

pjcozzi commented May 24, 2019

@Relequestual we looked briefly at the Adobe tool and would consider using it for the glTF spec - which is what we originally wrote wetzel for - but I think it still needs more work before we could do so. @javagl will know the specifics.

@javagl
Copy link
Contributor

javagl commented May 24, 2019

@Relequestual This was recently addressed, to some extent, in KhronosGroup/glTF#1607

As mentioned there, I gave jsonschema2md a quick try, but have to investigate it further. The current documentation that is generated by wetzel is rather sophisticated, and we'll still have to figure out whether jsonschema2md can come close enough to this.

Currently, wetzel is somewhat hand-tailored for glTF (because that was its primary use case), and so the schema version of the glTF spec and wetzel should (or rather: have to) match.

@emackey
Copy link
Contributor

emackey commented Sep 23, 2021

OBE, see #59.

@emackey emackey closed this as completed Sep 23, 2021
@Relequestual
Copy link

@emackey Nice work in resolving this issue!

It would be great if you could declare your version support in your readme, and update the example in the readme too.

After doing so, we would be able to accept a PR to list the project here https://json-schema.org/implementations.html#documentation-generators

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants