docs: clarify scope of OpenAPI method #68
Conversation
| @@ -271,7 +271,7 @@ infos := &openapi.Info{ | |||
| Description: `This is a sample Fruits market server.`, | |||
| Version: "1.0.0", | |||
| } | |||
| f.GET("/openapi.json", nil, fizz.OpenAPI(infos, "json")) | |||
| f.GET("/openapi.json", nil, f.OpenAPI(infos, "json")) | |||
There was a problem hiding this comment.
f is often used in the examples to represent a fizz.Fizz instance. For clarity, I think we should add a declaration in this example such as f := fizz.New() using fizz.New to be explicit that the function is a method of a fizz.Fizz instance.
There was a problem hiding this comment.
That makes sense. Added.
|
@DenisPalnitsky LGTM. Could you please rebase? |
Codecov Report
@@ Coverage Diff @@
## master #68 +/- ##
=======================================
Coverage 95.19% 95.19%
=======================================
Files 7 7
Lines 957 957
=======================================
Hits 911 911
Misses 30 30
Partials 16 16 Continue to review full report at Codecov.
|
DenisPalnitsky
force-pushed
the
patch-1
branch
from
8dc7c62
to
8a1c617
Compare
Done |
wI2L
changed the title
I got confused why there is no OpenAPI static method and then realized that it's a struct method