operations

package
v0.20.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 19, 2022 License: AGPL-3.0 Imports: 31 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConsoleAPI 

type ConsoleAPI struct {
	Middleware func(middleware.Builder) http.Handler

	// Configuration passed in from MinIO for MinIO console.
	OpenIDProviders oauth2.OpenIDPCfg

	// 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
	// MultipartformConsumer registers a consumer for the following mime types:
	//   - multipart/form-data
	MultipartformConsumer runtime.Consumer

	// ApplicationZipProducer registers a producer for the following mime types:
	//   - application/zip
	ApplicationZipProducer runtime.Producer
	// BinProducer registers a producer for the following mime types:
	//   - application/octet-stream
	BinProducer runtime.Producer
	// JSONProducer registers a producer for the following mime types:
	//   - application/json
	JSONProducer runtime.Producer

	// KeyAuth registers a function that takes an access token and a collection of required scopes and returns a principal
	// it performs authentication based on an oauth2 bearer token provided in the request
	KeyAuth func(string, []string) (*models.Principal, error)

	// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
	APIAuthorizer runtime.Authorizer

	// AccountAccountChangePasswordHandler sets the operation handler for the account change password operation
	AccountAccountChangePasswordHandler account.AccountChangePasswordHandler
	// BucketAddBucketLifecycleHandler sets the operation handler for the add bucket lifecycle operation
	BucketAddBucketLifecycleHandler bucket.AddBucketLifecycleHandler
	// GroupAddGroupHandler sets the operation handler for the add group operation
	GroupAddGroupHandler group.AddGroupHandler
	// BucketAddMultiBucketLifecycleHandler sets the operation handler for the add multi bucket lifecycle operation
	BucketAddMultiBucketLifecycleHandler bucket.AddMultiBucketLifecycleHandler
	// ConfigurationAddNotificationEndpointHandler sets the operation handler for the add notification endpoint operation
	ConfigurationAddNotificationEndpointHandler configuration.AddNotificationEndpointHandler
	// PolicyAddPolicyHandler sets the operation handler for the add policy operation
	PolicyAddPolicyHandler policy.AddPolicyHandler
	// BucketAddRemoteBucketHandler sets the operation handler for the add remote bucket operation
	BucketAddRemoteBucketHandler bucket.AddRemoteBucketHandler
	// TieringAddTierHandler sets the operation handler for the add tier operation
	TieringAddTierHandler tiering.AddTierHandler
	// UserAddUserHandler sets the operation handler for the add user operation
	UserAddUserHandler user.AddUserHandler
	// SystemAdminInfoHandler sets the operation handler for the admin info operation
	SystemAdminInfoHandler system.AdminInfoHandler
	// SystemArnListHandler sets the operation handler for the arn list operation
	SystemArnListHandler system.ArnListHandler
	// BucketBucketInfoHandler sets the operation handler for the bucket info operation
	BucketBucketInfoHandler bucket.BucketInfoHandler
	// BucketBucketSetPolicyHandler sets the operation handler for the bucket set policy operation
	BucketBucketSetPolicyHandler bucket.BucketSetPolicyHandler
	// UserBulkUpdateUsersGroupsHandler sets the operation handler for the bulk update users groups operation
	UserBulkUpdateUsersGroupsHandler user.BulkUpdateUsersGroupsHandler
	// AccountChangeUserPasswordHandler sets the operation handler for the change user password operation
	AccountChangeUserPasswordHandler account.ChangeUserPasswordHandler
	// SystemCheckMinIOVersionHandler sets the operation handler for the check min i o version operation
	SystemCheckMinIOVersionHandler system.CheckMinIOVersionHandler
	// UserCheckUserServiceAccountsHandler sets the operation handler for the check user service accounts operation
	UserCheckUserServiceAccountsHandler user.CheckUserServiceAccountsHandler
	// ConfigurationConfigInfoHandler sets the operation handler for the config info operation
	ConfigurationConfigInfoHandler configuration.ConfigInfoHandler
	// UserCreateAUserServiceAccountHandler sets the operation handler for the create a user service account operation
	UserCreateAUserServiceAccountHandler user.CreateAUserServiceAccountHandler
	// BucketCreateBucketEventHandler sets the operation handler for the create bucket event operation
	BucketCreateBucketEventHandler bucket.CreateBucketEventHandler
	// ServiceAccountCreateServiceAccountHandler sets the operation handler for the create service account operation
	ServiceAccountCreateServiceAccountHandler service_account.CreateServiceAccountHandler
	// UserCreateServiceAccountCredentialsHandler sets the operation handler for the create service account credentials operation
	UserCreateServiceAccountCredentialsHandler user.CreateServiceAccountCredentialsHandler
	// ServiceAccountCreateServiceAccountCredsHandler sets the operation handler for the create service account creds operation
	ServiceAccountCreateServiceAccountCredsHandler service_account.CreateServiceAccountCredsHandler
	// SystemDashboardWidgetDetailsHandler sets the operation handler for the dashboard widget details operation
	SystemDashboardWidgetDetailsHandler system.DashboardWidgetDetailsHandler
	// BucketDeleteAccessRuleWithBucketHandler sets the operation handler for the delete access rule with bucket operation
	BucketDeleteAccessRuleWithBucketHandler bucket.DeleteAccessRuleWithBucketHandler
	// BucketDeleteAllReplicationRulesHandler sets the operation handler for the delete all replication rules operation
	BucketDeleteAllReplicationRulesHandler bucket.DeleteAllReplicationRulesHandler
	// BucketDeleteBucketHandler sets the operation handler for the delete bucket operation
	BucketDeleteBucketHandler bucket.DeleteBucketHandler
	// BucketDeleteBucketEventHandler sets the operation handler for the delete bucket event operation
	BucketDeleteBucketEventHandler bucket.DeleteBucketEventHandler
	// BucketDeleteBucketLifecycleRuleHandler sets the operation handler for the delete bucket lifecycle rule operation
	BucketDeleteBucketLifecycleRuleHandler bucket.DeleteBucketLifecycleRuleHandler
	// BucketDeleteBucketReplicationRuleHandler sets the operation handler for the delete bucket replication rule operation
	BucketDeleteBucketReplicationRuleHandler bucket.DeleteBucketReplicationRuleHandler
	// ObjectDeleteMultipleObjectsHandler sets the operation handler for the delete multiple objects operation
	ObjectDeleteMultipleObjectsHandler object.DeleteMultipleObjectsHandler
	// ServiceAccountDeleteMultipleServiceAccountsHandler sets the operation handler for the delete multiple service accounts operation
	ServiceAccountDeleteMultipleServiceAccountsHandler service_account.DeleteMultipleServiceAccountsHandler
	// ObjectDeleteObjectHandler sets the operation handler for the delete object operation
	ObjectDeleteObjectHandler object.DeleteObjectHandler
	// ObjectDeleteObjectRetentionHandler sets the operation handler for the delete object retention operation
	ObjectDeleteObjectRetentionHandler object.DeleteObjectRetentionHandler
	// BucketDeleteRemoteBucketHandler sets the operation handler for the delete remote bucket operation
	BucketDeleteRemoteBucketHandler bucket.DeleteRemoteBucketHandler
	// BucketDeleteSelectedReplicationRulesHandler sets the operation handler for the delete selected replication rules operation
	BucketDeleteSelectedReplicationRulesHandler bucket.DeleteSelectedReplicationRulesHandler
	// ServiceAccountDeleteServiceAccountHandler sets the operation handler for the delete service account operation
	ServiceAccountDeleteServiceAccountHandler service_account.DeleteServiceAccountHandler
	// BucketDisableBucketEncryptionHandler sets the operation handler for the disable bucket encryption operation
	BucketDisableBucketEncryptionHandler bucket.DisableBucketEncryptionHandler
	// ObjectDownloadObjectHandler sets the operation handler for the download object operation
	ObjectDownloadObjectHandler object.DownloadObjectHandler
	// TieringEditTierCredentialsHandler sets the operation handler for the edit tier credentials operation
	TieringEditTierCredentialsHandler tiering.EditTierCredentialsHandler
	// BucketEnableBucketEncryptionHandler sets the operation handler for the enable bucket encryption operation
	BucketEnableBucketEncryptionHandler bucket.EnableBucketEncryptionHandler
	// BucketGetBucketEncryptionInfoHandler sets the operation handler for the get bucket encryption info operation
	BucketGetBucketEncryptionInfoHandler bucket.GetBucketEncryptionInfoHandler
	// BucketGetBucketLifecycleHandler sets the operation handler for the get bucket lifecycle operation
	BucketGetBucketLifecycleHandler bucket.GetBucketLifecycleHandler
	// BucketGetBucketObjectLockingStatusHandler sets the operation handler for the get bucket object locking status operation
	BucketGetBucketObjectLockingStatusHandler bucket.GetBucketObjectLockingStatusHandler
	// BucketGetBucketQuotaHandler sets the operation handler for the get bucket quota operation
	BucketGetBucketQuotaHandler bucket.GetBucketQuotaHandler
	// BucketGetBucketReplicationHandler sets the operation handler for the get bucket replication operation
	BucketGetBucketReplicationHandler bucket.GetBucketReplicationHandler
	// BucketGetBucketReplicationRuleHandler sets the operation handler for the get bucket replication rule operation
	BucketGetBucketReplicationRuleHandler bucket.GetBucketReplicationRuleHandler
	// BucketGetBucketRetentionConfigHandler sets the operation handler for the get bucket retention config operation
	BucketGetBucketRetentionConfigHandler bucket.GetBucketRetentionConfigHandler
	// BucketGetBucketRewindHandler sets the operation handler for the get bucket rewind operation
	BucketGetBucketRewindHandler bucket.GetBucketRewindHandler
	// BucketGetBucketVersioningHandler sets the operation handler for the get bucket versioning operation
	BucketGetBucketVersioningHandler bucket.GetBucketVersioningHandler
	// ObjectGetObjectMetadataHandler sets the operation handler for the get object metadata operation
	ObjectGetObjectMetadataHandler object.GetObjectMetadataHandler
	// PolicyGetSAUserPolicyHandler sets the operation handler for the get s a user policy operation
	PolicyGetSAUserPolicyHandler policy.GetSAUserPolicyHandler
	// ServiceAccountGetServiceAccountPolicyHandler sets the operation handler for the get service account policy operation
	ServiceAccountGetServiceAccountPolicyHandler service_account.GetServiceAccountPolicyHandler
	// SiteReplicationGetSiteReplicationInfoHandler sets the operation handler for the get site replication info operation
	SiteReplicationGetSiteReplicationInfoHandler site_replication.GetSiteReplicationInfoHandler
	// SiteReplicationGetSiteReplicationStatusHandler sets the operation handler for the get site replication status operation
	SiteReplicationGetSiteReplicationStatusHandler site_replication.GetSiteReplicationStatusHandler
	// TieringGetTierHandler sets the operation handler for the get tier operation
	TieringGetTierHandler tiering.GetTierHandler
	// UserGetUserInfoHandler sets the operation handler for the get user info operation
	UserGetUserInfoHandler user.GetUserInfoHandler
	// PolicyGetUserPolicyHandler sets the operation handler for the get user policy operation
	PolicyGetUserPolicyHandler policy.GetUserPolicyHandler
	// GroupGroupInfoHandler sets the operation handler for the group info operation
	GroupGroupInfoHandler group.GroupInfoHandler
	// InspectInspectHandler sets the operation handler for the inspect operation
	InspectInspectHandler inspect.InspectHandler
	// UserListAUserServiceAccountsHandler sets the operation handler for the list a user service accounts operation
	UserListAUserServiceAccountsHandler user.ListAUserServiceAccountsHandler
	// BucketListAccessRulesWithBucketHandler sets the operation handler for the list access rules with bucket operation
	BucketListAccessRulesWithBucketHandler bucket.ListAccessRulesWithBucketHandler
	// BucketListBucketEventsHandler sets the operation handler for the list bucket events operation
	BucketListBucketEventsHandler bucket.ListBucketEventsHandler
	// BucketListBucketsHandler sets the operation handler for the list buckets operation
	BucketListBucketsHandler bucket.ListBucketsHandler
	// ConfigurationListConfigHandler sets the operation handler for the list config operation
	ConfigurationListConfigHandler configuration.ListConfigHandler
	// BucketListExternalBucketsHandler sets the operation handler for the list external buckets operation
	BucketListExternalBucketsHandler bucket.ListExternalBucketsHandler
	// GroupListGroupsHandler sets the operation handler for the list groups operation
	GroupListGroupsHandler group.ListGroupsHandler
	// PolicyListGroupsForPolicyHandler sets the operation handler for the list groups for policy operation
	PolicyListGroupsForPolicyHandler policy.ListGroupsForPolicyHandler
	// SystemListNodesHandler sets the operation handler for the list nodes operation
	SystemListNodesHandler system.ListNodesHandler
	// ObjectListObjectsHandler sets the operation handler for the list objects operation
	ObjectListObjectsHandler object.ListObjectsHandler
	// PolicyListPoliciesHandler sets the operation handler for the list policies operation
	PolicyListPoliciesHandler policy.ListPoliciesHandler
	// BucketListPoliciesWithBucketHandler sets the operation handler for the list policies with bucket operation
	BucketListPoliciesWithBucketHandler bucket.ListPoliciesWithBucketHandler
	// BucketListRemoteBucketsHandler sets the operation handler for the list remote buckets operation
	BucketListRemoteBucketsHandler bucket.ListRemoteBucketsHandler
	// ServiceAccountListUserServiceAccountsHandler sets the operation handler for the list user service accounts operation
	ServiceAccountListUserServiceAccountsHandler service_account.ListUserServiceAccountsHandler
	// UserListUsersHandler sets the operation handler for the list users operation
	UserListUsersHandler user.ListUsersHandler
	// PolicyListUsersForPolicyHandler sets the operation handler for the list users for policy operation
	PolicyListUsersForPolicyHandler policy.ListUsersForPolicyHandler
	// BucketListUsersWithAccessToBucketHandler sets the operation handler for the list users with access to bucket operation
	BucketListUsersWithAccessToBucketHandler bucket.ListUsersWithAccessToBucketHandler
	// LoggingLogSearchHandler sets the operation handler for the log search operation
	LoggingLogSearchHandler logging.LogSearchHandler
	// AuthLoginHandler sets the operation handler for the login operation
	AuthLoginHandler auth.LoginHandler
	// AuthLoginDetailHandler sets the operation handler for the login detail operation
	AuthLoginDetailHandler auth.LoginDetailHandler
	// AuthLoginOauth2AuthHandler sets the operation handler for the login oauth2 auth operation
	AuthLoginOauth2AuthHandler auth.LoginOauth2AuthHandler
	// AuthLogoutHandler sets the operation handler for the logout operation
	AuthLogoutHandler auth.LogoutHandler
	// BucketMakeBucketHandler sets the operation handler for the make bucket operation
	BucketMakeBucketHandler bucket.MakeBucketHandler
	// ConfigurationNotificationEndpointListHandler sets the operation handler for the notification endpoint list operation
	ConfigurationNotificationEndpointListHandler configuration.NotificationEndpointListHandler
	// PolicyPolicyInfoHandler sets the operation handler for the policy info operation
	PolicyPolicyInfoHandler policy.PolicyInfoHandler
	// ObjectPostBucketsBucketNameObjectsUploadHandler sets the operation handler for the post buckets bucket name objects upload operation
	ObjectPostBucketsBucketNameObjectsUploadHandler object.PostBucketsBucketNameObjectsUploadHandler
	// ProfileProfilingStartHandler sets the operation handler for the profiling start operation
	ProfileProfilingStartHandler profile.ProfilingStartHandler
	// ProfileProfilingStopHandler sets the operation handler for the profiling stop operation
	ProfileProfilingStopHandler profile.ProfilingStopHandler
	// BucketPutBucketTagsHandler sets the operation handler for the put bucket tags operation
	BucketPutBucketTagsHandler bucket.PutBucketTagsHandler
	// ObjectPutObjectLegalHoldHandler sets the operation handler for the put object legal hold operation
	ObjectPutObjectLegalHoldHandler object.PutObjectLegalHoldHandler
	// ObjectPutObjectRestoreHandler sets the operation handler for the put object restore operation
	ObjectPutObjectRestoreHandler object.PutObjectRestoreHandler
	// ObjectPutObjectRetentionHandler sets the operation handler for the put object retention operation
	ObjectPutObjectRetentionHandler object.PutObjectRetentionHandler
	// ObjectPutObjectTagsHandler sets the operation handler for the put object tags operation
	ObjectPutObjectTagsHandler object.PutObjectTagsHandler
	// BucketRemoteBucketDetailsHandler sets the operation handler for the remote bucket details operation
	BucketRemoteBucketDetailsHandler bucket.RemoteBucketDetailsHandler
	// GroupRemoveGroupHandler sets the operation handler for the remove group operation
	GroupRemoveGroupHandler group.RemoveGroupHandler
	// PolicyRemovePolicyHandler sets the operation handler for the remove policy operation
	PolicyRemovePolicyHandler policy.RemovePolicyHandler
	// UserRemoveUserHandler sets the operation handler for the remove user operation
	UserRemoveUserHandler user.RemoveUserHandler
	// ConfigurationResetConfigHandler sets the operation handler for the reset config operation
	ConfigurationResetConfigHandler configuration.ResetConfigHandler
	// ServiceRestartServiceHandler sets the operation handler for the restart service operation
	ServiceRestartServiceHandler service.RestartServiceHandler
	// AuthSessionCheckHandler sets the operation handler for the session check operation
	AuthSessionCheckHandler auth.SessionCheckHandler
	// BucketSetAccessRuleWithBucketHandler sets the operation handler for the set access rule with bucket operation
	BucketSetAccessRuleWithBucketHandler bucket.SetAccessRuleWithBucketHandler
	// BucketSetBucketQuotaHandler sets the operation handler for the set bucket quota operation
	BucketSetBucketQuotaHandler bucket.SetBucketQuotaHandler
	// BucketSetBucketRetentionConfigHandler sets the operation handler for the set bucket retention config operation
	BucketSetBucketRetentionConfigHandler bucket.SetBucketRetentionConfigHandler
	// BucketSetBucketVersioningHandler sets the operation handler for the set bucket versioning operation
	BucketSetBucketVersioningHandler bucket.SetBucketVersioningHandler
	// ConfigurationSetConfigHandler sets the operation handler for the set config operation
	ConfigurationSetConfigHandler configuration.SetConfigHandler
	// BucketSetMultiBucketReplicationHandler sets the operation handler for the set multi bucket replication operation
	BucketSetMultiBucketReplicationHandler bucket.SetMultiBucketReplicationHandler
	// PolicySetPolicyHandler sets the operation handler for the set policy operation
	PolicySetPolicyHandler policy.SetPolicyHandler
	// PolicySetPolicyMultipleHandler sets the operation handler for the set policy multiple operation
	PolicySetPolicyMultipleHandler policy.SetPolicyMultipleHandler
	// ServiceAccountSetServiceAccountPolicyHandler sets the operation handler for the set service account policy operation
	ServiceAccountSetServiceAccountPolicyHandler service_account.SetServiceAccountPolicyHandler
	// ObjectShareObjectHandler sets the operation handler for the share object operation
	ObjectShareObjectHandler object.ShareObjectHandler
	// SiteReplicationSiteReplicationEditHandler sets the operation handler for the site replication edit operation
	SiteReplicationSiteReplicationEditHandler site_replication.SiteReplicationEditHandler
	// SiteReplicationSiteReplicationInfoAddHandler sets the operation handler for the site replication info add operation
	SiteReplicationSiteReplicationInfoAddHandler site_replication.SiteReplicationInfoAddHandler
	// SiteReplicationSiteReplicationRemoveHandler sets the operation handler for the site replication remove operation
	SiteReplicationSiteReplicationRemoveHandler site_replication.SiteReplicationRemoveHandler
	// SubnetSubnetInfoHandler sets the operation handler for the subnet info operation
	SubnetSubnetInfoHandler subnet.SubnetInfoHandler
	// SubnetSubnetLoginHandler sets the operation handler for the subnet login operation
	SubnetSubnetLoginHandler subnet.SubnetLoginHandler
	// SubnetSubnetLoginMFAHandler sets the operation handler for the subnet login m f a operation
	SubnetSubnetLoginMFAHandler subnet.SubnetLoginMFAHandler
	// SubnetSubnetRegTokenHandler sets the operation handler for the subnet reg token operation
	SubnetSubnetRegTokenHandler subnet.SubnetRegTokenHandler
	// SubnetSubnetRegisterHandler sets the operation handler for the subnet register operation
	SubnetSubnetRegisterHandler subnet.SubnetRegisterHandler
	// TieringTiersListHandler sets the operation handler for the tiers list operation
	TieringTiersListHandler tiering.TiersListHandler
	// BucketUpdateBucketLifecycleHandler sets the operation handler for the update bucket lifecycle operation
	BucketUpdateBucketLifecycleHandler bucket.UpdateBucketLifecycleHandler
	// GroupUpdateGroupHandler sets the operation handler for the update group operation
	GroupUpdateGroupHandler group.UpdateGroupHandler
	// BucketUpdateMultiBucketReplicationHandler sets the operation handler for the update multi bucket replication operation
	BucketUpdateMultiBucketReplicationHandler bucket.UpdateMultiBucketReplicationHandler
	// UserUpdateUserGroupsHandler sets the operation handler for the update user groups operation
	UserUpdateUserGroupsHandler user.UpdateUserGroupsHandler
	// UserUpdateUserInfoHandler sets the operation handler for the update user info operation
	UserUpdateUserInfoHandler user.UpdateUserInfoHandler

	// 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
}

ConsoleAPI the console API

func NewConsoleAPI 

func NewConsoleAPI(spec *loads.Document, openIDProviders oauth2.OpenIDPCfg) *ConsoleAPI

NewConsoleAPI creates a new Console instance

func (*ConsoleAPI) AddMiddlewareFor 

func (o *ConsoleAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)

AddMiddlewareFor adds a http middleware to existing handler

func (*ConsoleAPI) AuthenticatorsFor 

func (o *ConsoleAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*ConsoleAPI) Authorizer 

func (o *ConsoleAPI) Authorizer() runtime.Authorizer

Authorizer returns the registered authorizer

func (*ConsoleAPI) ConsumersFor 

func (o *ConsoleAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer

ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.

func (*ConsoleAPI) Context 

func (o *ConsoleAPI) Context() *middleware.Context

Context returns the middleware context for the console API

func (*ConsoleAPI) DefaultConsumes 

func (o *ConsoleAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*ConsoleAPI) DefaultProduces 

func (o *ConsoleAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*ConsoleAPI) Formats 

func (o *ConsoleAPI) Formats() strfmt.Registry

Formats returns the registered string formats

func (*ConsoleAPI) HandlerFor 

func (o *ConsoleAPI) HandlerFor(method, path string) (http.Handler, bool)

HandlerFor gets a http.Handler for the provided operation method and path

func (*ConsoleAPI) Init 

func (o *ConsoleAPI) Init()

Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit

func (*ConsoleAPI) ProducersFor 

func (o *ConsoleAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer

ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.

func (*ConsoleAPI) RegisterConsumer 

func (o *ConsoleAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)

RegisterConsumer allows you to add (or override) a consumer for a media type.

func (*ConsoleAPI) RegisterFormat 

func (o *ConsoleAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)

RegisterFormat registers a custom format validator

func (*ConsoleAPI) RegisterProducer 

func (o *ConsoleAPI) RegisterProducer(mediaType string, producer runtime.Producer)

RegisterProducer allows you to add (or override) a producer for a media type.

func (*ConsoleAPI) Serve 

func (o *ConsoleAPI) 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 (*ConsoleAPI) ServeErrorFor 

func (o *ConsoleAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)

ServeErrorFor gets a error handler for a given operation id

func (*ConsoleAPI) SetDefaultConsumes 

func (o *ConsoleAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*ConsoleAPI) SetDefaultProduces 

func (o *ConsoleAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*ConsoleAPI) SetSpec 

func (o *ConsoleAPI) SetSpec(spec *loads.Document)

SetSpec sets a spec that will be served for the clients.

func (*ConsoleAPI) UseRedoc 

func (o *ConsoleAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*ConsoleAPI) UseSwaggerUI 

func (o *ConsoleAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*ConsoleAPI) Validate 

func (o *ConsoleAPI) Validate() error

Validate validates the registrations in the ConsoleAPI

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.