Help us shape the future of Go! Take the 2026 Go Developer Survey

operations

package
v1.5.5 Latest Latest
Warning

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

Go to latest
Published: Oct 20, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type RekorServerAPI

type RekorServerAPI 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

	// ApplicationXPemFileProducer registers a producer for the following mime types:
	//   - application/x-pem-file
	ApplicationXPemFileProducer runtime.Producer
	// JSONProducer registers a producer for the following mime types:
	//   - application/json
	JSONProducer runtime.Producer

	// EntriesCreateLogEntryHandler sets the operation handler for the create log entry operation
	EntriesCreateLogEntryHandler entries.CreateLogEntryHandler
	// EntriesGetLogEntryByIndexHandler sets the operation handler for the get log entry by index operation
	EntriesGetLogEntryByIndexHandler entries.GetLogEntryByIndexHandler
	// EntriesGetLogEntryByUUIDHandler sets the operation handler for the get log entry by UUID operation
	EntriesGetLogEntryByUUIDHandler entries.GetLogEntryByUUIDHandler
	// TlogGetLogInfoHandler sets the operation handler for the get log info operation
	TlogGetLogInfoHandler tlog.GetLogInfoHandler
	// TlogGetLogProofHandler sets the operation handler for the get log proof operation
	TlogGetLogProofHandler tlog.GetLogProofHandler
	// PubkeyGetPublicKeyHandler sets the operation handler for the get public key operation
	PubkeyGetPublicKeyHandler pubkey.GetPublicKeyHandler
	// IndexSearchIndexHandler sets the operation handler for the search index operation
	IndexSearchIndexHandler index.SearchIndexHandler
	// EntriesSearchLogQueryHandler sets the operation handler for the search log query operation
	EntriesSearchLogQueryHandler entries.SearchLogQueryHandler

	// 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 []cmdutils.CommandLineOptionsGroup

	// User defined logger function.
	Logger func(string, ...any)
	// contains filtered or unexported fields
}

RekorServerAPI Rekor is a cryptographically secure, immutable transparency log for signed software releases.

func NewRekorServerAPI

func NewRekorServerAPI(spec *loads.Document) *RekorServerAPI

NewRekorServerAPI creates a new RekorServer instance

func (*RekorServerAPI) AddMiddlewareFor

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

AddMiddlewareFor adds a http middleware to existing handler

func (*RekorServerAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*RekorServerAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*RekorServerAPI) ConsumersFor

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

ConsumersFor gets the consumers for the specified media types.

MIME type parameters are ignored here.

func (*RekorServerAPI) Context

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

Context returns the middleware context for the rekor server API

func (*RekorServerAPI) DefaultConsumes

func (o *RekorServerAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*RekorServerAPI) DefaultProduces

func (o *RekorServerAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*RekorServerAPI) Formats

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

Formats returns the registered string formats

func (*RekorServerAPI) HandlerFor

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

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

func (*RekorServerAPI) Init

func (o *RekorServerAPI) Init()

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

func (*RekorServerAPI) ProducersFor

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

ProducersFor gets the producers for the specified media types.

MIME type parameters are ignored here.

func (*RekorServerAPI) RegisterConsumer

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

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

func (*RekorServerAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*RekorServerAPI) RegisterProducer

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

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

func (*RekorServerAPI) Serve

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

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

ServeErrorFor gets a error handler for a given operation id

func (*RekorServerAPI) SetDefaultConsumes

func (o *RekorServerAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*RekorServerAPI) SetDefaultProduces

func (o *RekorServerAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*RekorServerAPI) SetSpec

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

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

func (*RekorServerAPI) UseRedoc

func (o *RekorServerAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*RekorServerAPI) UseSwaggerUI

func (o *RekorServerAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*RekorServerAPI) Validate

func (o *RekorServerAPI) Validate() error

Validate validates the registrations in the RekorServerAPI

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL