api

Documentation

Overview

Package api contains logic for building the Service Manager API business logic

Index

• Constants
• func New(ctx context.Context, options *Options) (*web.API, error)
• type BaseController
  • func NewController(repository storage.Repository, resourceBaseURL string, ...) *BaseController
  • func (c *BaseController) CreateObject(r *web.Request) (*web.Response, error)
  • func (c *BaseController) DeleteObjects(r *web.Request) (*web.Response, error)
  • func (c *BaseController) DeleteSingleObject(r *web.Request) (*web.Response, error)
  • func (c *BaseController) GetSingleObject(r *web.Request) (*web.Response, error)
  • func (c *BaseController) ListObjects(r *web.Request) (*web.Response, error)
  • func (c *BaseController) PatchObject(r *web.Request) (*web.Response, error)
  • func (c *BaseController) Routes() []web.Route
• type HTTPHandler
  • func NewHTTPHandler(handler web.Handler, requestBodyMaxSize int) *HTTPHandler
  • func (h *HTTPHandler) Handle(req *web.Request) (resp *web.Response, err error)
  • func (h *HTTPHandler) ServeHTTP(res http.ResponseWriter, req *http.Request)
• type Options
• type ServiceOfferingController
  • func NewServiceOfferingController(repository storage.Repository, defaultPageSize, maxPageSize int) *ServiceOfferingController
  • func (c *ServiceOfferingController) Routes() []web.Route
• type ServicePlanController
  • func NewServicePlanController(repository storage.Repository, defaultPageSize, maxPageSize int) *ServicePlanController
  • func (c *ServicePlanController) Routes() []web.Route
• type Settings
  • func DefaultSettings() *Settings
  • func (s *Settings) Validate() error

Constants

const PathParamID = "id"

Functions

func New

func New(ctx context.Context, options *Options) (*web.API, error)

New returns the minimum set of REST APIs needed for the Service Manager

Types

type BaseController

type BaseController struct {
	DefaultPageSize int
	MaxPageSize     int
	// contains filtered or unexported fields
}

BaseController provides common CRUD handlers for all object types in the service manager

func NewController

func NewController(repository storage.Repository, resourceBaseURL string, objectType types.ObjectType, objectBlueprint func() types.Object, defaultPageSize, maxPageSize int) *BaseController

NewController returns a new base controller

func (*BaseController) CreateObject

func (c *BaseController) CreateObject(r *web.Request) (*web.Response, error)

CreateObject handles the creation of a new object

func (*BaseController) DeleteObjects

func (c *BaseController) DeleteObjects(r *web.Request) (*web.Response, error)

DeleteObjects handles the deletion of the objects specified in the request

func (*BaseController) DeleteSingleObject

func (c *BaseController) DeleteSingleObject(r *web.Request) (*web.Response, error)

DeleteSingleObject handles the deletion of the object with the id specified in the request

func (*BaseController) GetSingleObject

func (c *BaseController) GetSingleObject(r *web.Request) (*web.Response, error)

GetSingleObject handles the fetching of a single object with the id specified in the request

func (*BaseController) ListObjects

func (c *BaseController) ListObjects(r *web.Request) (*web.Response, error)

ListObjects handles the fetching of all objects

func (*BaseController) PatchObject

func (c *BaseController) PatchObject(r *web.Request) (*web.Response, error)

PatchObject handles the update of the object with the id specified in the request

func (*BaseController) Routes

func (c *BaseController) Routes() []web.Route

Routes returns the common set of routes for all objects

type HTTPHandler

type HTTPHandler struct {
	Handler web.Handler
	// contains filtered or unexported fields
}

HTTPHandler converts a pkg/web.Handler and pkg/web.HandlerFunc to a standard http.Handler

func NewHTTPHandler

func NewHTTPHandler(handler web.Handler, requestBodyMaxSize int) *HTTPHandler

NewHTTPHandler creates a new HTTPHandler from the provided web.Handler

func (*HTTPHandler) Handle

func (h *HTTPHandler) Handle(req *web.Request) (resp *web.Response, err error)

Handle implements the web.Handler interface

func (*HTTPHandler) ServeHTTP

func (h *HTTPHandler) ServeHTTP(res http.ResponseWriter, req *http.Request)

ServeHTTP implements the http.Handler interface and allows wrapping web.Handlers into http.Handlers

type Options

type Options struct {
	Repository  storage.TransactionalRepository
	APISettings *Settings
	WSSettings  *ws.Settings
	Notificator storage.Notificator
}

type ServiceOfferingController

type ServiceOfferingController struct {
	*BaseController
}

ServiceOfferingController implements api.Controller by providing service offerings API logic

func NewServiceOfferingController

func NewServiceOfferingController(repository storage.Repository, defaultPageSize, maxPageSize int) *ServiceOfferingController

func (*ServiceOfferingController) Routes

func (c *ServiceOfferingController) Routes() []web.Route

type ServicePlanController

type ServicePlanController struct {
	*BaseController
}

ServicePlanController implements api.Controller by providing service plans API logic

func NewServicePlanController

func NewServicePlanController(repository storage.Repository, defaultPageSize, maxPageSize int) *ServicePlanController

func (*ServicePlanController) Routes

func (c *ServicePlanController) Routes() []web.Route

type Settings

type Settings struct {
	TokenIssuerURL  string   `mapstructure:"token_issuer_url" description:"url of the token issuer which to use for validating tokens"`
	ClientID        string   `mapstructure:"client_id" description:"id of the client from which the token must be issued"`
	TokenBasicAuth  bool     `` /* 178-byte string literal not displayed */
	ProctedLabels   []string `mapstructure:"protected_labels" description:"defines labels which cannot be modified/added by REST API requests"`
	OSBVersion      string   `mapstructure:"-"`
	MaxPageSize     int      `mapstructure:"max_page_size" description:"maximum number of items that could be returned in a single page"`
	DefaultPageSize int      `mapstructure:"default_page_size" description:"default number of items returned in a single page if not specified in request"`
}

Settings type to be loaded from the environment

func DefaultSettings

func DefaultSettings() *Settings

DefaultSettings returns default values for API settings

func (*Settings) Validate

func (s *Settings) Validate() error

Validate validates the API settings