wI2L / fizz

:lemon: Gin wrapper with OpenAPI 3 spec generation
https://pkg.go.dev/github.com/wI2L/fizz
MIT License
214 stars 52 forks source link

Support example tag on structs #43

Closed nikicc closed 3 years ago

nikicc commented 3 years ago

Fixes #32

This PR introduces the support for example tags on structs that can be used to generate examples in Open API.

codecov[bot] commented 3 years ago

Codecov Report

Merging #43 (2ff2d64) into master (e161069) will decrease coverage by 0.23%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #43      +/-   ##
==========================================
- Coverage   96.51%   96.27%   -0.24%     
==========================================
  Files           7        7              
  Lines         946      859      -87     
==========================================
- Hits          913      827      -86     
+ Misses         20       19       -1     
  Partials       13       13              
Impacted Files Coverage Δ
openapi/spec.go 100.00% <ø> (ø)
openapi/generator.go 94.91% <100.00%> (-0.07%) :arrow_down:
fizz.go 98.48% <0.00%> (-0.32%) :arrow_down:
openapi/sort.go 100.00% <0.00%> (ø)
openapi/types.go 100.00% <0.00%> (ø)
openapi/errors.go 100.00% <0.00%> (ø)
openapi/validation.go 100.00% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update e161069...2ff2d64. Read the comment docs.

nikicc commented 3 years ago

@wI2L sorry, I re-requested review by mistake 🙈 I'm still working on the changes, will let you know once it's ready again.

wI2L commented 3 years ago

Thank you for your contribution @nikicc. You need to sign your commit before I can merge, tho.

nikicc commented 3 years ago

@wI2L thanks for being so responsive 🚀 I've set the signature now, but you'll need to re-approve, sorry 🙈

Also another quick question: what's the releasing strategy? Could we release this after being merged?

wI2L commented 3 years ago

@nikicc Yes I will push a new tag after I merge.

wI2L commented 3 years ago

Release v0.14.0 published @nikicc.

nikicc commented 3 years ago

@wI2L yeeey 🎉 Thanks!