api

Documentation

Overview

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

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

Index

• func GetSwagger() (swagger *openapi3.T, err error)
• func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
• func RegisterHandlers(router *gin.Engine, si ServerInterface) *gin.Engine
• func RegisterHandlersWithOptions(router *gin.Engine, si ServerInterface, options GinServerOptions) *gin.Engine
• type GinServerOptions
• type ListPipelinesResponse
• type MiddlewareFunc
• type Pipeline
• type PipelineListParams
• type ServerInterface
• type ServerInterfaceWrapper
  • func (siw *ServerInterfaceWrapper) PipelineList(c *gin.Context)

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 *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
	ErrorHandler func(*gin.Context, error, int)
}

GinServerOptions provides options for the Gin server.

type ListPipelinesResponse

type ListPipelinesResponse struct {
	Items     *[]Pipeline `json:"items,omitempty"`
	NextToken *string     `json:"next_token,omitempty"`
}

ListPipelinesResponse defines model for ListPipelinesResponse.

type MiddlewareFunc

type MiddlewareFunc func(c *gin.Context)

type Pipeline

type Pipeline struct {
	Id       *int64  `json:"id,omitempty"`
	Username *string `json:"username,omitempty"`
}

Pipeline defines model for Pipeline.

type PipelineListParams

type PipelineListParams struct {
	// Limit The max number of items to fetch per page of data, subject to a min and max of 1 and 100 respectively. If not specified will default to 25.
	Limit *int `form:"limit,omitempty" json:"limit,omitempty"`

	// NextToken When list results are truncated, next_token will be returned, which is a cursor to fetch the next page of data. Pass next_token to the subsequent list request to fetch the next page of data.
	NextToken *string `form:"next_token,omitempty" json:"next_token,omitempty"`
}

PipelineListParams defines parameters for PipelineList.

type ServerInterface

type ServerInterface interface {
	// List Pipelines
	// (GET /pipeline)
	PipelineList(c *gin.Context, params PipelineListParams)
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandler       func(*gin.Context, error, int)
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) PipelineList

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

PipelineList operation middleware