Allow struct fields to be annotated with swagger:ignore #1527
Conversation
This file contains 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
Sometimes it's useful to includ a field in a request or response but leave it
undocumented. This change allows such struct fields to be annotated with
`swagger:ignore`, e.g.
```go
type Foo struct {
// swagger:ignore
Bar string `json:"bar"`
}
```
See go-swagger#1497.
Signed-off-by: Neil Garb <neil@luno.com>
Codecov Report
@@ Coverage Diff @@
## master #1527 +/- ##
==========================================
+ Coverage 74.21% 74.24% +0.02%
==========================================
Files 37 37
Lines 7102 7114 +12
==========================================
+ Hits 5271 5282 +11
Misses 1370 1370
- Partials 461 462 +1
Continue to review full report at Codecov.
|
casualjim
approved these changes
May 13, 2018
|
@casualjim is it possible to ignore only on param? |
|
Use |
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.
Sometimes it's useful to includ a field in a request or response but leave it
undocumented. This change allows such struct fields to be annotated with
swagger:ignore, e.g.See #1497.
Signed-off-by: Neil Garb neil@luno.com