-
Notifications
You must be signed in to change notification settings - Fork 17
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
Adds scripts for generating json schemas for humans #617
Conversation
I think the issue with
So ideally we get rid of the recursive definition (it is probably the yaml dict definition for the Because for the docs it is really unintuitive and confusing to have these references across the docs. |
I don't think we should be adjusting the spec just for the sake of fitting in with a tool for generating documentation. If we can't make this produce what we want, we can just find a different tool that does |
I was thinking we shouldn't allow infinitely deeply nested custom tool |
# Conflicts: # .github/workflows/build.yml # scripts/generate_json_schemas.py
merging this for now. it's orthogonal to everything else and marked |
Adds scripts for generating json schemas for humans, as well as an entry in
build.yaml
to do it automatically with the other docs. One option (link_to_reused_ref
) was causing encoding errors when writing out the HTML. This is marked as deprecated somewhere else in thejson-schema-for-humans
library code and it might not be in the tested paths. I can investigate that in later PRs if we care enough about it.This PR also fixes the broken link pointing to the raw json schema.