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

Feature Request: A means of visualizing a schema and its requirements #17

Open
jamesrswift opened this issue Jun 2, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@jamesrswift
Copy link
Member

This may not end up being possible but I'm creating this issue to track the addition of a means to visualize valkyrie schema for the purposes of inclusion in package documentation.

Current thoughts: Schema define a new method for the purposes of generating content that adequately represents the schema and its requirements. This might only work for the simplest schema without coercions or assertions. Alternatively, this task is left to individual documentation-generator packages as its implementation will depend heavily on the end use-case.

@jamesrswift jamesrswift added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Jun 2, 2024
@tingerrr
Copy link
Member

tingerrr commented Jun 2, 2024

I think packages could benefit from this when using complex custom types, but I wonder how long this would be beneficial.

My assumption is that many packages will switch to custom types once they are available (which will, as discussed in the community discord, likely also come with automatic type assertions). I wonder if it's worth investing in such a feature if it may not be used much. The only constraints I can think of that valkyrie would then be used for, would be simple constraints like member checks on and fallbacks on dictionaries and range checks on simple types, which are probably all easily written by hand.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants