Bump github.com/emicklei/go-restful-openapi to v2.9.2-0.20230507070325-d6acc08e570c (#5669)
This commit is contained in:
38
vendor/github.com/emicklei/go-restful-openapi/v2/README.md
generated
vendored
Normal file
38
vendor/github.com/emicklei/go-restful-openapi/v2/README.md
generated
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
# go-restful-openapi
|
||||
|
||||
[](https://travis-ci.org/emicklei/go-restful-openapi)
|
||||
[](https://godoc.org/github.com/emicklei/go-restful-openapi)
|
||||
|
||||
[openapi](https://www.openapis.org) extension to the go-restful package, targeting [version 2.0](https://github.com/OAI/OpenAPI-Specification)
|
||||
|
||||
## The following Go field tags are translated to OpenAPI equivalents
|
||||
- description
|
||||
- minimum
|
||||
- maximum
|
||||
- optional ( if set to "true" then it is not listed in `required`)
|
||||
- unique
|
||||
- modelDescription
|
||||
- type (overrides the Go type String())
|
||||
- enum
|
||||
- readOnly
|
||||
|
||||
See TestThatExtraTagsAreReadIntoModel for examples.
|
||||
|
||||
## dependencies
|
||||
|
||||
- [go-restful](https://github.com/emicklei/go-restful)
|
||||
- [go-openapi](https://github.com/go-openapi/spec)
|
||||
|
||||
|
||||
## Go modules
|
||||
|
||||
Versions `v1` of this package require Go module version `v2` of the go-restful package.
|
||||
To use version `v3` of the go-restful package, you need to import `v2` of this package, such as:
|
||||
|
||||
import (
|
||||
restfulspec "github.com/emicklei/go-restful-openapi/v2"
|
||||
restful "github.com/emicklei/go-restful/v3"
|
||||
)
|
||||
|
||||
|
||||
© 2017-2020, ernestmicklei.com. MIT License. Contributions welcome.
|
||||
Reference in New Issue
Block a user