Documentation
¶
Index ¶
- type NoContent
- type Option
- func Callback(name string, opts ...callback.Option) Option
- func CookieParam[T any](name string, opts ...param.Option) Option
- func Deprecated() Option
- func Description(s string) Option
- func ExternalDocs(url, description string) Option
- func HeaderParam[T any](name string, opts ...param.Option) Option
- func OperationId(id string) Option
- func Options(opts ...Option) Option
- func PathParam[T any](name string, opts ...param.Option) Option
- func QueryParam[T any](name string, opts ...param.Option) Option
- func RequestBody[T any](opts ...body.Option) Option
- func Response[T any](status int, opts ...resp.Option) Option
- func Security(name string, scopes ...string) Option
- func Server(url, description string) Option
- func Summary(s string) Option
- func Tags(tags ...string) Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type NoContent ¶
type NoContent struct{}
NoContent is used as the type parameter for RequestBody or Response when there is no content body.
type Option ¶
Option configures an OpenAPI operation.
func CookieParam ¶
CookieParam adds an optional cookie parameter to the operation.
func Deprecated ¶
func Deprecated() Option
Deprecated marks the operation as deprecated. Default: not deprecated.
func ExternalDocs ¶
ExternalDocs sets an external documentation link for the operation.
func HeaderParam ¶
HeaderParam adds an optional header parameter to the operation.
func OperationId ¶
OperationId sets the unique operation identifier.
func QueryParam ¶
QueryParam adds an optional query parameter to the operation.
func RequestBody ¶
RequestBody sets the request body for the operation.
func Response ¶
Response sets the response for the given HTTP status code. The description defaults to the HTTP status text.
func Security ¶
Security appends a security requirement to the operation. Pass an empty name to add an empty requirement (makes security optional for this operation).
Source Files
Directories