api

Documentation

Overview

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

Code generated by github.com/deepmap/oapi-codegen version v1.9.0 DO NOT EDIT.

Index

• func RegisterHandlers(router *gin.Engine, si ServerInterface) *gin.Engine
• func RegisterHandlersWithOptions(router *gin.Engine, si ServerInterface, options GinServerOptions) *gin.Engine
• type GinServerOptions
• type MiddlewareFunc
• type ServerInterface
• type ServerInterfaceWrapper
  • func (siw *ServerInterfaceWrapper) DeleteFleetId(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) DeletePathId(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) DeleteRuleId(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) DeleteTlsconfigId(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) GetFleet(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) GetFleetId(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) GetPath(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) GetPathId(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) GetRule(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) GetRuleId(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) GetTlsconfig(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) GetTlsconfigId(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) PostFleet(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) PostPath(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) PostRule(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) PostTlsconfig(c *gin.Context)

Functions

func RegisterHandlers

func RegisterHandlers(router *gin.Engine, si ServerInterface) *gin.Engine

RegisterHandlers creates http.Handler with routing matching OpenAPI spec.

func RegisterHandlersWithOptions

func RegisterHandlersWithOptions(router *gin.Engine, si ServerInterface, options GinServerOptions) *gin.Engine

RegisterHandlersWithOptions creates http.Handler with additional options

Types

type GinServerOptions

type GinServerOptions struct {
	BaseURL     string
	Middlewares []MiddlewareFunc
}

GinServerOptions provides options for the Gin server.

type MiddlewareFunc

type MiddlewareFunc func(c *gin.Context)

type ServerInterface

type ServerInterface interface {
	// Returns a list of all fleets
	// (GET /fleet)
	GetFleet(c *gin.Context)
	// Create an fleet
	// (POST /fleet)
	PostFleet(c *gin.Context)
	// Delete fleet with fleet id
	// (DELETE /fleet/{id})
	DeleteFleetId(c *gin.Context, id int)
	// Get fleet with specific id
	// (GET /fleet/{id})
	GetFleetId(c *gin.Context, id int)
	// Returns a list of all paths
	// (GET /path)
	GetPath(c *gin.Context)
	// Create an path
	// (POST /path)
	PostPath(c *gin.Context)
	// Delete Path with path id
	// (DELETE /path/{id})
	DeletePathId(c *gin.Context, id int)
	// Get account with specific id
	// (GET /path/{id})
	GetPathId(c *gin.Context, id int)
	// Returns a list of all rules
	// (GET /rule)
	GetRule(c *gin.Context)
	// Create a rule
	// (POST /rule)
	PostRule(c *gin.Context)
	// Delete rule with specific id
	// (DELETE /rule/{id})
	DeleteRuleId(c *gin.Context, id int)
	// Get rule with specific id
	// (GET /rule/{id})
	GetRuleId(c *gin.Context, id int)
	// Returns a list of all tlsconfig
	// (GET /tlsconfig)
	GetTlsconfig(c *gin.Context)
	// Create an tlsconfig
	// (POST /tlsconfig)
	PostTlsconfig(c *gin.Context)
	// Delete tlsconfig with tlsconfig id
	// (DELETE /tlsconfig/{id})
	DeleteTlsconfigId(c *gin.Context, id int)
	// Get tlsconfig with specific id
	// (GET /tlsconfig/{id})
	GetTlsconfigId(c *gin.Context, id int)
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) DeleteFleetId

func (siw *ServerInterfaceWrapper) DeleteFleetId(c *gin.Context)

DeleteFleetId operation middleware

func (*ServerInterfaceWrapper) DeletePathId

func (siw *ServerInterfaceWrapper) DeletePathId(c *gin.Context)

DeletePathId operation middleware

func (*ServerInterfaceWrapper) DeleteRuleId

func (siw *ServerInterfaceWrapper) DeleteRuleId(c *gin.Context)

DeleteRuleId operation middleware

func (*ServerInterfaceWrapper) DeleteTlsconfigId

func (siw *ServerInterfaceWrapper) DeleteTlsconfigId(c *gin.Context)

DeleteTlsconfigId operation middleware

func (*ServerInterfaceWrapper) GetFleet

func (siw *ServerInterfaceWrapper) GetFleet(c *gin.Context)

GetFleet operation middleware

func (*ServerInterfaceWrapper) GetFleetId

func (siw *ServerInterfaceWrapper) GetFleetId(c *gin.Context)

GetFleetId operation middleware

func (*ServerInterfaceWrapper) GetPath

func (siw *ServerInterfaceWrapper) GetPath(c *gin.Context)

GetPath operation middleware

func (*ServerInterfaceWrapper) GetPathId

func (siw *ServerInterfaceWrapper) GetPathId(c *gin.Context)

GetPathId operation middleware

func (*ServerInterfaceWrapper) GetRule

func (siw *ServerInterfaceWrapper) GetRule(c *gin.Context)

GetRule operation middleware

func (*ServerInterfaceWrapper) GetRuleId

func (siw *ServerInterfaceWrapper) GetRuleId(c *gin.Context)

GetRuleId operation middleware

func (*ServerInterfaceWrapper) GetTlsconfig

func (siw *ServerInterfaceWrapper) GetTlsconfig(c *gin.Context)

GetTlsconfig operation middleware

func (*ServerInterfaceWrapper) GetTlsconfigId

func (siw *ServerInterfaceWrapper) GetTlsconfigId(c *gin.Context)

GetTlsconfigId operation middleware

func (*ServerInterfaceWrapper) PostFleet

func (siw *ServerInterfaceWrapper) PostFleet(c *gin.Context)

PostFleet operation middleware

func (*ServerInterfaceWrapper) PostPath

func (siw *ServerInterfaceWrapper) PostPath(c *gin.Context)

PostPath operation middleware

func (*ServerInterfaceWrapper) PostRule

func (siw *ServerInterfaceWrapper) PostRule(c *gin.Context)

PostRule operation middleware

func (*ServerInterfaceWrapper) PostTlsconfig

func (siw *ServerInterfaceWrapper) PostTlsconfig(c *gin.Context)

PostTlsconfig operation middleware