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: convert description to comment? #58

Open
evaneus opened this issue Jan 17, 2019 · 1 comment
Open

feature: convert description to comment? #58

evaneus opened this issue Jan 17, 2019 · 1 comment

Comments

@evaneus
Copy link

evaneus commented Jan 17, 2019

Our schemas use description and examples to provide info about the properties. Would be great if these can be converted to comments in the structs to developers can see these notes in their IDE.

@ghost
Copy link

ghost commented Mar 20, 2019

I was wondering the same. Then I've found out that draft 7 already has this: https://json-schema.org/draft-07/json-schema-core.html#rfc.section.9

$comments seems to be dedicated for notes to schema maintainers(coders as well??), as opposed to "description" which is suitable for display to end users.

It would be useful to add custom tags to struct properties. In my case i was looking for a solution to add gorm tags :)

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