authconfigs

Documentation

Overview

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

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

Index

• func GetSwagger() (swagger *openapi3.T, err error)
• func Handler(si ServerInterface) http.Handler
• func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
• func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler
• func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
• func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
• type ChiServerOptions
• type MiddlewareFunc
• type ServerInterface
  • func New() ServerInterface
• type ServerInterfaceWrapper
  • func (siw *ServerInterfaceWrapper) ListVironAuthconfigs(w http.ResponseWriter, r *http.Request)
• type VironAuthConfig
• type VironAuthConfigList
• type VironAuthConfigListWithOas
• type VironAuthConfigType
• type VironAuthOas

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 Handler

func Handler(si ServerInterface) http.Handler

Handler creates http.Handler with routing matching OpenAPI spec.

func HandlerFromMux

func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

func HandlerFromMuxWithBaseURL

func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler

func HandlerWithOptions

func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler

HandlerWithOptions creates http.Handler with additional options

func PathToRawSpec

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

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

Types

type ChiServerOptions

type ChiServerOptions struct {
	BaseURL     string
	BaseRouter  chi.Router
	Middlewares []MiddlewareFunc
}

type MiddlewareFunc

type MiddlewareFunc func(http.HandlerFunc) http.HandlerFunc

type ServerInterface

type ServerInterface interface {
	// list auth configs
	// (GET /viron/authconfigs)
	ListVironAuthconfigs(w http.ResponseWriter, r *http.Request)
}

ServerInterface represents all server handlers.

func New

func New() ServerInterface

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) ListVironAuthconfigs

func (siw *ServerInterfaceWrapper) ListVironAuthconfigs(w http.ResponseWriter, r *http.Request)

ListVironAuthconfigs operation middleware

type VironAuthConfig

type VironAuthConfig struct {
	// クライアントからリクエストする際のパラメータ
	DefaultParametersValue *map[string]interface{} `json:"defaultParametersValue,omitempty"`

	// クライアントからリクエストする際のリクエストボディ
	DefaultRequestBodyValue *map[string]interface{} `json:"defaultRequestBodyValue,omitempty"`

	// 認証プロバイダ
	Provider string `json:"provider"`

	// 認証方式
	Type VironAuthConfigType `json:"type"`
}

VironAuthConfig defines model for VironAuthConfig.

type VironAuthConfigList

type VironAuthConfigList []VironAuthConfig

VironAuthConfigList defines model for VironAuthConfigList.

type VironAuthConfigListWithOas

type VironAuthConfigListWithOas struct {
	List VironAuthConfigList `json:"list"`
	Oas  VironAuthOas        `json:"oas"`
}

VironAuthConfigListWithOas defines model for VironAuthConfigListWithOas.

type VironAuthConfigType

type VironAuthConfigType string

認証方式

const (
	VironAuthConfigTypeEmail VironAuthConfigType = "email"

	VironAuthConfigTypeOauth VironAuthConfigType = "oauth"

	VironAuthConfigTypeSignout VironAuthConfigType = "signout"
)

Defines values for VironAuthConfigType.

type VironAuthOas

type VironAuthOas struct {
	// oas components
	Components *map[string]interface{} `json:"components,omitempty"`

	// oas info
	Info *map[string]interface{} `json:"info,omitempty"`

	// oas paths
	Paths *map[string]interface{} `json:"paths,omitempty"`
}

VironAuthOas defines model for VironAuthOas.