Documentation
¶
Index ¶
- type EzDeployApiserverAPI
- func (o *EzDeployApiserverAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
- func (o *EzDeployApiserverAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *EzDeployApiserverAPI) Authorizer() runtime.Authorizer
- func (o *EzDeployApiserverAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *EzDeployApiserverAPI) Context() *middleware.Context
- func (o *EzDeployApiserverAPI) DefaultConsumes() string
- func (o *EzDeployApiserverAPI) DefaultProduces() string
- func (o *EzDeployApiserverAPI) Formats() strfmt.Registry
- func (o *EzDeployApiserverAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *EzDeployApiserverAPI) Init()
- func (o *EzDeployApiserverAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *EzDeployApiserverAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *EzDeployApiserverAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *EzDeployApiserverAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *EzDeployApiserverAPI) Serve(builder middleware.Builder) http.Handler
- func (o *EzDeployApiserverAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *EzDeployApiserverAPI) SetDefaultConsumes(mediaType string)
- func (o *EzDeployApiserverAPI) SetDefaultProduces(mediaType string)
- func (o *EzDeployApiserverAPI) SetSpec(spec *loads.Document)
- func (o *EzDeployApiserverAPI) UseRedoc()
- func (o *EzDeployApiserverAPI) UseSwaggerUI()
- func (o *EzDeployApiserverAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EzDeployApiserverAPI ¶
type EzDeployApiserverAPI struct {
Middleware func(middleware.Builder) http.Handler
// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
// It has a default implementation in the security package, however you can replace it for your particular usage.
BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator
// APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function.
// It has a default implementation in the security package, however you can replace it for your particular usage.
APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator
// BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function.
// It has a default implementation in the security package, however you can replace it for your particular usage.
BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator
// JSONConsumer registers a consumer for the following mime types:
// - application/json
JSONConsumer runtime.Consumer
// JSONProducer registers a producer for the following mime types:
// - application/json
JSONProducer runtime.Producer
// KeyAuth registers a function that takes a token and returns a principal
// it performs authentication based on an api key X-EZDEOPLY-APIKEY provided in the header
KeyAuth func(string) (*models.IdentityVerifyResp, error)
// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
APIAuthorizer runtime.Authorizer
// AuthorityOpsAuthorityOpsDeleteAuthoritiesHandler sets the operation handler for the authority ops delete authorities operation
AuthorityOpsAuthorityOpsDeleteAuthoritiesHandler authority_ops.AuthorityOpsDeleteAuthoritiesHandler
// AuthorityOpsAuthorityOpsListAuthoritiesByIdentityHandler sets the operation handler for the authority ops list authorities by identity operation
AuthorityOpsAuthorityOpsListAuthoritiesByIdentityHandler authority_ops.AuthorityOpsListAuthoritiesByIdentityHandler
// AuthorityOpsAuthorityOpsListAuthoritiesByResourceHandler sets the operation handler for the authority ops list authorities by resource operation
AuthorityOpsAuthorityOpsListAuthoritiesByResourceHandler authority_ops.AuthorityOpsListAuthoritiesByResourceHandler
// AuthorityOpsAuthorityOpsSetAuthoritiesHandler sets the operation handler for the authority ops set authorities operation
AuthorityOpsAuthorityOpsSetAuthoritiesHandler authority_ops.AuthorityOpsSetAuthoritiesHandler
// IdentityOpsIdentityOpsDeletePublicTokenHandler sets the operation handler for the identity ops delete public token operation
IdentityOpsIdentityOpsDeletePublicTokenHandler identity_ops.IdentityOpsDeletePublicTokenHandler
// IdentityOpsIdentityOpsGeneratePublicTokenHandler sets the operation handler for the identity ops generate public token operation
IdentityOpsIdentityOpsGeneratePublicTokenHandler identity_ops.IdentityOpsGeneratePublicTokenHandler
// IdentityOpsIdentityOpsGetPrivateTokenHandler sets the operation handler for the identity ops get private token operation
IdentityOpsIdentityOpsGetPrivateTokenHandler identity_ops.IdentityOpsGetPrivateTokenHandler
// IdentityOpsIdentityOpsListPublicTokenHandler sets the operation handler for the identity ops list public token operation
IdentityOpsIdentityOpsListPublicTokenHandler identity_ops.IdentityOpsListPublicTokenHandler
// IdentityOpsIdentityOpsLoginHandler sets the operation handler for the identity ops login operation
IdentityOpsIdentityOpsLoginHandler identity_ops.IdentityOpsLoginHandler
// IdentityOpsIdentityOpsReGeneratePrivateTokenHandler sets the operation handler for the identity ops re generate private token operation
IdentityOpsIdentityOpsReGeneratePrivateTokenHandler identity_ops.IdentityOpsReGeneratePrivateTokenHandler
// IdentityOpsIdentityOpsRegisterHandler sets the operation handler for the identity ops register operation
IdentityOpsIdentityOpsRegisterHandler identity_ops.IdentityOpsRegisterHandler
// IdentityOpsIdentityOpsVerifyHandler sets the operation handler for the identity ops verify operation
IdentityOpsIdentityOpsVerifyHandler identity_ops.IdentityOpsVerifyHandler
// ProjectOpsProjectOpsCreateProjectHandler sets the operation handler for the project ops create project operation
ProjectOpsProjectOpsCreateProjectHandler project_ops.ProjectOpsCreateProjectHandler
// ProjectOpsProjectOpsDeleteProjectHandler sets the operation handler for the project ops delete project operation
ProjectOpsProjectOpsDeleteProjectHandler project_ops.ProjectOpsDeleteProjectHandler
// ProjectOpsProjectOpsDeleteServiceHandler sets the operation handler for the project ops delete service operation
ProjectOpsProjectOpsDeleteServiceHandler project_ops.ProjectOpsDeleteServiceHandler
// ProjectOpsProjectOpsGetServiceHandler sets the operation handler for the project ops get service operation
ProjectOpsProjectOpsGetServiceHandler project_ops.ProjectOpsGetServiceHandler
// ProjectOpsProjectOpsListHandler sets the operation handler for the project ops list operation
ProjectOpsProjectOpsListHandler project_ops.ProjectOpsListHandler
// ProjectOpsProjectOpsListPodsHandler sets the operation handler for the project ops list pods operation
ProjectOpsProjectOpsListPodsHandler project_ops.ProjectOpsListPodsHandler
// ProjectOpsProjectOpsListServiceHandler sets the operation handler for the project ops list service operation
ProjectOpsProjectOpsListServiceHandler project_ops.ProjectOpsListServiceHandler
// ProjectOpsProjectOpsSetServiceHandler sets the operation handler for the project ops set service operation
ProjectOpsProjectOpsSetServiceHandler project_ops.ProjectOpsSetServiceHandler
// ServeError is called when an error is received, there is a default handler
// but you can set your own with this
ServeError func(http.ResponseWriter, *http.Request, error)
// PreServerShutdown is called before the HTTP(S) server is shutdown
// This allows for custom functions to get executed before the HTTP(S) server stops accepting traffic
PreServerShutdown func()
// ServerShutdown is called when the HTTP(S) server is shut down and done
// handling all active connections and does not accept connections any more
ServerShutdown func()
// Custom command line argument groups with their descriptions
CommandLineOptionsGroups []swag.CommandLineOptionsGroup
// User defined logger function.
Logger func(string, ...interface{})
// contains filtered or unexported fields
}
EzDeployApiserverAPI apiserver
func NewEzDeployApiserverAPI ¶
func NewEzDeployApiserverAPI(spec *loads.Document) *EzDeployApiserverAPI
NewEzDeployApiserverAPI creates a new EzDeployApiserver instance
func (*EzDeployApiserverAPI) AddMiddlewareFor ¶
func (o *EzDeployApiserverAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*EzDeployApiserverAPI) AuthenticatorsFor ¶
func (o *EzDeployApiserverAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*EzDeployApiserverAPI) Authorizer ¶
func (o *EzDeployApiserverAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*EzDeployApiserverAPI) ConsumersFor ¶
func (o *EzDeployApiserverAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (*EzDeployApiserverAPI) Context ¶
func (o *EzDeployApiserverAPI) Context() *middleware.Context
Context returns the middleware context for the ez deploy apiserver API
func (*EzDeployApiserverAPI) DefaultConsumes ¶
func (o *EzDeployApiserverAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*EzDeployApiserverAPI) DefaultProduces ¶
func (o *EzDeployApiserverAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*EzDeployApiserverAPI) Formats ¶
func (o *EzDeployApiserverAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*EzDeployApiserverAPI) HandlerFor ¶
func (o *EzDeployApiserverAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*EzDeployApiserverAPI) Init ¶
func (o *EzDeployApiserverAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*EzDeployApiserverAPI) ProducersFor ¶
func (o *EzDeployApiserverAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (*EzDeployApiserverAPI) RegisterConsumer ¶
func (o *EzDeployApiserverAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*EzDeployApiserverAPI) RegisterFormat ¶
func (o *EzDeployApiserverAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
RegisterFormat registers a custom format validator
func (*EzDeployApiserverAPI) RegisterProducer ¶
func (o *EzDeployApiserverAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (*EzDeployApiserverAPI) Serve ¶
func (o *EzDeployApiserverAPI) Serve(builder middleware.Builder) http.Handler
Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))
func (*EzDeployApiserverAPI) ServeErrorFor ¶
func (o *EzDeployApiserverAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*EzDeployApiserverAPI) SetDefaultConsumes ¶
func (o *EzDeployApiserverAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*EzDeployApiserverAPI) SetDefaultProduces ¶
func (o *EzDeployApiserverAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*EzDeployApiserverAPI) SetSpec ¶
func (o *EzDeployApiserverAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*EzDeployApiserverAPI) UseRedoc ¶
func (o *EzDeployApiserverAPI) UseRedoc()
UseRedoc for documentation at /docs
func (*EzDeployApiserverAPI) UseSwaggerUI ¶
func (o *EzDeployApiserverAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs
func (*EzDeployApiserverAPI) Validate ¶
func (o *EzDeployApiserverAPI) Validate() error
Validate validates the registrations in the EzDeployApiserverAPI