modules

Documentation

Index

• func InvalidPlaneTypeErrorResponse(planeType string, supportedPlaneTypes []string) rest.Response
• type Initializer

Functions

func InvalidPlaneTypeErrorResponse

func InvalidPlaneTypeErrorResponse(planeType string, supportedPlaneTypes []string) rest.Response

InvalidPlaneTypeErrorResponse returns a 400 response with error code CodeInvalidPlaneType.

Types

type Initializer

type Initializer interface {
	// Initialize initializes and returns the http.Handler that will be registered with the router to handle requests for the plane.
	Initialize(ctx context.Context) (http.Handler, error)

	// PlaneType returns the type of plane that the module is providing functionality for. This should match
	// the plane type in the URL path for the plane.
	//
	// Examples:
	//
	// - aws
	// - azure
	// - kubernetes
	// - radius
	PlaneType() string
}

Initializer is an interface that can be implemented by modules that want to provide functionality for a plane.