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.

Sign up for GitHub

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

Jump to bottom

Improve JSON Schema #969

Open
marcofavorito opened this issue Mar 23, 2020 · 0 comments
Open

Improve JSON Schema #969

marcofavorito opened this issue Mar 23, 2020 · 0 comments
Labels
core enhancement New feature or request

Comments

@marcofavorito
Copy link
Contributor

marcofavorito commented Mar 23, 2020 •
edited
Loading

Is your feature request related to a problem? Please describe.

Currently, we don't use the "description" field for properties.
E.g. look at an example here.

Also, we could use allOf to model the hierarchy of schemas. E.g. we can define a package schema and have the other schemas like protocol, connection etc. extending it.

Describe the solution you'd like
Use them for all the properties in the JSON schema.

Describe alternatives you've considered

Additional context
@marcofavorito marcofavorito changed the title Use JSON schema "description" field Improve JSON Schema Mar 23, 2020
@DavidMinarsch DavidMinarsch added core enhancement New feature or request labels Aug 28, 2020
@DavidMinarsch DavidMinarsch mentioned this issue Jan 1, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
core enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@marcofavorito @DavidMinarsch