Documentation
¶
Index ¶
- Constants
- type IndexOrganizations
- type IndexOrganizationsBadRequest
- type IndexOrganizationsHandler
- type IndexOrganizationsHandlerFunc
- type IndexOrganizationsInternalServerError
- type IndexOrganizationsNotFound
- type IndexOrganizationsOK
- func (o *IndexOrganizationsOK) SetContentRange(contentRange string)
- func (o *IndexOrganizationsOK) SetPayload(payload adminmessages.Organizations)
- func (o *IndexOrganizationsOK) WithContentRange(contentRange string) *IndexOrganizationsOK
- func (o *IndexOrganizationsOK) WithPayload(payload adminmessages.Organizations) *IndexOrganizationsOK
- func (o *IndexOrganizationsOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type IndexOrganizationsParams
- type IndexOrganizationsURL
- func (o *IndexOrganizationsURL) Build() (*url.URL, error)
- func (o *IndexOrganizationsURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *IndexOrganizationsURL) Must(u *url.URL, err error) *url.URL
- func (o *IndexOrganizationsURL) SetBasePath(bp string)
- func (o *IndexOrganizationsURL) String() string
- func (o *IndexOrganizationsURL) StringFull(scheme, host string) string
- func (o *IndexOrganizationsURL) WithBasePath(bp string) *IndexOrganizationsURL
- type IndexOrganizationsUnauthorized
Constants ¶
const IndexOrganizationsBadRequestCode int = 400
IndexOrganizationsBadRequestCode is the HTTP code returned for type IndexOrganizationsBadRequest
const IndexOrganizationsInternalServerErrorCode int = 500
IndexOrganizationsInternalServerErrorCode is the HTTP code returned for type IndexOrganizationsInternalServerError
const IndexOrganizationsNotFoundCode int = 404
IndexOrganizationsNotFoundCode is the HTTP code returned for type IndexOrganizationsNotFound
const IndexOrganizationsOKCode int = 200
IndexOrganizationsOKCode is the HTTP code returned for type IndexOrganizationsOK
IndexOrganizationsUnauthorizedCode is the HTTP code returned for type IndexOrganizationsUnauthorized
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type IndexOrganizations ¶
type IndexOrganizations struct {
Context *middleware.Context
Handler IndexOrganizationsHandler
}
IndexOrganizations swagger:route GET /organizations Organizations indexOrganizations
List Organizations ¶
This endpoint returns a list of Organizations. Do not use this endpoint directly as it is meant to be used with the Admin UI exclusively.
func NewIndexOrganizations ¶
func NewIndexOrganizations(ctx *middleware.Context, handler IndexOrganizationsHandler) *IndexOrganizations
NewIndexOrganizations creates a new http.Handler for the index organizations operation
func (*IndexOrganizations) ServeHTTP ¶
func (o *IndexOrganizations) ServeHTTP(rw http.ResponseWriter, r *http.Request)
type IndexOrganizationsBadRequest ¶
type IndexOrganizationsBadRequest struct {
}
IndexOrganizationsBadRequest invalid request
swagger:response indexOrganizationsBadRequest
func NewIndexOrganizationsBadRequest ¶
func NewIndexOrganizationsBadRequest() *IndexOrganizationsBadRequest
NewIndexOrganizationsBadRequest creates IndexOrganizationsBadRequest with default headers values
func (*IndexOrganizationsBadRequest) WriteResponse ¶
func (o *IndexOrganizationsBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type IndexOrganizationsHandler ¶
type IndexOrganizationsHandler interface {
Handle(IndexOrganizationsParams) middleware.Responder
}
IndexOrganizationsHandler interface for that can handle valid index organizations params
type IndexOrganizationsHandlerFunc ¶
type IndexOrganizationsHandlerFunc func(IndexOrganizationsParams) middleware.Responder
IndexOrganizationsHandlerFunc turns a function with the right signature into a index organizations handler
func (IndexOrganizationsHandlerFunc) Handle ¶
func (fn IndexOrganizationsHandlerFunc) Handle(params IndexOrganizationsParams) middleware.Responder
Handle executing the request and returning a response
type IndexOrganizationsInternalServerError ¶
type IndexOrganizationsInternalServerError struct {
}
IndexOrganizationsInternalServerError server error
swagger:response indexOrganizationsInternalServerError
func NewIndexOrganizationsInternalServerError ¶
func NewIndexOrganizationsInternalServerError() *IndexOrganizationsInternalServerError
NewIndexOrganizationsInternalServerError creates IndexOrganizationsInternalServerError with default headers values
func (*IndexOrganizationsInternalServerError) WriteResponse ¶
func (o *IndexOrganizationsInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type IndexOrganizationsNotFound ¶
type IndexOrganizationsNotFound struct {
}
IndexOrganizationsNotFound Organizations not found
swagger:response indexOrganizationsNotFound
func NewIndexOrganizationsNotFound ¶
func NewIndexOrganizationsNotFound() *IndexOrganizationsNotFound
NewIndexOrganizationsNotFound creates IndexOrganizationsNotFound with default headers values
func (*IndexOrganizationsNotFound) WriteResponse ¶
func (o *IndexOrganizationsNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type IndexOrganizationsOK ¶
type IndexOrganizationsOK struct {
/*Used for pagination
*/
ContentRange string `json:"Content-Range"`
/*
In: Body
*/
Payload adminmessages.Organizations `json:"body,omitempty"`
}
IndexOrganizationsOK success
swagger:response indexOrganizationsOK
func NewIndexOrganizationsOK ¶
func NewIndexOrganizationsOK() *IndexOrganizationsOK
NewIndexOrganizationsOK creates IndexOrganizationsOK with default headers values
func (*IndexOrganizationsOK) SetContentRange ¶
func (o *IndexOrganizationsOK) SetContentRange(contentRange string)
SetContentRange sets the contentRange to the index organizations o k response
func (*IndexOrganizationsOK) SetPayload ¶
func (o *IndexOrganizationsOK) SetPayload(payload adminmessages.Organizations)
SetPayload sets the payload to the index organizations o k response
func (*IndexOrganizationsOK) WithContentRange ¶
func (o *IndexOrganizationsOK) WithContentRange(contentRange string) *IndexOrganizationsOK
WithContentRange adds the contentRange to the index organizations o k response
func (*IndexOrganizationsOK) WithPayload ¶
func (o *IndexOrganizationsOK) WithPayload(payload adminmessages.Organizations) *IndexOrganizationsOK
WithPayload adds the payload to the index organizations o k response
func (*IndexOrganizationsOK) WriteResponse ¶
func (o *IndexOrganizationsOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type IndexOrganizationsParams ¶
type IndexOrganizationsParams struct {
// HTTP Request Object
HTTPRequest *http.Request `json:"-"`
/*
In: query
*/
Filter []string
/*
In: query
*/
Order *bool
/*
In: query
*/
Page *int64
/*
In: query
*/
PerPage *int64
/*
In: query
*/
Sort *string
}
IndexOrganizationsParams contains all the bound params for the index organizations operation typically these are obtained from a http.Request
swagger:parameters indexOrganizations
func NewIndexOrganizationsParams ¶
func NewIndexOrganizationsParams() IndexOrganizationsParams
NewIndexOrganizationsParams creates a new IndexOrganizationsParams object
There are no default values defined in the spec.
func (*IndexOrganizationsParams) BindRequest ¶
func (o *IndexOrganizationsParams) 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 NewIndexOrganizationsParams() beforehand.
type IndexOrganizationsURL ¶
type IndexOrganizationsURL struct {
Filter []string
Order *bool
Page *int64
PerPage *int64
Sort *string
// contains filtered or unexported fields
}
IndexOrganizationsURL generates an URL for the index organizations operation
func (*IndexOrganizationsURL) Build ¶
func (o *IndexOrganizationsURL) Build() (*url.URL, error)
Build a url path and query string
func (*IndexOrganizationsURL) BuildFull ¶
func (o *IndexOrganizationsURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*IndexOrganizationsURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*IndexOrganizationsURL) SetBasePath ¶
func (o *IndexOrganizationsURL) 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 (*IndexOrganizationsURL) String ¶
func (o *IndexOrganizationsURL) String() string
String returns the string representation of the path with query string
func (*IndexOrganizationsURL) StringFull ¶
func (o *IndexOrganizationsURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*IndexOrganizationsURL) WithBasePath ¶
func (o *IndexOrganizationsURL) WithBasePath(bp string) *IndexOrganizationsURL
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 IndexOrganizationsUnauthorized ¶
type IndexOrganizationsUnauthorized struct {
}
IndexOrganizationsUnauthorized request requires user authentication
swagger:response indexOrganizationsUnauthorized
func NewIndexOrganizationsUnauthorized ¶
func NewIndexOrganizationsUnauthorized() *IndexOrganizationsUnauthorized
NewIndexOrganizationsUnauthorized creates IndexOrganizationsUnauthorized with default headers values
func (*IndexOrganizationsUnauthorized) WriteResponse ¶
func (o *IndexOrganizationsUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
Source Files