Documentation
¶
Overview ¶
Package builder contains the source for the user-facing respec library.
Index ¶
- type Builder
- func (b *Builder) Description(d string) *Builder
- func (b *Builder) GetDescription() string
- func (b *Builder) GetParamModifiers() map[string]ParamModifier
- func (b *Builder) GetSecurity() []string
- func (b *Builder) GetSummary() string
- func (b *Builder) GetTags() []string
- func (b *Builder) OverrideParam(name string, modifier ParamModifier) *Builder
- func (b *Builder) Security(schemeName string) *Builder
- func (b *Builder) Summary(s string) *Builder
- func (b *Builder) Tag(tags ...string) *Builder
- type ParamModifier
- type ResponseModifier
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
Builder holds the metadata provided by the developer through the fluent API.
func NewBuilder ¶
func NewBuilder() *Builder
func (*Builder) Description ¶
func (*Builder) GetDescription ¶
func (*Builder) GetParamModifiers ¶
func (b *Builder) GetParamModifiers() map[string]ParamModifier
func (*Builder) GetSecurity ¶
func (*Builder) GetSummary ¶
Getters for the assembler to read the final values
func (*Builder) OverrideParam ¶
func (b *Builder) OverrideParam(name string, modifier ParamModifier) *Builder
type ParamModifier ¶
Modifier functions for granular control.
type ResponseModifier ¶
Source Files
Click to show internal directories.
Click to hide internal directories.