mgmtapi

package
v0.12.0 Latest Latest
Warning

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

 Go to latest Published: Oct 10, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Package mgmtapi provides primitives to interact with the openapi HTTP API.

Code generated by unknown module path version unknown version DO NOT EDIT.

Package mgmtapi provides primitives to interact with the openapi HTTP API.

Code generated by unknown module path version unknown version DO NOT EDIT.

Package mgmtapi provides primitives to interact with the openapi HTTP API.

Code generated by unknown module path version unknown version DO NOT EDIT.

Package mgmtapi provides primitives to interact with the openapi HTTP API.

Code generated by unknown module path version unknown version DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetSwagger 

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func Handler 

func Handler(si ServerInterface) http.Handler

Handler creates http.Handler with routing matching OpenAPI spec.

func HandlerFromMux 

func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

func HandlerFromMuxWithBaseURL 

func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler

func HandlerWithOptions 

func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler

HandlerWithOptions creates http.Handler with additional options

func NewGetConfigRequest 

func NewGetConfigRequest(server string) (*http.Request, error)

NewGetConfigRequest generates requests for GetConfig

func NewGetInfoRequest 

func NewGetInfoRequest(server string) (*http.Request, error)

NewGetInfoRequest generates requests for GetInfo

func NewGetLogLevelRequest 

func NewGetLogLevelRequest(server string) (*http.Request, error)

NewGetLogLevelRequest generates requests for GetLogLevel

func NewSetLogLevelRequest 

func NewSetLogLevelRequest(server string, body SetLogLevelJSONRequestBody) (*http.Request, error)

NewSetLogLevelRequest calls the generic SetLogLevel builder with application/json body

func NewSetLogLevelRequestWithBody 

func NewSetLogLevelRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSetLogLevelRequestWithBody generates requests for SetLogLevel with any type of body

func PathToRawSpec 

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

func ServeSpecInteractive 

func ServeSpecInteractive(w http.ResponseWriter, r *http.Request)

ServeSpecInteractive serves the interactive redocly OpenAPI3 spec.

func ServeSpecJSON 

func ServeSpecJSON(w http.ResponseWriter, r *http.Request)

ServeSpecJSON serves the json encoded OpenAPI3 spec.

Types

type BadRequest 

type BadRequest = StandardError

BadRequest defines model for BadRequest.

type ChiServerOptions 

type ChiServerOptions struct {
	BaseURL          string
	BaseRouter       chi.Router
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) GetConfig 

func (c *Client) GetConfig(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetInfo 

func (c *Client) GetInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetLogLevel 

func (c *Client) GetLogLevel(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SetLogLevel 

func (c *Client) SetLogLevel(ctx context.Context, body SetLogLevelJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SetLogLevelWithBody 

func (c *Client) SetLogLevelWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// GetConfig request
	GetConfig(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetInfo request
	GetInfo(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetLogLevel request
	GetLogLevel(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SetLogLevelWithBody request with any body
	SetLogLevelWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	SetLogLevel(ctx context.Context, body SetLogLevelJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) GetConfigWithResponse 

func (c *ClientWithResponses) GetConfigWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetConfigResponse, error)

GetConfigWithResponse request returning *GetConfigResponse

func (*ClientWithResponses) GetInfoWithResponse 

func (c *ClientWithResponses) GetInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetInfoResponse, error)

GetInfoWithResponse request returning *GetInfoResponse

func (*ClientWithResponses) GetLogLevelWithResponse 

func (c *ClientWithResponses) GetLogLevelWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetLogLevelResponse, error)

GetLogLevelWithResponse request returning *GetLogLevelResponse

func (*ClientWithResponses) SetLogLevelWithBodyWithResponse 

func (c *ClientWithResponses) SetLogLevelWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetLogLevelResponse, error)

SetLogLevelWithBodyWithResponse request with arbitrary body returning *SetLogLevelResponse

func (*ClientWithResponses) SetLogLevelWithResponse 

func (c *ClientWithResponses) SetLogLevelWithResponse(ctx context.Context, body SetLogLevelJSONRequestBody, reqEditors ...RequestEditorFn) (*SetLogLevelResponse, error)

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetConfigWithResponse request
	GetConfigWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetConfigResponse, error)

	// GetInfoWithResponse request
	GetInfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetInfoResponse, error)

	// GetLogLevelWithResponse request
	GetLogLevelWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetLogLevelResponse, error)

	// SetLogLevelWithBodyWithResponse request with any body
	SetLogLevelWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SetLogLevelResponse, error)

	SetLogLevelWithResponse(ctx context.Context, body SetLogLevelJSONRequestBody, reqEditors ...RequestEditorFn) (*SetLogLevelResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type GetConfigResponse 

type GetConfigResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *BadRequest
}

func ParseGetConfigResponse 

func ParseGetConfigResponse(rsp *http.Response) (*GetConfigResponse, error)

ParseGetConfigResponse parses an HTTP response from a GetConfigWithResponse call

func (GetConfigResponse) Status 

func (r GetConfigResponse) Status() string

Status returns HTTPResponse.Status

func (GetConfigResponse) StatusCode 

func (r GetConfigResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInfoResponse 

type GetInfoResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *BadRequest
}

func ParseGetInfoResponse 

func ParseGetInfoResponse(rsp *http.Response) (*GetInfoResponse, error)

ParseGetInfoResponse parses an HTTP response from a GetInfoWithResponse call

func (GetInfoResponse) Status 

func (r GetInfoResponse) Status() string

Status returns HTTPResponse.Status

func (GetInfoResponse) StatusCode 

func (r GetInfoResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetLogLevelResponse 

type GetLogLevelResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LogLevel
	JSON400      *BadRequest
}

func ParseGetLogLevelResponse 

func ParseGetLogLevelResponse(rsp *http.Response) (*GetLogLevelResponse, error)

ParseGetLogLevelResponse parses an HTTP response from a GetLogLevelWithResponse call

func (GetLogLevelResponse) Status 

func (r GetLogLevelResponse) Status() string

Status returns HTTPResponse.Status

func (GetLogLevelResponse) StatusCode 

func (r GetLogLevelResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InvalidParamFormatError 

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

func (*InvalidParamFormatError) Error 

func (e *InvalidParamFormatError) Error() string

func (*InvalidParamFormatError) Unwrap 

func (e *InvalidParamFormatError) Unwrap() error

type LogLevel 

type LogLevel struct {
	// Level Logging level
	Level LogLevelLevel `json:"level"`
}

LogLevel defines model for LogLevel.

type LogLevelLevel 

type LogLevelLevel string

LogLevelLevel Logging level 

const (
	Debug LogLevelLevel = "debug"
	Error LogLevelLevel = "error"
	Info  LogLevelLevel = "info"
)

Defines values for LogLevelLevel.

type MiddlewareFunc 

type MiddlewareFunc func(http.Handler) http.Handler

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RequiredHeaderError 

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

func (*RequiredHeaderError) Error 

func (e *RequiredHeaderError) Error() string

func (*RequiredHeaderError) Unwrap 

func (e *RequiredHeaderError) Unwrap() error

type RequiredParamError 

type RequiredParamError struct {
	ParamName string
}

func (*RequiredParamError) Error 

func (e *RequiredParamError) Error() string

type Server 

type Server struct {
	Config   http.HandlerFunc
	Info     http.HandlerFunc
	LogLevel http.HandlerFunc
}

Server implements the Posix Gateway Service API.

func (*Server) GetConfig 

func (s *Server) GetConfig(w http.ResponseWriter, r *http.Request)

GetConfig is an indirection to the http handler.

func (*Server) GetInfo 

func (s *Server) GetInfo(w http.ResponseWriter, r *http.Request)

GetInfo is an indirection to the http handler.

func (*Server) GetLogLevel 

func (s *Server) GetLogLevel(w http.ResponseWriter, r *http.Request)

GetLogLevel is an indirection to the http handler.

func (*Server) SetLogLevel 

func (s *Server) SetLogLevel(w http.ResponseWriter, r *http.Request)

SetLogLevel is an indirection to the http handler.

type ServerInterface 

type ServerInterface interface {
	// Prints the TOML configuration file.
	// (GET /config)
	GetConfig(w http.ResponseWriter, r *http.Request)
	// Basic information page about the control service process.
	// (GET /info)
	GetInfo(w http.ResponseWriter, r *http.Request)
	// Get logging level
	// (GET /log/level)
	GetLogLevel(w http.ResponseWriter, r *http.Request)
	// Set logging level
	// (PUT /log/level)
	SetLogLevel(w http.ResponseWriter, r *http.Request)
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper 

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) GetConfig 

func (siw *ServerInterfaceWrapper) GetConfig(w http.ResponseWriter, r *http.Request)

GetConfig operation middleware

func (*ServerInterfaceWrapper) GetInfo 

func (siw *ServerInterfaceWrapper) GetInfo(w http.ResponseWriter, r *http.Request)

GetInfo operation middleware

func (*ServerInterfaceWrapper) GetLogLevel 

func (siw *ServerInterfaceWrapper) GetLogLevel(w http.ResponseWriter, r *http.Request)

GetLogLevel operation middleware

func (*ServerInterfaceWrapper) SetLogLevel 

func (siw *ServerInterfaceWrapper) SetLogLevel(w http.ResponseWriter, r *http.Request)

SetLogLevel operation middleware

type SetLogLevelJSONRequestBody 

type SetLogLevelJSONRequestBody = LogLevel

SetLogLevelJSONRequestBody defines body for SetLogLevel for application/json ContentType.

type SetLogLevelResponse 

type SetLogLevelResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *LogLevel
	JSON400      *BadRequest
}

func ParseSetLogLevelResponse 

func ParseSetLogLevelResponse(rsp *http.Response) (*SetLogLevelResponse, error)

ParseSetLogLevelResponse parses an HTTP response from a SetLogLevelWithResponse call

func (SetLogLevelResponse) Status 

func (r SetLogLevelResponse) Status() string

Status returns HTTPResponse.Status

func (SetLogLevelResponse) StatusCode 

func (r SetLogLevelResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StandardError 

type StandardError struct {
	// Error Error message
	Error string `json:"error"`
}

StandardError defines model for StandardError.

type TooManyValuesForParamError 

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error 

func (e *TooManyValuesForParamError) Error() string

type UnescapedCookieParamError 

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

func (*UnescapedCookieParamError) Error 

func (e *UnescapedCookieParamError) Error() string

func (*UnescapedCookieParamError) Unwrap 

func (e *UnescapedCookieParamError) Unwrap() error

type Unimplemented added in v0.10.0 

type Unimplemented struct{}

func (Unimplemented) GetConfig added in v0.10.0 

func (_ Unimplemented) GetConfig(w http.ResponseWriter, r *http.Request)

Prints the TOML configuration file. (GET /config)

func (Unimplemented) GetInfo added in v0.10.0 

func (_ Unimplemented) GetInfo(w http.ResponseWriter, r *http.Request)

Basic information page about the control service process. (GET /info)

func (Unimplemented) GetLogLevel added in v0.10.0 

func (_ Unimplemented) GetLogLevel(w http.ResponseWriter, r *http.Request)

Get logging level (GET /log/level)

func (Unimplemented) SetLogLevel added in v0.10.0 

func (_ Unimplemented) SetLogLevel(w http.ResponseWriter, r *http.Request)

Set logging level (PUT /log/level)

type UnmarshalingParamError 

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

func (*UnmarshalingParamError) Error 

func (e *UnmarshalingParamError) Error() string

func (*UnmarshalingParamError) Unwrap 

func (e *UnmarshalingParamError) Unwrap() error

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.