feat: allow to add description on struct fields using tag openapi-des…#36
Open
feat: allow to add description on struct fields using tag openapi-des…#36
Conversation
3c9527a to
015d2d6
Compare
Collaborator
Author
|
cc @Sadzeih , what do you think about this? |
|
I love the idea of being able to add description and examples to fields. And we do have a need like that. I don't know about implementation though. I think a comment would be a better way to do that, for readability but harder to implement. Something like: // @openapi:schema
type SomeStruct struct {
// Name is the name of the SomeStruct
// @openapi:example
// test := SomeStruct{Name: "somestruct"}
Name string `json:"name"`
}I don't know if this is feasable, but I just don't really like the idea of multiple |
015d2d6 to
1b25d8e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…cription