Descriptions for types#328
Merged
deepmap-marcinr merged 16 commits intooapi-codegen:masterfrom Apr 1, 2021
MarkRosemaker:descriptions-for-types
Merged
Descriptions for types#328deepmap-marcinr merged 16 commits intooapi-codegen:masterfrom MarkRosemaker:descriptions-for-types
deepmap-marcinr merged 16 commits intooapi-codegen:masterfrom
MarkRosemaker:descriptions-for-types
Conversation
davidovich
reviewed
Mar 28, 2021
pkg/codegen/templates/typedef.tmpl
Outdated
| @@ -1,5 +1,5 @@ | |||
| {{range .Types}} | |||
| // {{.TypeName}} defines model for {{.JsonName}}. | |||
| // {{.TypeName}} {{ with .Description }}represents {{ . }}{{ else }}defines model for {{.JsonName}}{{ end }}. | |||
There was a problem hiding this comment.
If I define a description, I would find it strange to have "represents" added in a hard coded manner. What do you think about just taking the description {{.}} as is?
Contributor
Author
There was a problem hiding this comment.
You're right, I've changed it. Thanks!
adrianpk
pushed a commit
to foorester/oapi-codegen
that referenced
this pull request
Jan 16, 2024
* add description field * use description field in template * fix tests * remove last line * Update templates.gen.go * Update templates.gen.go * remove hardcoded stuff * Update typedef.tmpl * simplify by adding description to Schema * Update components.gen.go * Update templates.gen.go * Update schema.go * fix tests * fix tests * Update schema.go * fix tests
adrianpk
added a commit
to foorester/oapi-codegen
that referenced
this pull request
May 31, 2024
* add description field * use description field in template * fix tests * remove last line * Update templates.gen.go * Update templates.gen.go * remove hardcoded stuff * Update typedef.tmpl * simplify by adding description to Schema * Update components.gen.go * Update templates.gen.go * Update schema.go * fix tests * fix tests * Update schema.go * fix tests
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
3 participants
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.
This PR adds support for type descriptions.
Instead of
// Foo defines model for Foo.it's possible to write a description in the yaml file and get
// Foo represents a test object.