apidefinition

Documentation

Index

• type APIDefinition
• type APIDefinitionSet
• type APIDefinitionSetGetter

Types

type APIDefinition

type APIDefinition interface {
	// GetAPIResourceSchema returns the API schema this definition serves.
	GetAPIResourceSchema() *apisv1alpha1.APIResourceSchema

	// GetClusterName provides the name of the logical cluster where the resource specification comes from.
	GetClusterName() logicalcluster.Name

	// GetStorage provides the REST storage used to serve the resource.
	GetStorage() rest.Storage

	// GetSubResourceStorage provides the REST storage required to serve the given sub-resource.
	GetSubResourceStorage(subresource string) rest.Storage

	// GetRequestScope provides the handlers.RequestScope required to serve the resource.
	GetRequestScope() *handlers.RequestScope

	// GetSubResourceRequestScope provides the handlers.RequestScope required to serve the given sub-resource.
	GetSubResourceRequestScope(subresource string) *handlers.RequestScope

	// TearDown shuts down long-running connections.
	TearDown()
}

APIDefinition provides access to all the information needed to serve a given API resource

type APIDefinitionSet

type APIDefinitionSet map[schema.GroupVersionResource]APIDefinition

APIDefinitionSet contains the APIDefintion objects for the APIs of an API domain.

type APIDefinitionSetGetter

type APIDefinitionSetGetter interface {
	GetAPIDefinitionSet(ctx context.Context, key dynamiccontext.APIDomainKey) (apis APIDefinitionSet, apisExist bool, err error)
}

APIDefinitionSetGetter provides access to the API definitions of a API domain, based on the API domain key.