operations

Documentation

Index

• type ExtensionData
• type OpenAPI
• type Operation
• type Option
  • func DefaultJSONResponse(description string, model interface{}) Option
  • func Deprecated() Option
  • func Extensions(data ExtensionData) Option
  • func FileResponse(code int, description string) Option
  • func FormBody(description string, model interface{}) Option
  • func ID(id string) Option
  • func JSONBody(description string, model interface{}) Option
  • func JSONBodyRequired(description string, model interface{}) Option
  • func JSONResponse(code int, description string, model interface{}) Option
  • func NoSecurity() Option
  • func Params(model interface{}) Option
  • func Security(name string, scopes ...string) Option
  • func Summary(summary string) Option
  • func Tags(tags ...string) Option
• type Options

Types

type ExtensionData

type ExtensionData map[string]interface{}

type OpenAPI

type OpenAPI = *openapi.OpenAPI

type Operation

type Operation struct {
	openapi3.Operation
}

type Option

type Option func(OpenAPI, Operation) (Operation, error)

func DefaultJSONResponse

func DefaultJSONResponse(description string, model interface{}) Option

func Deprecated

func Deprecated() Option

func Extensions

func Extensions(data ExtensionData) Option

func FileResponse

func FileResponse(code int, description string) Option

func FormBody

func FormBody(description string, model interface{}) Option

func ID

func ID(id string) Option

func JSONBody

func JSONBody(description string, model interface{}) Option

func JSONBodyRequired

func JSONBodyRequired(description string, model interface{}) Option

func JSONResponse

func JSONResponse(code int, description string, model interface{}) Option

func NoSecurity

func NoSecurity() Option

NoSecurity sets the security options to an empty array for this operation

func Params

func Params(model interface{}) Option

func Security

func Security(name string, scopes ...string) Option

Security sets the security for the operation

func Summary

func Summary(summary string) Option

func Tags

func Tags(tags ...string) Option

type Options

type Options []Option