Documentation
¶
Index ¶
- Constants
- type DetailSpec
- type DetailSpecBody
- type DetailSpecBodyHandler
- type DetailSpecBodyHandlerFunc
- type DetailSpecBodyOK
- type DetailSpecBodyParams
- type DetailSpecBodyURL
- func (o *DetailSpecBodyURL) Build() (*url.URL, error)
- func (o *DetailSpecBodyURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *DetailSpecBodyURL) Must(u *url.URL, err error) *url.URL
- func (o *DetailSpecBodyURL) SetBasePath(bp string)
- func (o *DetailSpecBodyURL) String() string
- func (o *DetailSpecBodyURL) StringFull(scheme, host string) string
- func (o *DetailSpecBodyURL) WithBasePath(bp string) *DetailSpecBodyURL
- type DetailSpecHandler
- type DetailSpecHandlerFunc
- type DetailSpecOK
- type DetailSpecParams
- type DetailSpecURL
- func (o *DetailSpecURL) Build() (*url.URL, error)
- func (o *DetailSpecURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *DetailSpecURL) Must(u *url.URL, err error) *url.URL
- func (o *DetailSpecURL) SetBasePath(bp string)
- func (o *DetailSpecURL) String() string
- func (o *DetailSpecURL) StringFull(scheme, host string) string
- func (o *DetailSpecURL) WithBasePath(bp string) *DetailSpecURL
- type ListEnumeratedCapabilities
- type ListEnumeratedCapabilitiesHandler
- type ListEnumeratedCapabilitiesHandlerFunc
- type ListEnumeratedCapabilitiesOK
- func (o *ListEnumeratedCapabilitiesOK) SetPayload(payload *rest_model.ListEnumeratedCapabilitiesEnvelope)
- func (o *ListEnumeratedCapabilitiesOK) WithPayload(payload *rest_model.ListEnumeratedCapabilitiesEnvelope) *ListEnumeratedCapabilitiesOK
- func (o *ListEnumeratedCapabilitiesOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type ListEnumeratedCapabilitiesParams
- type ListEnumeratedCapabilitiesURL
- func (o *ListEnumeratedCapabilitiesURL) Build() (*url.URL, error)
- func (o *ListEnumeratedCapabilitiesURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *ListEnumeratedCapabilitiesURL) Must(u *url.URL, err error) *url.URL
- func (o *ListEnumeratedCapabilitiesURL) SetBasePath(bp string)
- func (o *ListEnumeratedCapabilitiesURL) String() string
- func (o *ListEnumeratedCapabilitiesURL) StringFull(scheme, host string) string
- func (o *ListEnumeratedCapabilitiesURL) WithBasePath(bp string) *ListEnumeratedCapabilitiesURL
- type ListRoot
- type ListRootHandler
- type ListRootHandlerFunc
- type ListRootOK
- type ListRootParams
- type ListRootURL
- func (o *ListRootURL) Build() (*url.URL, error)
- func (o *ListRootURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *ListRootURL) Must(u *url.URL, err error) *url.URL
- func (o *ListRootURL) SetBasePath(bp string)
- func (o *ListRootURL) String() string
- func (o *ListRootURL) StringFull(scheme, host string) string
- func (o *ListRootURL) WithBasePath(bp string) *ListRootURL
- type ListSpecs
- type ListSpecsHandler
- type ListSpecsHandlerFunc
- type ListSpecsOK
- type ListSpecsParams
- type ListSpecsURL
- func (o *ListSpecsURL) Build() (*url.URL, error)
- func (o *ListSpecsURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *ListSpecsURL) Must(u *url.URL, err error) *url.URL
- func (o *ListSpecsURL) SetBasePath(bp string)
- func (o *ListSpecsURL) String() string
- func (o *ListSpecsURL) StringFull(scheme, host string) string
- func (o *ListSpecsURL) WithBasePath(bp string) *ListSpecsURL
- type ListSummary
- type ListSummaryHandler
- type ListSummaryHandlerFunc
- type ListSummaryOK
- type ListSummaryParams
- type ListSummaryTooManyRequests
- func (o *ListSummaryTooManyRequests) SetPayload(payload *rest_model.APIErrorEnvelope)
- func (o *ListSummaryTooManyRequests) WithPayload(payload *rest_model.APIErrorEnvelope) *ListSummaryTooManyRequests
- func (o *ListSummaryTooManyRequests) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type ListSummaryURL
- func (o *ListSummaryURL) Build() (*url.URL, error)
- func (o *ListSummaryURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *ListSummaryURL) Must(u *url.URL, err error) *url.URL
- func (o *ListSummaryURL) SetBasePath(bp string)
- func (o *ListSummaryURL) String() string
- func (o *ListSummaryURL) StringFull(scheme, host string) string
- func (o *ListSummaryURL) WithBasePath(bp string) *ListSummaryURL
- type ListSummaryUnauthorized
- type ListVersion
- type ListVersionHandler
- type ListVersionHandlerFunc
- type ListVersionOK
- type ListVersionParams
- type ListVersionURL
- func (o *ListVersionURL) Build() (*url.URL, error)
- func (o *ListVersionURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *ListVersionURL) Must(u *url.URL, err error) *url.URL
- func (o *ListVersionURL) SetBasePath(bp string)
- func (o *ListVersionURL) String() string
- func (o *ListVersionURL) StringFull(scheme, host string) string
- func (o *ListVersionURL) WithBasePath(bp string) *ListVersionURL
Constants ¶
const DetailSpecBodyOKCode int = 200
DetailSpecBodyOKCode is the HTTP code returned for type DetailSpecBodyOK
const DetailSpecOKCode int = 200
DetailSpecOKCode is the HTTP code returned for type DetailSpecOK
const ListEnumeratedCapabilitiesOKCode int = 200
ListEnumeratedCapabilitiesOKCode is the HTTP code returned for type ListEnumeratedCapabilitiesOK
const ListRootOKCode int = 200
ListRootOKCode is the HTTP code returned for type ListRootOK
const ListSpecsOKCode int = 200
ListSpecsOKCode is the HTTP code returned for type ListSpecsOK
const ListSummaryOKCode int = 200
ListSummaryOKCode is the HTTP code returned for type ListSummaryOK
const ListSummaryTooManyRequestsCode int = 429
ListSummaryTooManyRequestsCode is the HTTP code returned for type ListSummaryTooManyRequests
ListSummaryUnauthorizedCode is the HTTP code returned for type ListSummaryUnauthorized
const ListVersionOKCode int = 200
ListVersionOKCode is the HTTP code returned for type ListVersionOK
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DetailSpec ¶
type DetailSpec struct { Context *middleware.Context Handler DetailSpecHandler }
DetailSpec swagger:route GET /specs/{id} Informational detailSpec
Return a single spec resource ¶
Returns single spec resource embedded within the controller for consumption/documentation/code geneartion
func NewDetailSpec ¶
func NewDetailSpec(ctx *middleware.Context, handler DetailSpecHandler) *DetailSpec
NewDetailSpec creates a new http.Handler for the detail spec operation
func (*DetailSpec) ServeHTTP ¶
func (o *DetailSpec) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type DetailSpecBody ¶
type DetailSpecBody struct { Context *middleware.Context Handler DetailSpecBodyHandler }
DetailSpecBody swagger:route GET /specs/{id}/spec Informational detailSpecBody
Returns the spec's file ¶
Return the body of the specification (i.e. Swagger, OpenAPI 2.0, 3.0, etc).
func NewDetailSpecBody ¶
func NewDetailSpecBody(ctx *middleware.Context, handler DetailSpecBodyHandler) *DetailSpecBody
NewDetailSpecBody creates a new http.Handler for the detail spec body operation
func (*DetailSpecBody) ServeHTTP ¶
func (o *DetailSpecBody) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type DetailSpecBodyHandler ¶
type DetailSpecBodyHandler interface {
Handle(DetailSpecBodyParams) middleware.Responder
}
DetailSpecBodyHandler interface for that can handle valid detail spec body params
type DetailSpecBodyHandlerFunc ¶
type DetailSpecBodyHandlerFunc func(DetailSpecBodyParams) middleware.Responder
DetailSpecBodyHandlerFunc turns a function with the right signature into a detail spec body handler
func (DetailSpecBodyHandlerFunc) Handle ¶
func (fn DetailSpecBodyHandlerFunc) Handle(params DetailSpecBodyParams) middleware.Responder
Handle executing the request and returning a response
type DetailSpecBodyOK ¶
type DetailSpecBodyOK struct { /* In: Body */ Payload *rest_model.DetailSpecBodyEnvelope `json:"body,omitempty"` }
DetailSpecBodyOK Returns the document that represents the specification
swagger:response detailSpecBodyOK
func NewDetailSpecBodyOK ¶
func NewDetailSpecBodyOK() *DetailSpecBodyOK
NewDetailSpecBodyOK creates DetailSpecBodyOK with default headers values
func (*DetailSpecBodyOK) SetPayload ¶
func (o *DetailSpecBodyOK) SetPayload(payload *rest_model.DetailSpecBodyEnvelope)
SetPayload sets the payload to the detail spec body o k response
func (*DetailSpecBodyOK) WithPayload ¶
func (o *DetailSpecBodyOK) WithPayload(payload *rest_model.DetailSpecBodyEnvelope) *DetailSpecBodyOK
WithPayload adds the payload to the detail spec body o k response
func (*DetailSpecBodyOK) WriteResponse ¶
func (o *DetailSpecBodyOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type DetailSpecBodyParams ¶
type DetailSpecBodyParams struct { // HTTP Request Object HTTPRequest *http.Request `json:"-"` /*The id of the requested resource Required: true In: path */ ID string }
DetailSpecBodyParams contains all the bound params for the detail spec body operation typically these are obtained from a http.Request
swagger:parameters detailSpecBody
func NewDetailSpecBodyParams ¶
func NewDetailSpecBodyParams() DetailSpecBodyParams
NewDetailSpecBodyParams creates a new DetailSpecBodyParams object
There are no default values defined in the spec.
func (*DetailSpecBodyParams) BindRequest ¶
func (o *DetailSpecBodyParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.
To ensure default values, the struct must have been initialized with NewDetailSpecBodyParams() beforehand.
type DetailSpecBodyURL ¶
type DetailSpecBodyURL struct { ID string // contains filtered or unexported fields }
DetailSpecBodyURL generates an URL for the detail spec body operation
func (*DetailSpecBodyURL) Build ¶
func (o *DetailSpecBodyURL) Build() (*url.URL, error)
Build a url path and query string
func (*DetailSpecBodyURL) BuildFull ¶
func (o *DetailSpecBodyURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*DetailSpecBodyURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*DetailSpecBodyURL) SetBasePath ¶
func (o *DetailSpecBodyURL) SetBasePath(bp string)
SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
func (*DetailSpecBodyURL) String ¶
func (o *DetailSpecBodyURL) String() string
String returns the string representation of the path with query string
func (*DetailSpecBodyURL) StringFull ¶
func (o *DetailSpecBodyURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*DetailSpecBodyURL) WithBasePath ¶
func (o *DetailSpecBodyURL) WithBasePath(bp string) *DetailSpecBodyURL
WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
type DetailSpecHandler ¶
type DetailSpecHandler interface {
Handle(DetailSpecParams) middleware.Responder
}
DetailSpecHandler interface for that can handle valid detail spec params
type DetailSpecHandlerFunc ¶
type DetailSpecHandlerFunc func(DetailSpecParams) middleware.Responder
DetailSpecHandlerFunc turns a function with the right signature into a detail spec handler
func (DetailSpecHandlerFunc) Handle ¶
func (fn DetailSpecHandlerFunc) Handle(params DetailSpecParams) middleware.Responder
Handle executing the request and returning a response
type DetailSpecOK ¶
type DetailSpecOK struct { /* In: Body */ Payload *rest_model.DetailSpecEnvelope `json:"body,omitempty"` }
DetailSpecOK A single specification
swagger:response detailSpecOK
func NewDetailSpecOK ¶
func NewDetailSpecOK() *DetailSpecOK
NewDetailSpecOK creates DetailSpecOK with default headers values
func (*DetailSpecOK) SetPayload ¶
func (o *DetailSpecOK) SetPayload(payload *rest_model.DetailSpecEnvelope)
SetPayload sets the payload to the detail spec o k response
func (*DetailSpecOK) WithPayload ¶
func (o *DetailSpecOK) WithPayload(payload *rest_model.DetailSpecEnvelope) *DetailSpecOK
WithPayload adds the payload to the detail spec o k response
func (*DetailSpecOK) WriteResponse ¶
func (o *DetailSpecOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type DetailSpecParams ¶
type DetailSpecParams struct { // HTTP Request Object HTTPRequest *http.Request `json:"-"` /*The id of the requested resource Required: true In: path */ ID string }
DetailSpecParams contains all the bound params for the detail spec operation typically these are obtained from a http.Request
swagger:parameters detailSpec
func NewDetailSpecParams ¶
func NewDetailSpecParams() DetailSpecParams
NewDetailSpecParams creates a new DetailSpecParams object
There are no default values defined in the spec.
func (*DetailSpecParams) BindRequest ¶
func (o *DetailSpecParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.
To ensure default values, the struct must have been initialized with NewDetailSpecParams() beforehand.
type DetailSpecURL ¶
type DetailSpecURL struct { ID string // contains filtered or unexported fields }
DetailSpecURL generates an URL for the detail spec operation
func (*DetailSpecURL) Build ¶
func (o *DetailSpecURL) Build() (*url.URL, error)
Build a url path and query string
func (*DetailSpecURL) BuildFull ¶
func (o *DetailSpecURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*DetailSpecURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*DetailSpecURL) SetBasePath ¶
func (o *DetailSpecURL) SetBasePath(bp string)
SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
func (*DetailSpecURL) String ¶
func (o *DetailSpecURL) String() string
String returns the string representation of the path with query string
func (*DetailSpecURL) StringFull ¶
func (o *DetailSpecURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*DetailSpecURL) WithBasePath ¶
func (o *DetailSpecURL) WithBasePath(bp string) *DetailSpecURL
WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
type ListEnumeratedCapabilities ¶ added in v0.25.37
type ListEnumeratedCapabilities struct { Context *middleware.Context Handler ListEnumeratedCapabilitiesHandler }
ListEnumeratedCapabilities swagger:route GET /enumerated-capabilities Informational listEnumeratedCapabilities
Returns all capabilities this version of the controller is aware of, enabled or not.
func NewListEnumeratedCapabilities ¶ added in v0.25.37
func NewListEnumeratedCapabilities(ctx *middleware.Context, handler ListEnumeratedCapabilitiesHandler) *ListEnumeratedCapabilities
NewListEnumeratedCapabilities creates a new http.Handler for the list enumerated capabilities operation
func (*ListEnumeratedCapabilities) ServeHTTP ¶ added in v0.25.37
func (o *ListEnumeratedCapabilities) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type ListEnumeratedCapabilitiesHandler ¶ added in v0.25.37
type ListEnumeratedCapabilitiesHandler interface {
Handle(ListEnumeratedCapabilitiesParams) middleware.Responder
}
ListEnumeratedCapabilitiesHandler interface for that can handle valid list enumerated capabilities params
type ListEnumeratedCapabilitiesHandlerFunc ¶ added in v0.25.37
type ListEnumeratedCapabilitiesHandlerFunc func(ListEnumeratedCapabilitiesParams) middleware.Responder
ListEnumeratedCapabilitiesHandlerFunc turns a function with the right signature into a list enumerated capabilities handler
func (ListEnumeratedCapabilitiesHandlerFunc) Handle ¶ added in v0.25.37
func (fn ListEnumeratedCapabilitiesHandlerFunc) Handle(params ListEnumeratedCapabilitiesParams) middleware.Responder
Handle executing the request and returning a response
type ListEnumeratedCapabilitiesOK ¶ added in v0.25.37
type ListEnumeratedCapabilitiesOK struct { /* In: Body */ Payload *rest_model.ListEnumeratedCapabilitiesEnvelope `json:"body,omitempty"` }
ListEnumeratedCapabilitiesOK A typed and enumerated list of capabilities
swagger:response listEnumeratedCapabilitiesOK
func NewListEnumeratedCapabilitiesOK ¶ added in v0.25.37
func NewListEnumeratedCapabilitiesOK() *ListEnumeratedCapabilitiesOK
NewListEnumeratedCapabilitiesOK creates ListEnumeratedCapabilitiesOK with default headers values
func (*ListEnumeratedCapabilitiesOK) SetPayload ¶ added in v0.25.37
func (o *ListEnumeratedCapabilitiesOK) SetPayload(payload *rest_model.ListEnumeratedCapabilitiesEnvelope)
SetPayload sets the payload to the list enumerated capabilities o k response
func (*ListEnumeratedCapabilitiesOK) WithPayload ¶ added in v0.25.37
func (o *ListEnumeratedCapabilitiesOK) WithPayload(payload *rest_model.ListEnumeratedCapabilitiesEnvelope) *ListEnumeratedCapabilitiesOK
WithPayload adds the payload to the list enumerated capabilities o k response
func (*ListEnumeratedCapabilitiesOK) WriteResponse ¶ added in v0.25.37
func (o *ListEnumeratedCapabilitiesOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ListEnumeratedCapabilitiesParams ¶ added in v0.25.37
type ListEnumeratedCapabilitiesParams struct { // HTTP Request Object HTTPRequest *http.Request `json:"-"` }
ListEnumeratedCapabilitiesParams contains all the bound params for the list enumerated capabilities operation typically these are obtained from a http.Request
swagger:parameters listEnumeratedCapabilities
func NewListEnumeratedCapabilitiesParams ¶ added in v0.25.37
func NewListEnumeratedCapabilitiesParams() ListEnumeratedCapabilitiesParams
NewListEnumeratedCapabilitiesParams creates a new ListEnumeratedCapabilitiesParams object
There are no default values defined in the spec.
func (*ListEnumeratedCapabilitiesParams) BindRequest ¶ added in v0.25.37
func (o *ListEnumeratedCapabilitiesParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.
To ensure default values, the struct must have been initialized with NewListEnumeratedCapabilitiesParams() beforehand.
type ListEnumeratedCapabilitiesURL ¶ added in v0.25.37
type ListEnumeratedCapabilitiesURL struct {
// contains filtered or unexported fields
}
ListEnumeratedCapabilitiesURL generates an URL for the list enumerated capabilities operation
func (*ListEnumeratedCapabilitiesURL) Build ¶ added in v0.25.37
func (o *ListEnumeratedCapabilitiesURL) Build() (*url.URL, error)
Build a url path and query string
func (*ListEnumeratedCapabilitiesURL) BuildFull ¶ added in v0.25.37
func (o *ListEnumeratedCapabilitiesURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*ListEnumeratedCapabilitiesURL) Must ¶ added in v0.25.37
Must is a helper function to panic when the url builder returns an error
func (*ListEnumeratedCapabilitiesURL) SetBasePath ¶ added in v0.25.37
func (o *ListEnumeratedCapabilitiesURL) SetBasePath(bp string)
SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
func (*ListEnumeratedCapabilitiesURL) String ¶ added in v0.25.37
func (o *ListEnumeratedCapabilitiesURL) String() string
String returns the string representation of the path with query string
func (*ListEnumeratedCapabilitiesURL) StringFull ¶ added in v0.25.37
func (o *ListEnumeratedCapabilitiesURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*ListEnumeratedCapabilitiesURL) WithBasePath ¶ added in v0.25.37
func (o *ListEnumeratedCapabilitiesURL) WithBasePath(bp string) *ListEnumeratedCapabilitiesURL
WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
type ListRoot ¶
type ListRoot struct { Context *middleware.Context Handler ListRootHandler }
ListRoot swagger:route GET / Informational listRoot
Returns version information
func NewListRoot ¶
func NewListRoot(ctx *middleware.Context, handler ListRootHandler) *ListRoot
NewListRoot creates a new http.Handler for the list root operation
type ListRootHandler ¶
type ListRootHandler interface {
Handle(ListRootParams) middleware.Responder
}
ListRootHandler interface for that can handle valid list root params
type ListRootHandlerFunc ¶
type ListRootHandlerFunc func(ListRootParams) middleware.Responder
ListRootHandlerFunc turns a function with the right signature into a list root handler
func (ListRootHandlerFunc) Handle ¶
func (fn ListRootHandlerFunc) Handle(params ListRootParams) middleware.Responder
Handle executing the request and returning a response
type ListRootOK ¶
type ListRootOK struct { /* In: Body */ Payload *rest_model.ListVersionEnvelope `json:"body,omitempty"` }
ListRootOK Version information for the controller
swagger:response listRootOK
func NewListRootOK ¶
func NewListRootOK() *ListRootOK
NewListRootOK creates ListRootOK with default headers values
func (*ListRootOK) SetPayload ¶
func (o *ListRootOK) SetPayload(payload *rest_model.ListVersionEnvelope)
SetPayload sets the payload to the list root o k response
func (*ListRootOK) WithPayload ¶
func (o *ListRootOK) WithPayload(payload *rest_model.ListVersionEnvelope) *ListRootOK
WithPayload adds the payload to the list root o k response
func (*ListRootOK) WriteResponse ¶
func (o *ListRootOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ListRootParams ¶
ListRootParams contains all the bound params for the list root operation typically these are obtained from a http.Request
swagger:parameters listRoot
func NewListRootParams ¶
func NewListRootParams() ListRootParams
NewListRootParams creates a new ListRootParams object
There are no default values defined in the spec.
func (*ListRootParams) BindRequest ¶
func (o *ListRootParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.
To ensure default values, the struct must have been initialized with NewListRootParams() beforehand.
type ListRootURL ¶
type ListRootURL struct {
// contains filtered or unexported fields
}
ListRootURL generates an URL for the list root operation
func (*ListRootURL) Build ¶
func (o *ListRootURL) Build() (*url.URL, error)
Build a url path and query string
func (*ListRootURL) BuildFull ¶
func (o *ListRootURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*ListRootURL) SetBasePath ¶
func (o *ListRootURL) SetBasePath(bp string)
SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
func (*ListRootURL) String ¶
func (o *ListRootURL) String() string
String returns the string representation of the path with query string
func (*ListRootURL) StringFull ¶
func (o *ListRootURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*ListRootURL) WithBasePath ¶
func (o *ListRootURL) WithBasePath(bp string) *ListRootURL
WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
type ListSpecs ¶
type ListSpecs struct { Context *middleware.Context Handler ListSpecsHandler }
ListSpecs swagger:route GET /specs Informational listSpecs
Returns a list of API specs ¶
Returns a list of spec files embedded within the controller for consumption/documentation/code geneartion
func NewListSpecs ¶
func NewListSpecs(ctx *middleware.Context, handler ListSpecsHandler) *ListSpecs
NewListSpecs creates a new http.Handler for the list specs operation
type ListSpecsHandler ¶
type ListSpecsHandler interface {
Handle(ListSpecsParams) middleware.Responder
}
ListSpecsHandler interface for that can handle valid list specs params
type ListSpecsHandlerFunc ¶
type ListSpecsHandlerFunc func(ListSpecsParams) middleware.Responder
ListSpecsHandlerFunc turns a function with the right signature into a list specs handler
func (ListSpecsHandlerFunc) Handle ¶
func (fn ListSpecsHandlerFunc) Handle(params ListSpecsParams) middleware.Responder
Handle executing the request and returning a response
type ListSpecsOK ¶
type ListSpecsOK struct { /* In: Body */ Payload *rest_model.ListSpecsEnvelope `json:"body,omitempty"` }
ListSpecsOK A list of specifications
swagger:response listSpecsOK
func NewListSpecsOK ¶
func NewListSpecsOK() *ListSpecsOK
NewListSpecsOK creates ListSpecsOK with default headers values
func (*ListSpecsOK) SetPayload ¶
func (o *ListSpecsOK) SetPayload(payload *rest_model.ListSpecsEnvelope)
SetPayload sets the payload to the list specs o k response
func (*ListSpecsOK) WithPayload ¶
func (o *ListSpecsOK) WithPayload(payload *rest_model.ListSpecsEnvelope) *ListSpecsOK
WithPayload adds the payload to the list specs o k response
func (*ListSpecsOK) WriteResponse ¶
func (o *ListSpecsOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ListSpecsParams ¶
ListSpecsParams contains all the bound params for the list specs operation typically these are obtained from a http.Request
swagger:parameters listSpecs
func NewListSpecsParams ¶
func NewListSpecsParams() ListSpecsParams
NewListSpecsParams creates a new ListSpecsParams object
There are no default values defined in the spec.
func (*ListSpecsParams) BindRequest ¶
func (o *ListSpecsParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.
To ensure default values, the struct must have been initialized with NewListSpecsParams() beforehand.
type ListSpecsURL ¶
type ListSpecsURL struct {
// contains filtered or unexported fields
}
ListSpecsURL generates an URL for the list specs operation
func (*ListSpecsURL) Build ¶
func (o *ListSpecsURL) Build() (*url.URL, error)
Build a url path and query string
func (*ListSpecsURL) BuildFull ¶
func (o *ListSpecsURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*ListSpecsURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*ListSpecsURL) SetBasePath ¶
func (o *ListSpecsURL) SetBasePath(bp string)
SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
func (*ListSpecsURL) String ¶
func (o *ListSpecsURL) String() string
String returns the string representation of the path with query string
func (*ListSpecsURL) StringFull ¶
func (o *ListSpecsURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*ListSpecsURL) WithBasePath ¶
func (o *ListSpecsURL) WithBasePath(bp string) *ListSpecsURL
WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
type ListSummary ¶
type ListSummary struct { Context *middleware.Context Handler ListSummaryHandler }
ListSummary swagger:route GET /summary Informational listSummary
Returns a list of accessible resource counts ¶
This endpoint is usefull for UIs that wish to display UI elements with counts.
func NewListSummary ¶
func NewListSummary(ctx *middleware.Context, handler ListSummaryHandler) *ListSummary
NewListSummary creates a new http.Handler for the list summary operation
func (*ListSummary) ServeHTTP ¶
func (o *ListSummary) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type ListSummaryHandler ¶
type ListSummaryHandler interface {
Handle(ListSummaryParams, interface{}) middleware.Responder
}
ListSummaryHandler interface for that can handle valid list summary params
type ListSummaryHandlerFunc ¶
type ListSummaryHandlerFunc func(ListSummaryParams, interface{}) middleware.Responder
ListSummaryHandlerFunc turns a function with the right signature into a list summary handler
func (ListSummaryHandlerFunc) Handle ¶
func (fn ListSummaryHandlerFunc) Handle(params ListSummaryParams, principal interface{}) middleware.Responder
Handle executing the request and returning a response
type ListSummaryOK ¶
type ListSummaryOK struct { /* In: Body */ Payload *rest_model.ListSummaryCountsEnvelope `json:"body,omitempty"` }
ListSummaryOK Entity counts scopped to the current identitie's access
swagger:response listSummaryOK
func NewListSummaryOK ¶
func NewListSummaryOK() *ListSummaryOK
NewListSummaryOK creates ListSummaryOK with default headers values
func (*ListSummaryOK) SetPayload ¶
func (o *ListSummaryOK) SetPayload(payload *rest_model.ListSummaryCountsEnvelope)
SetPayload sets the payload to the list summary o k response
func (*ListSummaryOK) WithPayload ¶
func (o *ListSummaryOK) WithPayload(payload *rest_model.ListSummaryCountsEnvelope) *ListSummaryOK
WithPayload adds the payload to the list summary o k response
func (*ListSummaryOK) WriteResponse ¶
func (o *ListSummaryOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ListSummaryParams ¶
ListSummaryParams contains all the bound params for the list summary operation typically these are obtained from a http.Request
swagger:parameters listSummary
func NewListSummaryParams ¶
func NewListSummaryParams() ListSummaryParams
NewListSummaryParams creates a new ListSummaryParams object
There are no default values defined in the spec.
func (*ListSummaryParams) BindRequest ¶
func (o *ListSummaryParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.
To ensure default values, the struct must have been initialized with NewListSummaryParams() beforehand.
type ListSummaryTooManyRequests ¶ added in v0.26.0
type ListSummaryTooManyRequests struct { /* In: Body */ Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"` }
ListSummaryTooManyRequests The resource requested is rate limited and the rate limit has been exceeded
swagger:response listSummaryTooManyRequests
func NewListSummaryTooManyRequests ¶ added in v0.26.0
func NewListSummaryTooManyRequests() *ListSummaryTooManyRequests
NewListSummaryTooManyRequests creates ListSummaryTooManyRequests with default headers values
func (*ListSummaryTooManyRequests) SetPayload ¶ added in v0.26.0
func (o *ListSummaryTooManyRequests) SetPayload(payload *rest_model.APIErrorEnvelope)
SetPayload sets the payload to the list summary too many requests response
func (*ListSummaryTooManyRequests) WithPayload ¶ added in v0.26.0
func (o *ListSummaryTooManyRequests) WithPayload(payload *rest_model.APIErrorEnvelope) *ListSummaryTooManyRequests
WithPayload adds the payload to the list summary too many requests response
func (*ListSummaryTooManyRequests) WriteResponse ¶ added in v0.26.0
func (o *ListSummaryTooManyRequests) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ListSummaryURL ¶
type ListSummaryURL struct {
// contains filtered or unexported fields
}
ListSummaryURL generates an URL for the list summary operation
func (*ListSummaryURL) Build ¶
func (o *ListSummaryURL) Build() (*url.URL, error)
Build a url path and query string
func (*ListSummaryURL) BuildFull ¶
func (o *ListSummaryURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*ListSummaryURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*ListSummaryURL) SetBasePath ¶
func (o *ListSummaryURL) SetBasePath(bp string)
SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
func (*ListSummaryURL) String ¶
func (o *ListSummaryURL) String() string
String returns the string representation of the path with query string
func (*ListSummaryURL) StringFull ¶
func (o *ListSummaryURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*ListSummaryURL) WithBasePath ¶
func (o *ListSummaryURL) WithBasePath(bp string) *ListSummaryURL
WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
type ListSummaryUnauthorized ¶
type ListSummaryUnauthorized struct { rest_model.APIErrorEnvelope `json:"body,omitempty"` }Payload *
ListSummaryUnauthorized The supplied session does not have the correct access rights to request this resource
swagger:response listSummaryUnauthorized
func NewListSummaryUnauthorized ¶
func NewListSummaryUnauthorized() *ListSummaryUnauthorized
NewListSummaryUnauthorized creates ListSummaryUnauthorized with default headers values
func (*ListSummaryUnauthorized) SetPayload ¶
func (o *ListSummaryUnauthorized) SetPayload(payload *rest_model.APIErrorEnvelope)
SetPayload sets the payload to the list summary unauthorized response
func (*ListSummaryUnauthorized) WithPayload ¶
func (o *ListSummaryUnauthorized) WithPayload(payload *rest_model.APIErrorEnvelope) *ListSummaryUnauthorized
WithPayload adds the payload to the list summary unauthorized response
func (*ListSummaryUnauthorized) WriteResponse ¶
func (o *ListSummaryUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ListVersion ¶
type ListVersion struct { Context *middleware.Context Handler ListVersionHandler }
ListVersion swagger:route GET /version Informational listVersion
Returns version information
func NewListVersion ¶
func NewListVersion(ctx *middleware.Context, handler ListVersionHandler) *ListVersion
NewListVersion creates a new http.Handler for the list version operation
func (*ListVersion) ServeHTTP ¶
func (o *ListVersion) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type ListVersionHandler ¶
type ListVersionHandler interface {
Handle(ListVersionParams) middleware.Responder
}
ListVersionHandler interface for that can handle valid list version params
type ListVersionHandlerFunc ¶
type ListVersionHandlerFunc func(ListVersionParams) middleware.Responder
ListVersionHandlerFunc turns a function with the right signature into a list version handler
func (ListVersionHandlerFunc) Handle ¶
func (fn ListVersionHandlerFunc) Handle(params ListVersionParams) middleware.Responder
Handle executing the request and returning a response
type ListVersionOK ¶
type ListVersionOK struct { /* In: Body */ Payload *rest_model.ListVersionEnvelope `json:"body,omitempty"` }
ListVersionOK Version information for the controller
swagger:response listVersionOK
func NewListVersionOK ¶
func NewListVersionOK() *ListVersionOK
NewListVersionOK creates ListVersionOK with default headers values
func (*ListVersionOK) SetPayload ¶
func (o *ListVersionOK) SetPayload(payload *rest_model.ListVersionEnvelope)
SetPayload sets the payload to the list version o k response
func (*ListVersionOK) WithPayload ¶
func (o *ListVersionOK) WithPayload(payload *rest_model.ListVersionEnvelope) *ListVersionOK
WithPayload adds the payload to the list version o k response
func (*ListVersionOK) WriteResponse ¶
func (o *ListVersionOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ListVersionParams ¶
ListVersionParams contains all the bound params for the list version operation typically these are obtained from a http.Request
swagger:parameters listVersion
func NewListVersionParams ¶
func NewListVersionParams() ListVersionParams
NewListVersionParams creates a new ListVersionParams object
There are no default values defined in the spec.
func (*ListVersionParams) BindRequest ¶
func (o *ListVersionParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.
To ensure default values, the struct must have been initialized with NewListVersionParams() beforehand.
type ListVersionURL ¶
type ListVersionURL struct {
// contains filtered or unexported fields
}
ListVersionURL generates an URL for the list version operation
func (*ListVersionURL) Build ¶
func (o *ListVersionURL) Build() (*url.URL, error)
Build a url path and query string
func (*ListVersionURL) BuildFull ¶
func (o *ListVersionURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*ListVersionURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*ListVersionURL) SetBasePath ¶
func (o *ListVersionURL) SetBasePath(bp string)
SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
func (*ListVersionURL) String ¶
func (o *ListVersionURL) String() string
String returns the string representation of the path with query string
func (*ListVersionURL) StringFull ¶
func (o *ListVersionURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*ListVersionURL) WithBasePath ¶
func (o *ListVersionURL) WithBasePath(bp string) *ListVersionURL
WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string
Source Files
¶
- detail_spec.go
- detail_spec_body.go
- detail_spec_body_parameters.go
- detail_spec_body_responses.go
- detail_spec_body_urlbuilder.go
- detail_spec_parameters.go
- detail_spec_responses.go
- detail_spec_urlbuilder.go
- list_enumerated_capabilities.go
- list_enumerated_capabilities_parameters.go
- list_enumerated_capabilities_responses.go
- list_enumerated_capabilities_urlbuilder.go
- list_root.go
- list_root_parameters.go
- list_root_responses.go
- list_root_urlbuilder.go
- list_specs.go
- list_specs_parameters.go
- list_specs_responses.go
- list_specs_urlbuilder.go
- list_summary.go
- list_summary_parameters.go
- list_summary_responses.go
- list_summary_urlbuilder.go
- list_version.go
- list_version_parameters.go
- list_version_responses.go
- list_version_urlbuilder.go