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

Adding title and description to JSON Schema for Fields #96

Open
madelyneriksen opened this issue Dec 31, 2019 · 0 comments
Open

Adding title and description to JSON Schema for Fields #96

madelyneriksen opened this issue Dec 31, 2019 · 0 comments

Comments

@madelyneriksen
Copy link

I'm using JSON schema with React JSONSchema Forms to create forms automatically.

Currently, typesystem doesn't emit metadata like title or description into the rendered schema for fields (or schema objects). It does use those parameters for rendering forms, so I think a case can be made for adding it to the generated json schema too if present.

I'd be happy to open a PR for this, if it's behaviour that typesystem can or should have. I've already added this functionality to a vendored version. As far as I can tell, all that's required is adding checks to typesystem/json_schema.pyto the serialization function. I'm not sure if we'd want the same functionality in the de-serialization function.

P.S. Thank you for the great library!

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

No branches or pull requests

1 participant