api_collection

package
v0.0.0-...-9ea78f7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 19, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const GetApisInternalServerErrorCode int = 500

GetApisInternalServerErrorCode is the HTTP code returned for type GetApisInternalServerError

View Source 
const GetApisOKCode int = 200

GetApisOKCode is the HTTP code returned for type GetApisOK

View Source 
const GetApisUnauthorizedCode int = 401

GetApisUnauthorizedCode is the HTTP code returned for type GetApisUnauthorized

Variables

This section is empty.

Functions

This section is empty.

Types

type GetApis 

type GetApis struct {
	Context *middleware.Context
	Handler GetApisHandler
}
GetApis swagger:route GET /apis API (Collection) getApis

Get a list of API metadata

This operation can be used to retrieve meta info about all APIs

func NewGetApis 

func NewGetApis(ctx *middleware.Context, handler GetApisHandler) *GetApis

NewGetApis creates a new http.Handler for the get apis operation

func (*GetApis) ServeHTTP 

func (o *GetApis) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type GetApisHandler 

type GetApisHandler interface {
	Handle(GetApisParams, *models.Principal) middleware.Responder
}

GetApisHandler interface for that can handle valid get apis params

type GetApisHandlerFunc 

type GetApisHandlerFunc func(GetApisParams, *models.Principal) middleware.Responder

GetApisHandlerFunc turns a function with the right signature into a get apis handler

func (GetApisHandlerFunc) Handle 

func (fn GetApisHandlerFunc) Handle(params GetApisParams, principal *models.Principal) middleware.Responder

Handle executing the request and returning a response

type GetApisInternalServerError 

type GetApisInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

GetApisInternalServerError Internal Server Error.

swagger:response getApisInternalServerError

func NewGetApisInternalServerError 

func NewGetApisInternalServerError() *GetApisInternalServerError

NewGetApisInternalServerError creates GetApisInternalServerError with default headers values

func (*GetApisInternalServerError) SetPayload 

func (o *GetApisInternalServerError) SetPayload(payload *models.Error)

SetPayload sets the payload to the get apis internal server error response

func (*GetApisInternalServerError) WithPayload 

func (o *GetApisInternalServerError) WithPayload(payload *models.Error) *GetApisInternalServerError

WithPayload adds the payload to the get apis internal server error response

func (*GetApisInternalServerError) WriteResponse 

func (o *GetApisInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type GetApisOK 

type GetApisOK struct {

	/*
	  In: Body
	*/
	Payload *models.APIMeta `json:"body,omitempty"`
}

GetApisOK An array of API Metadata

swagger:response getApisOK

func NewGetApisOK 

func NewGetApisOK() *GetApisOK

NewGetApisOK creates GetApisOK with default headers values

func (*GetApisOK) SetPayload 

func (o *GetApisOK) SetPayload(payload *models.APIMeta)

SetPayload sets the payload to the get apis o k response

func (*GetApisOK) WithPayload 

func (o *GetApisOK) WithPayload(payload *models.APIMeta) *GetApisOK

WithPayload adds the payload to the get apis o k response

func (*GetApisOK) WriteResponse 

func (o *GetApisOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type GetApisParams 

type GetApisParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*Number of APIs (APIMeta objects to return)

	  Maximum: 1e+08
	  Minimum: 1
	  In: query
	*/
	Limit *int64
	/*Optional - Condition to filter APIs. Currently only filtering
	by API type (HTTP or WebSocket) is supported.
	"type:http" for HTTP type
	"type:ws" for WebSocket type

	  Max Length: 9
	  Pattern: ^[a-zA-Z:]*$
	  In: query
	*/
	Query *string
}

GetApisParams contains all the bound params for the get apis operation typically these are obtained from a http.Request

swagger:parameters GetApis

func NewGetApisParams 

func NewGetApisParams() GetApisParams

NewGetApisParams creates a new GetApisParams object

There are no default values defined in the spec.

func (*GetApisParams) BindRequest 

func (o *GetApisParams) 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 NewGetApisParams() beforehand.

type GetApisURL 

type GetApisURL struct {
	Limit *int64
	Query *string
	// contains filtered or unexported fields
}

GetApisURL generates an URL for the get apis operation

func (*GetApisURL) Build 

func (o *GetApisURL) Build() (*url.URL, error)

Build a url path and query string

func (*GetApisURL) BuildFull 

func (o *GetApisURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*GetApisURL) Must 

func (o *GetApisURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*GetApisURL) SetBasePath 

func (o *GetApisURL) 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 (*GetApisURL) String 

func (o *GetApisURL) String() string

String returns the string representation of the path with query string

func (*GetApisURL) StringFull 

func (o *GetApisURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*GetApisURL) WithBasePath 

func (o *GetApisURL) WithBasePath(bp string) *GetApisURL

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 GetApisUnauthorized 

type GetApisUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

GetApisUnauthorized Unauthorized. Invalid authentication credentials.

swagger:response getApisUnauthorized

func NewGetApisUnauthorized 

func NewGetApisUnauthorized() *GetApisUnauthorized

NewGetApisUnauthorized creates GetApisUnauthorized with default headers values

func (*GetApisUnauthorized) SetPayload 

func (o *GetApisUnauthorized) SetPayload(payload *models.Error)

SetPayload sets the payload to the get apis unauthorized response

func (*GetApisUnauthorized) WithPayload 

func (o *GetApisUnauthorized) WithPayload(payload *models.Error) *GetApisUnauthorized

WithPayload adds the payload to the get apis unauthorized response

func (*GetApisUnauthorized) WriteResponse 

func (o *GetApisUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.