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 - optional display of all $defs / definitions #156

Open
alainsanguinetti opened this issue Aug 31, 2022 · 1 comment
Open
Labels
enhancement New feature or request

Comments

@alainsanguinetti
Copy link

Hi,

Thanks for the great tool!

I was wondering if it would be appropriate to add an option that allows displaying the used references and their names in a separate part of the schema, à la OpenAPI that displays also the defined types, and their constructs.

Maybe the option can be made generic to process all defined keys at the root of the document instead of only the "properties" ?

What do you all think?

Alain

@dblanchette dblanchette added the enhancement New feature or request label Oct 18, 2022
@dblanchette
Copy link
Collaborator

I think it's a great idea that would make reading the schema more logical. An example in our use case are properties that can be defined under several environment names (dev, qa, etc.) In that case, all definitions link to the first environment in alphabetical order, which is kind of misleading (it's like it would be saying that qa behaves like dev).

I'm not making any promises for an implementation soon, I unfortunately do not work on that library as much as I'd like.

I would of course take the time to review a PR though.

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

No branches or pull requests

2 participants