annotations

Documentation

Index

• type API
  • func NewAPI(st *state.State, resources facade.Resources, authorizer facade.Authorizer) (*API, error)
  • func (api *API) Get(args params.Entities) params.AnnotationsGetResults
  • func (api *API) Set(args params.AnnotationsSet) params.ErrorResults
• type Annotations

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API implements the service interface and is the concrete implementation of the api end point.

func NewAPI

func NewAPI(
	st *state.State,
	resources facade.Resources,
	authorizer facade.Authorizer,
) (*API, error)

NewAPI returns a new charm annotator API facade.

func (*API) Get

func (api *API) Get(args params.Entities) params.AnnotationsGetResults

Get returns annotations for given entities. If annotations cannot be retrieved for a given entity, an error is returned. Each entity is treated independently and, hence, will fail or succeed independently.

func (*API) Set

func (api *API) Set(args params.AnnotationsSet) params.ErrorResults

Set stores annotations for given entities

type Annotations

type Annotations interface {
	Get(args params.Entities) params.AnnotationsGetResults
	Set(args params.AnnotationsSet) params.ErrorResults
}

Annotations defines the methods on the service API end point.