Documentation
¶
Overview ¶
Package gen contains generated code for the network API.
Package gen provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.
Index ¶
- Constants
- func RegisterHandlers(router EchoRouter, si ServerInterface)
- func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
- type DNSConfigCollectionResponse
- type DNSConfigResponse
- type DNSConfigUpdateRequest
- type DNSUpdateCollectionResponse
- type DNSUpdateResultItem
- type DNSUpdateResultItemStatus
- type EchoRouter
- type ErrorResponse
- type GetNetworkDNSByInterface200JSONResponse
- type GetNetworkDNSByInterface400JSONResponse
- type GetNetworkDNSByInterface401JSONResponse
- type GetNetworkDNSByInterface403JSONResponse
- type GetNetworkDNSByInterface500JSONResponse
- type GetNetworkDNSByInterfaceParams
- type GetNetworkDNSByInterfaceRequestObject
- type GetNetworkDNSByInterfaceResponseObject
- type PingCollectionResponse
- type PingResponse
- type PostNetworkPing200JSONResponse
- type PostNetworkPing400JSONResponse
- type PostNetworkPing401JSONResponse
- type PostNetworkPing403JSONResponse
- type PostNetworkPing500JSONResponse
- type PostNetworkPingJSONBody
- type PostNetworkPingJSONRequestBody
- type PostNetworkPingParams
- type PostNetworkPingRequestObject
- type PostNetworkPingResponseObject
- type PutNetworkDNS202JSONResponse
- type PutNetworkDNS400JSONResponse
- type PutNetworkDNS401JSONResponse
- type PutNetworkDNS403JSONResponse
- type PutNetworkDNS500JSONResponse
- type PutNetworkDNSJSONRequestBody
- type PutNetworkDNSParams
- type PutNetworkDNSRequestObject
- type PutNetworkDNSResponseObject
- type ServerInterface
- type ServerInterfaceWrapper
- type StrictHandlerFunc
- type StrictMiddlewareFunc
- type StrictServerInterface
Constants ¶
const (
BearerAuthScopes = "BearerAuth.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func RegisterHandlers ¶
func RegisterHandlers(router EchoRouter, si ServerInterface)
RegisterHandlers adds each server route to the EchoRouter.
func RegisterHandlersWithBaseURL ¶
func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.
Types ¶
type DNSConfigCollectionResponse ¶
type DNSConfigCollectionResponse struct {
// JobId The job ID used to process this request.
JobId *openapi_types.UUID `json:"job_id,omitempty"`
Results []DNSConfigResponse `json:"results"`
}
DNSConfigCollectionResponse defines model for DNSConfigCollectionResponse.
type DNSConfigResponse ¶
type DNSConfigResponse struct {
// Error Error message if the agent failed to process the request.
Error *string `json:"error,omitempty"`
// Hostname The hostname of the agent that served this DNS config.
Hostname string `json:"hostname"`
// SearchDomains List of search domains.
SearchDomains *[]string `json:"search_domains,omitempty"`
// Servers List of configured DNS servers.
Servers *[]string `json:"servers,omitempty"`
}
DNSConfigResponse defines model for DNSConfigResponse.
type DNSConfigUpdateRequest ¶
type DNSConfigUpdateRequest struct {
// InterfaceName The name of the network interface to apply DNS configuration to. Must only contain letters and numbers.
InterfaceName string `json:"interface_name" validate:"required,alphanum"`
// SearchDomains New list of search domains to configure.
SearchDomains *[]string `json:"search_domains,omitempty" validate:"required_without=Servers,omitempty,dive,hostname,min=1"`
// Servers New list of DNS servers to configure.
Servers *[]string `json:"servers,omitempty" validate:"required_without=SearchDomains,omitempty,dive,ip,min=1"`
}
DNSConfigUpdateRequest defines model for DNSConfigUpdateRequest.
type DNSUpdateCollectionResponse ¶
type DNSUpdateCollectionResponse struct {
// JobId The job ID used to process this request.
JobId *openapi_types.UUID `json:"job_id,omitempty"`
Results []DNSUpdateResultItem `json:"results"`
}
DNSUpdateCollectionResponse defines model for DNSUpdateCollectionResponse.
type DNSUpdateResultItem ¶
type DNSUpdateResultItem struct {
// Changed Whether the DNS configuration was actually modified.
Changed *bool `json:"changed,omitempty"`
Error *string `json:"error,omitempty"`
Hostname string `json:"hostname"`
Status DNSUpdateResultItemStatus `json:"status"`
}
DNSUpdateResultItem defines model for DNSUpdateResultItem.
type DNSUpdateResultItemStatus ¶
type DNSUpdateResultItemStatus string
DNSUpdateResultItemStatus defines model for DNSUpdateResultItem.Status.
const ( Failed DNSUpdateResultItemStatus = "failed" Ok DNSUpdateResultItemStatus = "ok" )
Defines values for DNSUpdateResultItemStatus.
type EchoRouter ¶
type EchoRouter interface {
CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}
This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration
type ErrorResponse ¶
type ErrorResponse = externalRef0.ErrorResponse
ErrorResponse defines model for ErrorResponse.
type GetNetworkDNSByInterface200JSONResponse ¶
type GetNetworkDNSByInterface200JSONResponse DNSConfigCollectionResponse
func (GetNetworkDNSByInterface200JSONResponse) VisitGetNetworkDNSByInterfaceResponse ¶
func (response GetNetworkDNSByInterface200JSONResponse) VisitGetNetworkDNSByInterfaceResponse(w http.ResponseWriter) error
type GetNetworkDNSByInterface400JSONResponse ¶
type GetNetworkDNSByInterface400JSONResponse externalRef0.ErrorResponse
func (GetNetworkDNSByInterface400JSONResponse) VisitGetNetworkDNSByInterfaceResponse ¶
func (response GetNetworkDNSByInterface400JSONResponse) VisitGetNetworkDNSByInterfaceResponse(w http.ResponseWriter) error
type GetNetworkDNSByInterface401JSONResponse ¶
type GetNetworkDNSByInterface401JSONResponse externalRef0.ErrorResponse
func (GetNetworkDNSByInterface401JSONResponse) VisitGetNetworkDNSByInterfaceResponse ¶
func (response GetNetworkDNSByInterface401JSONResponse) VisitGetNetworkDNSByInterfaceResponse(w http.ResponseWriter) error
type GetNetworkDNSByInterface403JSONResponse ¶
type GetNetworkDNSByInterface403JSONResponse externalRef0.ErrorResponse
func (GetNetworkDNSByInterface403JSONResponse) VisitGetNetworkDNSByInterfaceResponse ¶
func (response GetNetworkDNSByInterface403JSONResponse) VisitGetNetworkDNSByInterfaceResponse(w http.ResponseWriter) error
type GetNetworkDNSByInterface500JSONResponse ¶
type GetNetworkDNSByInterface500JSONResponse externalRef0.ErrorResponse
func (GetNetworkDNSByInterface500JSONResponse) VisitGetNetworkDNSByInterfaceResponse ¶
func (response GetNetworkDNSByInterface500JSONResponse) VisitGetNetworkDNSByInterfaceResponse(w http.ResponseWriter) error
type GetNetworkDNSByInterfaceParams ¶
type GetNetworkDNSByInterfaceParams struct {
// TargetHostname Target: _any (load-balanced), _all (broadcast), hostname (direct), or key:value (label group, e.g., group:web.dev).
TargetHostname *string `form:"target_hostname,omitempty" json:"target_hostname,omitempty" validate:"omitempty,min=1,valid_target"`
}
GetNetworkDNSByInterfaceParams defines parameters for GetNetworkDNSByInterface.
type GetNetworkDNSByInterfaceRequestObject ¶
type GetNetworkDNSByInterfaceRequestObject struct {
InterfaceName string `json:"interfaceName"`
Params GetNetworkDNSByInterfaceParams
}
type GetNetworkDNSByInterfaceResponseObject ¶
type GetNetworkDNSByInterfaceResponseObject interface {
VisitGetNetworkDNSByInterfaceResponse(w http.ResponseWriter) error
}
type PingCollectionResponse ¶
type PingCollectionResponse struct {
// JobId The job ID used to process this request.
JobId *openapi_types.UUID `json:"job_id,omitempty"`
Results []PingResponse `json:"results"`
}
PingCollectionResponse defines model for PingCollectionResponse.
type PingResponse ¶
type PingResponse struct {
// AvgRtt Average round-trip time as a string in Go's time.Duration format.
AvgRtt *string `json:"avg_rtt,omitempty"`
// Error Error message if the agent failed to process the request.
Error *string `json:"error,omitempty"`
// Hostname The hostname of the agent that executed the ping.
Hostname string `json:"hostname"`
// MaxRtt Maximum round-trip time as a string in Go's time.Duration format.
MaxRtt *string `json:"max_rtt,omitempty"`
// MinRtt Minimum round-trip time as a string in Go's time.Duration format.
MinRtt *string `json:"min_rtt,omitempty"`
// PacketLoss Percentage of packet loss.
PacketLoss *float64 `json:"packet_loss,omitempty"`
// PacketsReceived Number of packets received.
PacketsReceived *int `json:"packets_received,omitempty"`
// PacketsSent Number of packets sent.
PacketsSent *int `json:"packets_sent,omitempty"`
}
PingResponse defines model for PingResponse.
type PostNetworkPing200JSONResponse ¶
type PostNetworkPing200JSONResponse PingCollectionResponse
func (PostNetworkPing200JSONResponse) VisitPostNetworkPingResponse ¶
func (response PostNetworkPing200JSONResponse) VisitPostNetworkPingResponse(w http.ResponseWriter) error
type PostNetworkPing400JSONResponse ¶
type PostNetworkPing400JSONResponse externalRef0.ErrorResponse
func (PostNetworkPing400JSONResponse) VisitPostNetworkPingResponse ¶
func (response PostNetworkPing400JSONResponse) VisitPostNetworkPingResponse(w http.ResponseWriter) error
type PostNetworkPing401JSONResponse ¶
type PostNetworkPing401JSONResponse externalRef0.ErrorResponse
func (PostNetworkPing401JSONResponse) VisitPostNetworkPingResponse ¶
func (response PostNetworkPing401JSONResponse) VisitPostNetworkPingResponse(w http.ResponseWriter) error
type PostNetworkPing403JSONResponse ¶
type PostNetworkPing403JSONResponse externalRef0.ErrorResponse
func (PostNetworkPing403JSONResponse) VisitPostNetworkPingResponse ¶
func (response PostNetworkPing403JSONResponse) VisitPostNetworkPingResponse(w http.ResponseWriter) error
type PostNetworkPing500JSONResponse ¶
type PostNetworkPing500JSONResponse externalRef0.ErrorResponse
func (PostNetworkPing500JSONResponse) VisitPostNetworkPingResponse ¶
func (response PostNetworkPing500JSONResponse) VisitPostNetworkPingResponse(w http.ResponseWriter) error
type PostNetworkPingJSONBody ¶
type PostNetworkPingJSONBody struct {
// Address The IP address of the server to ping. Supports both IPv4 and IPv6.
Address string `json:"address" validate:"required,ip"`
}
PostNetworkPingJSONBody defines parameters for PostNetworkPing.
type PostNetworkPingJSONRequestBody ¶
type PostNetworkPingJSONRequestBody PostNetworkPingJSONBody
PostNetworkPingJSONRequestBody defines body for PostNetworkPing for application/json ContentType.
type PostNetworkPingParams ¶
type PostNetworkPingParams struct {
// TargetHostname Target: _any (load-balanced), _all (broadcast), hostname (direct), or key:value (label group, e.g., group:web.dev).
TargetHostname *string `form:"target_hostname,omitempty" json:"target_hostname,omitempty" validate:"omitempty,min=1,valid_target"`
}
PostNetworkPingParams defines parameters for PostNetworkPing.
type PostNetworkPingRequestObject ¶
type PostNetworkPingRequestObject struct {
Params PostNetworkPingParams
Body *PostNetworkPingJSONRequestBody
}
type PostNetworkPingResponseObject ¶
type PostNetworkPingResponseObject interface {
VisitPostNetworkPingResponse(w http.ResponseWriter) error
}
type PutNetworkDNS202JSONResponse ¶
type PutNetworkDNS202JSONResponse DNSUpdateCollectionResponse
func (PutNetworkDNS202JSONResponse) VisitPutNetworkDNSResponse ¶
func (response PutNetworkDNS202JSONResponse) VisitPutNetworkDNSResponse(w http.ResponseWriter) error
type PutNetworkDNS400JSONResponse ¶
type PutNetworkDNS400JSONResponse externalRef0.ErrorResponse
func (PutNetworkDNS400JSONResponse) VisitPutNetworkDNSResponse ¶
func (response PutNetworkDNS400JSONResponse) VisitPutNetworkDNSResponse(w http.ResponseWriter) error
type PutNetworkDNS401JSONResponse ¶
type PutNetworkDNS401JSONResponse externalRef0.ErrorResponse
func (PutNetworkDNS401JSONResponse) VisitPutNetworkDNSResponse ¶
func (response PutNetworkDNS401JSONResponse) VisitPutNetworkDNSResponse(w http.ResponseWriter) error
type PutNetworkDNS403JSONResponse ¶
type PutNetworkDNS403JSONResponse externalRef0.ErrorResponse
func (PutNetworkDNS403JSONResponse) VisitPutNetworkDNSResponse ¶
func (response PutNetworkDNS403JSONResponse) VisitPutNetworkDNSResponse(w http.ResponseWriter) error
type PutNetworkDNS500JSONResponse ¶
type PutNetworkDNS500JSONResponse externalRef0.ErrorResponse
func (PutNetworkDNS500JSONResponse) VisitPutNetworkDNSResponse ¶
func (response PutNetworkDNS500JSONResponse) VisitPutNetworkDNSResponse(w http.ResponseWriter) error
type PutNetworkDNSJSONRequestBody ¶
type PutNetworkDNSJSONRequestBody = DNSConfigUpdateRequest
PutNetworkDNSJSONRequestBody defines body for PutNetworkDNS for application/json ContentType.
type PutNetworkDNSParams ¶
type PutNetworkDNSParams struct {
// TargetHostname Target: _any (load-balanced), _all (broadcast), hostname (direct), or key:value (label group, e.g., group:web.dev).
TargetHostname *string `form:"target_hostname,omitempty" json:"target_hostname,omitempty" validate:"omitempty,min=1,valid_target"`
}
PutNetworkDNSParams defines parameters for PutNetworkDNS.
type PutNetworkDNSRequestObject ¶
type PutNetworkDNSRequestObject struct {
Params PutNetworkDNSParams
Body *PutNetworkDNSJSONRequestBody
}
type PutNetworkDNSResponseObject ¶
type PutNetworkDNSResponseObject interface {
VisitPutNetworkDNSResponse(w http.ResponseWriter) error
}
type ServerInterface ¶
type ServerInterface interface {
// Update DNS servers
// (PUT /network/dns)
PutNetworkDNS(ctx echo.Context, params PutNetworkDNSParams) error
// List DNS servers
// (GET /network/dns/{interfaceName})
GetNetworkDNSByInterface(ctx echo.Context, interfaceName string, params GetNetworkDNSByInterfaceParams) error
// Ping a remote server
// (POST /network/ping)
PostNetworkPing(ctx echo.Context, params PostNetworkPingParams) error
}
ServerInterface represents all server handlers.
func NewStrictHandler ¶
func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
}
ServerInterfaceWrapper converts echo contexts to parameters.
func (*ServerInterfaceWrapper) GetNetworkDNSByInterface ¶
func (w *ServerInterfaceWrapper) GetNetworkDNSByInterface(ctx echo.Context) error
GetNetworkDNSByInterface converts echo context to params.
func (*ServerInterfaceWrapper) PostNetworkPing ¶
func (w *ServerInterfaceWrapper) PostNetworkPing(ctx echo.Context) error
PostNetworkPing converts echo context to params.
func (*ServerInterfaceWrapper) PutNetworkDNS ¶
func (w *ServerInterfaceWrapper) PutNetworkDNS(ctx echo.Context) error
PutNetworkDNS converts echo context to params.
type StrictHandlerFunc ¶
type StrictHandlerFunc = strictecho.StrictEchoHandlerFunc
type StrictMiddlewareFunc ¶
type StrictMiddlewareFunc = strictecho.StrictEchoMiddlewareFunc
type StrictServerInterface ¶
type StrictServerInterface interface {
// Update DNS servers
// (PUT /network/dns)
PutNetworkDNS(ctx context.Context, request PutNetworkDNSRequestObject) (PutNetworkDNSResponseObject, error)
// List DNS servers
// (GET /network/dns/{interfaceName})
GetNetworkDNSByInterface(ctx context.Context, request GetNetworkDNSByInterfaceRequestObject) (GetNetworkDNSByInterfaceResponseObject, error)
// Ping a remote server
// (POST /network/ping)
PostNetworkPing(ctx context.Context, request PostNetworkPingRequestObject) (PostNetworkPingResponseObject, error)
}
StrictServerInterface represents all server handlers.