public

Documentation

Index

• Constants
• type GetPing
  • func NewGetPing(ctx *middleware.Context, handler GetPingHandler) *GetPing
  • func (o *GetPing) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type GetPingHandler
• type GetPingHandlerFunc
  • func (fn GetPingHandlerFunc) Handle(params GetPingParams) middleware.Responder
• type GetPingInternalServerError
  • func NewGetPingInternalServerError() *GetPingInternalServerError
  • func (o *GetPingInternalServerError) SetPayload(payload *models.ErrorResponse)
  • func (o *GetPingInternalServerError) WithPayload(payload *models.ErrorResponse) *GetPingInternalServerError
  • func (o *GetPingInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type GetPingOK
  • func NewGetPingOK() *GetPingOK
  • func (o *GetPingOK) SetPayload(payload *models.PingResponse)
  • func (o *GetPingOK) WithPayload(payload *models.PingResponse) *GetPingOK
  • func (o *GetPingOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type GetPingParams
  • func NewGetPingParams() GetPingParams
  • func (o *GetPingParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
• type GetPingURL
  • func (o *GetPingURL) Build() (*url.URL, error)
  • func (o *GetPingURL) BuildFull(scheme, host string) (*url.URL, error)
  • func (o *GetPingURL) Must(u *url.URL, err error) *url.URL
  • func (o *GetPingURL) SetBasePath(bp string)
  • func (o *GetPingURL) String() string
  • func (o *GetPingURL) StringFull(scheme, host string) string
  • func (o *GetPingURL) WithBasePath(bp string) *GetPingURL

Constants

const GetPingInternalServerErrorCode int = 500

GetPingInternalServerErrorCode is the HTTP code returned for type GetPingInternalServerError

const GetPingOKCode int = 200

GetPingOKCode is the HTTP code returned for type GetPingOK

Types

type GetPing

type GetPing struct {
	Context *middleware.Context
	Handler GetPingHandler
}

GetPing swagger:route GET /ping Public getPing

Ping endpoint for server health and latency testing.

The ping endpoint provides a simple "pong" response to confirm server availability. Use this endpoint to: - Verify connectivity between the client and server. - Measure network latency for diagnostics. - Perform quick and reliable health checks over HTTP.

func NewGetPing

func NewGetPing(ctx *middleware.Context, handler GetPingHandler) *GetPing

NewGetPing creates a new http.Handler for the get ping operation

func (*GetPing) ServeHTTP

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

type GetPingHandler

type GetPingHandler interface {
	Handle(GetPingParams) middleware.Responder
}

GetPingHandler interface for that can handle valid get ping params

type GetPingHandlerFunc

type GetPingHandlerFunc func(GetPingParams) middleware.Responder

GetPingHandlerFunc turns a function with the right signature into a get ping handler

func (GetPingHandlerFunc) Handle

func (fn GetPingHandlerFunc) Handle(params GetPingParams) middleware.Responder

Handle executing the request and returning a response

type GetPingInternalServerError

type GetPingInternalServerError struct {

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

GetPingInternalServerError Internal Server Error. This typically indicates a server-side issue or an unexpected runtime error preventing proper functionality.

swagger:response getPingInternalServerError

func NewGetPingInternalServerError

func NewGetPingInternalServerError() *GetPingInternalServerError

NewGetPingInternalServerError creates GetPingInternalServerError with default headers values

func (*GetPingInternalServerError) SetPayload

func (o *GetPingInternalServerError) SetPayload(payload *models.ErrorResponse)

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

func (*GetPingInternalServerError) WithPayload

func (o *GetPingInternalServerError) WithPayload(payload *models.ErrorResponse) *GetPingInternalServerError

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

func (*GetPingInternalServerError) WriteResponse

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

WriteResponse to the client

type GetPingOK

type GetPingOK struct {

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

GetPingOK Successful response indicating server availability.

swagger:response getPingOK

func NewGetPingOK

func NewGetPingOK() *GetPingOK

NewGetPingOK creates GetPingOK with default headers values

func (*GetPingOK) SetPayload

func (o *GetPingOK) SetPayload(payload *models.PingResponse)

SetPayload sets the payload to the get ping o k response

func (*GetPingOK) WithPayload

func (o *GetPingOK) WithPayload(payload *models.PingResponse) *GetPingOK

WithPayload adds the payload to the get ping o k response

func (*GetPingOK) WriteResponse

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

WriteResponse to the client

type GetPingParams

type GetPingParams struct {

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

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

swagger:parameters GetPing

func NewGetPingParams

func NewGetPingParams() GetPingParams

NewGetPingParams creates a new GetPingParams object

There are no default values defined in the spec.

func (*GetPingParams) BindRequest

func (o *GetPingParams) 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 NewGetPingParams() beforehand.

type GetPingURL

type GetPingURL struct {
	// contains filtered or unexported fields
}

GetPingURL generates an URL for the get ping operation

func (*GetPingURL) Build

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

Build a url path and query string

func (*GetPingURL) BuildFull

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

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

func (*GetPingURL) Must

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

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

func (*GetPingURL) SetBasePath

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

func (o *GetPingURL) String() string

String returns the string representation of the path with query string

func (*GetPingURL) StringFull

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

StringFull returns the string representation of a complete url

func (*GetPingURL) WithBasePath

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

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