server

package
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Oct 8, 2023 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

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

Code generated by gitlab.com/ginfra/ginfra version (devel) 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 PathToRawSpec

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

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

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 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 GiConfigDeregisterService200JSONResponse

type GiConfigDeregisterService200JSONResponse ConfigServiceRegistrationResponse

func (GiConfigDeregisterService200JSONResponse) VisitGiConfigDeregisterServiceResponse

func (response GiConfigDeregisterService200JSONResponse) VisitGiConfigDeregisterServiceResponse(w http.ResponseWriter) error

type GiConfigDeregisterService400JSONResponse

type GiConfigDeregisterService400JSONResponse ErrorResponse

func (GiConfigDeregisterService400JSONResponse) VisitGiConfigDeregisterServiceResponse

func (response GiConfigDeregisterService400JSONResponse) VisitGiConfigDeregisterServiceResponse(w http.ResponseWriter) error

type GiConfigDeregisterService403Response

type GiConfigDeregisterService403Response struct {
}

func (GiConfigDeregisterService403Response) VisitGiConfigDeregisterServiceResponse

func (response GiConfigDeregisterService403Response) VisitGiConfigDeregisterServiceResponse(w http.ResponseWriter) error

type GiConfigDeregisterService500JSONResponse

type GiConfigDeregisterService500JSONResponse ErrorResponse

func (GiConfigDeregisterService500JSONResponse) VisitGiConfigDeregisterServiceResponse

func (response GiConfigDeregisterService500JSONResponse) VisitGiConfigDeregisterServiceResponse(w http.ResponseWriter) error

type GiConfigDeregisterServiceRequestObject

type GiConfigDeregisterServiceRequestObject struct {
	Deployment string `json:"deployment"`
	Name       string `json:"name"`
	Params     GiConfigDeregisterServiceParams
}

type GiConfigDeregisterServiceResponseObject

type GiConfigDeregisterServiceResponseObject interface {
	VisitGiConfigDeregisterServiceResponse(w http.ResponseWriter) error
}

type GiConfigPortal200Response

type GiConfigPortal200Response struct {
}

func (GiConfigPortal200Response) VisitGiConfigPortalResponse

func (response GiConfigPortal200Response) VisitGiConfigPortalResponse(w http.ResponseWriter) error

type GiConfigPortal400JSONResponse

type GiConfigPortal400JSONResponse ErrorResponse

func (GiConfigPortal400JSONResponse) VisitGiConfigPortalResponse

func (response GiConfigPortal400JSONResponse) VisitGiConfigPortalResponse(w http.ResponseWriter) error

type GiConfigPortal403Response

type GiConfigPortal403Response struct {
}

func (GiConfigPortal403Response) VisitGiConfigPortalResponse

func (response GiConfigPortal403Response) VisitGiConfigPortalResponse(w http.ResponseWriter) error

type GiConfigPortal500JSONResponse

type GiConfigPortal500JSONResponse ErrorResponse

func (GiConfigPortal500JSONResponse) VisitGiConfigPortalResponse

func (response GiConfigPortal500JSONResponse) VisitGiConfigPortalResponse(w http.ResponseWriter) error

type GiConfigPortalRequestObject

type GiConfigPortalRequestObject struct {
	Operation  GiConfigPortalParamsOperation `json:"operation"`
	Deployment string                        `json:"deployment"`
	Params     GiConfigPortalParams
	Body       *GiConfigPortalJSONRequestBody
}

type GiConfigPortalResponseObject

type GiConfigPortalResponseObject interface {
	VisitGiConfigPortalResponse(w http.ResponseWriter) error
}

type GiConfigQueryConfig200JSONResponse

type GiConfigQueryConfig200JSONResponse ConfigQueryResponse

func (GiConfigQueryConfig200JSONResponse) VisitGiConfigQueryConfigResponse

func (response GiConfigQueryConfig200JSONResponse) VisitGiConfigQueryConfigResponse(w http.ResponseWriter) error

type GiConfigQueryConfig400JSONResponse

type GiConfigQueryConfig400JSONResponse ErrorResponse

func (GiConfigQueryConfig400JSONResponse) VisitGiConfigQueryConfigResponse

func (response GiConfigQueryConfig400JSONResponse) VisitGiConfigQueryConfigResponse(w http.ResponseWriter) error

type GiConfigQueryConfig404Response

type GiConfigQueryConfig404Response struct {
}

func (GiConfigQueryConfig404Response) VisitGiConfigQueryConfigResponse

func (response GiConfigQueryConfig404Response) VisitGiConfigQueryConfigResponse(w http.ResponseWriter) error

type GiConfigQueryConfig500JSONResponse

type GiConfigQueryConfig500JSONResponse ErrorResponse

func (GiConfigQueryConfig500JSONResponse) VisitGiConfigQueryConfigResponse

func (response GiConfigQueryConfig500JSONResponse) VisitGiConfigQueryConfigResponse(w http.ResponseWriter) error

type GiConfigQueryConfigRequestObject

type GiConfigQueryConfigRequestObject struct {
	Params GiConfigQueryConfigParams
}

type GiConfigQueryConfigResponseObject

type GiConfigQueryConfigResponseObject interface {
	VisitGiConfigQueryConfigResponse(w http.ResponseWriter) error
}

type GiConfigRegisterInstance200JSONResponse

type GiConfigRegisterInstance200JSONResponse ConfigServiceRegistrationResponse

func (GiConfigRegisterInstance200JSONResponse) VisitGiConfigRegisterInstanceResponse

func (response GiConfigRegisterInstance200JSONResponse) VisitGiConfigRegisterInstanceResponse(w http.ResponseWriter) error

type GiConfigRegisterInstance400JSONResponse

type GiConfigRegisterInstance400JSONResponse ErrorResponse

func (GiConfigRegisterInstance400JSONResponse) VisitGiConfigRegisterInstanceResponse

func (response GiConfigRegisterInstance400JSONResponse) VisitGiConfigRegisterInstanceResponse(w http.ResponseWriter) error

type GiConfigRegisterInstance403Response

type GiConfigRegisterInstance403Response struct {
}

func (GiConfigRegisterInstance403Response) VisitGiConfigRegisterInstanceResponse

func (response GiConfigRegisterInstance403Response) VisitGiConfigRegisterInstanceResponse(w http.ResponseWriter) error

type GiConfigRegisterInstance500JSONResponse

type GiConfigRegisterInstance500JSONResponse ErrorResponse

func (GiConfigRegisterInstance500JSONResponse) VisitGiConfigRegisterInstanceResponse

func (response GiConfigRegisterInstance500JSONResponse) VisitGiConfigRegisterInstanceResponse(w http.ResponseWriter) error

type GiConfigRegisterInstanceRequestObject

type GiConfigRegisterInstanceRequestObject struct {
	Params GiConfigRegisterInstanceParams
	Body   *GiConfigRegisterInstanceJSONRequestBody
}

type GiConfigRegisterInstanceResponseObject

type GiConfigRegisterInstanceResponseObject interface {
	VisitGiConfigRegisterInstanceResponse(w http.ResponseWriter) error
}

type GiConfigRegisterService200JSONResponse

type GiConfigRegisterService200JSONResponse ConfigServiceRegistrationResponse

func (GiConfigRegisterService200JSONResponse) VisitGiConfigRegisterServiceResponse

func (response GiConfigRegisterService200JSONResponse) VisitGiConfigRegisterServiceResponse(w http.ResponseWriter) error

type GiConfigRegisterService400JSONResponse

type GiConfigRegisterService400JSONResponse ErrorResponse

func (GiConfigRegisterService400JSONResponse) VisitGiConfigRegisterServiceResponse

func (response GiConfigRegisterService400JSONResponse) VisitGiConfigRegisterServiceResponse(w http.ResponseWriter) error

type GiConfigRegisterService403Response

type GiConfigRegisterService403Response struct {
}

func (GiConfigRegisterService403Response) VisitGiConfigRegisterServiceResponse

func (response GiConfigRegisterService403Response) VisitGiConfigRegisterServiceResponse(w http.ResponseWriter) error

type GiConfigRegisterService500JSONResponse

type GiConfigRegisterService500JSONResponse ErrorResponse

func (GiConfigRegisterService500JSONResponse) VisitGiConfigRegisterServiceResponse

func (response GiConfigRegisterService500JSONResponse) VisitGiConfigRegisterServiceResponse(w http.ResponseWriter) error

type GiConfigRegisterServiceRequestObject

type GiConfigRegisterServiceRequestObject struct {
	Params GiConfigRegisterServiceParams
	Body   *GiConfigRegisterServiceJSONRequestBody
}

type GiConfigRegisterServiceResponseObject

type GiConfigRegisterServiceResponseObject interface {
	VisitGiConfigRegisterServiceResponse(w http.ResponseWriter) error
}

type GiConfigSetConfig200Response

type GiConfigSetConfig200Response struct {
}

func (GiConfigSetConfig200Response) VisitGiConfigSetConfigResponse

func (response GiConfigSetConfig200Response) VisitGiConfigSetConfigResponse(w http.ResponseWriter) error

type GiConfigSetConfig400JSONResponse

type GiConfigSetConfig400JSONResponse ErrorResponse

func (GiConfigSetConfig400JSONResponse) VisitGiConfigSetConfigResponse

func (response GiConfigSetConfig400JSONResponse) VisitGiConfigSetConfigResponse(w http.ResponseWriter) error

type GiConfigSetConfig403Response

type GiConfigSetConfig403Response struct {
}

func (GiConfigSetConfig403Response) VisitGiConfigSetConfigResponse

func (response GiConfigSetConfig403Response) VisitGiConfigSetConfigResponse(w http.ResponseWriter) error

type GiConfigSetConfig500JSONResponse

type GiConfigSetConfig500JSONResponse ErrorResponse

func (GiConfigSetConfig500JSONResponse) VisitGiConfigSetConfigResponse

func (response GiConfigSetConfig500JSONResponse) VisitGiConfigSetConfigResponse(w http.ResponseWriter) error

type GiConfigSetConfigRequestObject

type GiConfigSetConfigRequestObject struct {
	Params GiConfigSetConfigParams
	Body   *GiConfigSetConfigJSONRequestBody
}

type GiConfigSetConfigResponseObject

type GiConfigSetConfigResponseObject interface {
	VisitGiConfigSetConfigResponse(w http.ResponseWriter) error
}

type GiDiscoverPortal200JSONResponse

type GiDiscoverPortal200JSONResponse DiscoverPortalResponse

func (GiDiscoverPortal200JSONResponse) VisitGiDiscoverPortalResponse

func (response GiDiscoverPortal200JSONResponse) VisitGiDiscoverPortalResponse(w http.ResponseWriter) error

type GiDiscoverPortal400JSONResponse

type GiDiscoverPortal400JSONResponse ErrorResponse

func (GiDiscoverPortal400JSONResponse) VisitGiDiscoverPortalResponse

func (response GiDiscoverPortal400JSONResponse) VisitGiDiscoverPortalResponse(w http.ResponseWriter) error

type GiDiscoverPortal404Response

type GiDiscoverPortal404Response struct {
}

func (GiDiscoverPortal404Response) VisitGiDiscoverPortalResponse

func (response GiDiscoverPortal404Response) VisitGiDiscoverPortalResponse(w http.ResponseWriter) error

type GiDiscoverPortal500JSONResponse

type GiDiscoverPortal500JSONResponse ErrorResponse

func (GiDiscoverPortal500JSONResponse) VisitGiDiscoverPortalResponse

func (response GiDiscoverPortal500JSONResponse) VisitGiDiscoverPortalResponse(w http.ResponseWriter) error

type GiDiscoverPortalRequestObject

type GiDiscoverPortalRequestObject struct {
	Deployment   string `json:"deployment"`
	Serviceclass string `json:"serviceclass"`
	Params       GiDiscoverPortalParams
}

type GiDiscoverPortalResponseObject

type GiDiscoverPortalResponseObject interface {
	VisitGiDiscoverPortalResponse(w http.ResponseWriter) error
}

type GiDiscoverService200JSONResponse

type GiDiscoverService200JSONResponse DiscoverServiceResponse

func (GiDiscoverService200JSONResponse) VisitGiDiscoverServiceResponse

func (response GiDiscoverService200JSONResponse) VisitGiDiscoverServiceResponse(w http.ResponseWriter) error

type GiDiscoverService400JSONResponse

type GiDiscoverService400JSONResponse ErrorResponse

func (GiDiscoverService400JSONResponse) VisitGiDiscoverServiceResponse

func (response GiDiscoverService400JSONResponse) VisitGiDiscoverServiceResponse(w http.ResponseWriter) error

type GiDiscoverService404Response

type GiDiscoverService404Response struct {
}

func (GiDiscoverService404Response) VisitGiDiscoverServiceResponse

func (response GiDiscoverService404Response) VisitGiDiscoverServiceResponse(w http.ResponseWriter) error

type GiDiscoverService500JSONResponse

type GiDiscoverService500JSONResponse ErrorResponse

func (GiDiscoverService500JSONResponse) VisitGiDiscoverServiceResponse

func (response GiDiscoverService500JSONResponse) VisitGiDiscoverServiceResponse(w http.ResponseWriter) error

type GiDiscoverServiceRequestObject

type GiDiscoverServiceRequestObject struct {
	Deployment   string `json:"deployment"`
	Serviceclass string `json:"serviceclass"`
	Params       GiDiscoverServiceParams
}

type GiDiscoverServiceResponseObject

type GiDiscoverServiceResponseObject interface {
	VisitGiDiscoverServiceResponse(w http.ResponseWriter) error
}

type GiGetSpecifics200JSONResponse

type GiGetSpecifics200JSONResponse Specifics

func (GiGetSpecifics200JSONResponse) VisitGiGetSpecificsResponse

func (response GiGetSpecifics200JSONResponse) VisitGiGetSpecificsResponse(w http.ResponseWriter) error

type GiGetSpecifics500JSONResponse

type GiGetSpecifics500JSONResponse ErrorResponse

func (GiGetSpecifics500JSONResponse) VisitGiGetSpecificsResponse

func (response GiGetSpecifics500JSONResponse) VisitGiGetSpecificsResponse(w http.ResponseWriter) error

type GiGetSpecificsRequestObject

type GiGetSpecificsRequestObject struct {
}

type GiGetSpecificsResponseObject

type GiGetSpecificsResponseObject interface {
	VisitGiGetSpecificsResponse(w http.ResponseWriter) error
}

type GiRemoveConfig200Response

type GiRemoveConfig200Response struct {
}

func (GiRemoveConfig200Response) VisitGiRemoveConfigResponse

func (response GiRemoveConfig200Response) VisitGiRemoveConfigResponse(w http.ResponseWriter) error

type GiRemoveConfig400JSONResponse

type GiRemoveConfig400JSONResponse ErrorResponse

func (GiRemoveConfig400JSONResponse) VisitGiRemoveConfigResponse

func (response GiRemoveConfig400JSONResponse) VisitGiRemoveConfigResponse(w http.ResponseWriter) error

type GiRemoveConfig404Response

type GiRemoveConfig404Response struct {
}

func (GiRemoveConfig404Response) VisitGiRemoveConfigResponse

func (response GiRemoveConfig404Response) VisitGiRemoveConfigResponse(w http.ResponseWriter) error

type GiRemoveConfig500JSONResponse

type GiRemoveConfig500JSONResponse ErrorResponse

func (GiRemoveConfig500JSONResponse) VisitGiRemoveConfigResponse

func (response GiRemoveConfig500JSONResponse) VisitGiRemoveConfigResponse(w http.ResponseWriter) error

type GiRemoveConfigRequestObject

type GiRemoveConfigRequestObject struct {
	Params GiRemoveConfigParams
}

type GiRemoveConfigResponseObject

type GiRemoveConfigResponseObject interface {
	VisitGiRemoveConfigResponse(w http.ResponseWriter) error
}

type ServerInterface

type ServerInterface interface {
	// Deregister a service.
	// (POST /giconfig/deregister/{deployment}/{name}/)
	GiConfigDeregisterService(ctx echo.Context, deployment string, name string, params GiConfigDeregisterServiceParams) error
	// Discover a portal for a deployment.
	// (GET /giconfig/discover/portal/{deployment}/{serviceclass})
	GiDiscoverPortal(ctx echo.Context, deployment string, serviceclass string, params GiDiscoverPortalParams) error
	// Discover a service.
	// (GET /giconfig/discover/service/{deployment}/{serviceclass})
	GiDiscoverService(ctx echo.Context, deployment string, serviceclass string, params GiDiscoverServiceParams) error
	// Register or update a service instance.
	// (POST /giconfig/instance)
	GiConfigRegisterInstance(ctx echo.Context, params GiConfigRegisterInstanceParams) error
	// Register or update a portal.
	// (POST /giconfig/portal/{operation}/{deployment}/)
	GiConfigPortal(ctx echo.Context, operation GiConfigPortalParamsOperation, deployment string, params GiConfigPortalParams) error
	// Query config.
	// (GET /giconfig/query)
	GiConfigQueryConfig(ctx echo.Context, params GiConfigQueryConfigParams) error
	// Register a service.
	// (POST /giconfig/register)
	GiConfigRegisterService(ctx echo.Context, params GiConfigRegisterServiceParams) error
	// Remove config.
	// (GET /giconfig/remove)
	GiRemoveConfig(ctx echo.Context, params GiRemoveConfigParams) error
	// Set configurations.
	// (POST /giconfig/set)
	GiConfigSetConfig(ctx echo.Context, params GiConfigSetConfigParams) error
	// Get specifics for this service
	// (GET /specifics)
	GiGetSpecifics(ctx echo.Context) 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) GiConfigDeregisterService

func (w *ServerInterfaceWrapper) GiConfigDeregisterService(ctx echo.Context) error

GiConfigDeregisterService converts echo context to params.

func (*ServerInterfaceWrapper) GiConfigPortal

func (w *ServerInterfaceWrapper) GiConfigPortal(ctx echo.Context) error

GiConfigPortal converts echo context to params.

func (*ServerInterfaceWrapper) GiConfigQueryConfig

func (w *ServerInterfaceWrapper) GiConfigQueryConfig(ctx echo.Context) error

GiConfigQueryConfig converts echo context to params.

func (*ServerInterfaceWrapper) GiConfigRegisterInstance

func (w *ServerInterfaceWrapper) GiConfigRegisterInstance(ctx echo.Context) error

GiConfigRegisterInstance converts echo context to params.

func (*ServerInterfaceWrapper) GiConfigRegisterService

func (w *ServerInterfaceWrapper) GiConfigRegisterService(ctx echo.Context) error

GiConfigRegisterService converts echo context to params.

func (*ServerInterfaceWrapper) GiConfigSetConfig

func (w *ServerInterfaceWrapper) GiConfigSetConfig(ctx echo.Context) error

GiConfigSetConfig converts echo context to params.

func (*ServerInterfaceWrapper) GiDiscoverPortal

func (w *ServerInterfaceWrapper) GiDiscoverPortal(ctx echo.Context) error

GiDiscoverPortal converts echo context to params.

func (*ServerInterfaceWrapper) GiDiscoverService

func (w *ServerInterfaceWrapper) GiDiscoverService(ctx echo.Context) error

GiDiscoverService converts echo context to params.

func (*ServerInterfaceWrapper) GiGetSpecifics

func (w *ServerInterfaceWrapper) GiGetSpecifics(ctx echo.Context) error

GiGetSpecifics converts echo context to params.

func (*ServerInterfaceWrapper) GiRemoveConfig

func (w *ServerInterfaceWrapper) GiRemoveConfig(ctx echo.Context) error

GiRemoveConfig converts echo context to params.

type StrictHandlerFunc

type StrictHandlerFunc = runtime.StrictEchoHandlerFunc

type StrictMiddlewareFunc

type StrictMiddlewareFunc = runtime.StrictEchoMiddlewareFunc

type StrictServerInterface

type StrictServerInterface interface {
	// Deregister a service.
	// (POST /giconfig/deregister/{deployment}/{name}/)
	GiConfigDeregisterService(ctx context.Context, request GiConfigDeregisterServiceRequestObject) (GiConfigDeregisterServiceResponseObject, error)
	// Discover a portal for a deployment.
	// (GET /giconfig/discover/portal/{deployment}/{serviceclass})
	GiDiscoverPortal(ctx context.Context, request GiDiscoverPortalRequestObject) (GiDiscoverPortalResponseObject, error)
	// Discover a service.
	// (GET /giconfig/discover/service/{deployment}/{serviceclass})
	GiDiscoverService(ctx context.Context, request GiDiscoverServiceRequestObject) (GiDiscoverServiceResponseObject, error)
	// Register or update a service instance.
	// (POST /giconfig/instance)
	GiConfigRegisterInstance(ctx context.Context, request GiConfigRegisterInstanceRequestObject) (GiConfigRegisterInstanceResponseObject, error)
	// Register or update a portal.
	// (POST /giconfig/portal/{operation}/{deployment}/)
	GiConfigPortal(ctx context.Context, request GiConfigPortalRequestObject) (GiConfigPortalResponseObject, error)
	// Query config.
	// (GET /giconfig/query)
	GiConfigQueryConfig(ctx context.Context, request GiConfigQueryConfigRequestObject) (GiConfigQueryConfigResponseObject, error)
	// Register a service.
	// (POST /giconfig/register)
	GiConfigRegisterService(ctx context.Context, request GiConfigRegisterServiceRequestObject) (GiConfigRegisterServiceResponseObject, error)
	// Remove config.
	// (GET /giconfig/remove)
	GiRemoveConfig(ctx context.Context, request GiRemoveConfigRequestObject) (GiRemoveConfigResponseObject, error)
	// Set configurations.
	// (POST /giconfig/set)
	GiConfigSetConfig(ctx context.Context, request GiConfigSetConfigRequestObject) (GiConfigSetConfigResponseObject, error)
	// Get specifics for this service
	// (GET /specifics)
	GiGetSpecifics(ctx context.Context, request GiGetSpecificsRequestObject) (GiGetSpecificsResponseObject, error)
}

StrictServerInterface represents all server handlers.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL