Documentation
¶
Overview ¶
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.11.0 DO NOT EDIT.
Index ¶
- func GetSwagger() (swagger *openapi3.T, err error)
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- func RegisterHandlers(router EchoRouter, si ServerInterface)
- func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
- type CreateOrganizationParams
- type EchoRouter
- type Error
- type ErrorResponse
- type Organization
- type ServerInterface
- type ServerInterfaceWrapper
- func (w *ServerInterfaceWrapper) CreateOrganization(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) DeleteOrganization(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) FindOrganization(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) UpdateOrganization(ctx echo.Context) error
- type UpdateOrganizationParams
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetSwagger ¶
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 ¶
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 CreateOrganizationParams ¶
type CreateOrganizationParams struct {
Name string `form:"name" json:"name"`
Description *string `form:"description,omitempty" json:"description,omitempty"`
}
CreateOrganizationParams defines parameters for CreateOrganization.
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 Organization ¶
type Organization struct {
CreatedOn *openapi_types.Date `json:"createdOn,omitempty"`
Description *string `json:"description,omitempty"`
Name string `json:"name"`
UpdatedOn *openapi_types.Date `json:"updatedOn,omitempty"`
}
Organization defines model for Organization.
type ServerInterface ¶
type ServerInterface interface {
// (POST /v1/organizations)
CreateOrganization(ctx echo.Context, params CreateOrganizationParams) error
// (DELETE /v1/organizations/{name})
DeleteOrganization(ctx echo.Context, name string) error
// (GET /v1/organizations/{name})
FindOrganization(ctx echo.Context, name string) error
// (PUT /v1/organizations/{name})
UpdateOrganization(ctx echo.Context, name string, params UpdateOrganizationParams) error
}
ServerInterface represents all server handlers.
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
}
ServerInterfaceWrapper converts echo contexts to parameters.
func (*ServerInterfaceWrapper) CreateOrganization ¶
func (w *ServerInterfaceWrapper) CreateOrganization(ctx echo.Context) error
CreateOrganization converts echo context to params.
func (*ServerInterfaceWrapper) DeleteOrganization ¶
func (w *ServerInterfaceWrapper) DeleteOrganization(ctx echo.Context) error
DeleteOrganization converts echo context to params.
func (*ServerInterfaceWrapper) FindOrganization ¶
func (w *ServerInterfaceWrapper) FindOrganization(ctx echo.Context) error
FindOrganization converts echo context to params.
func (*ServerInterfaceWrapper) UpdateOrganization ¶
func (w *ServerInterfaceWrapper) UpdateOrganization(ctx echo.Context) error
UpdateOrganization converts echo context to params.
type UpdateOrganizationParams ¶
type UpdateOrganizationParams struct {
Description *string `form:"description,omitempty" json:"description,omitempty"`
}
UpdateOrganizationParams defines parameters for UpdateOrganization.
Source Files