note

Documentation

Index

• func Add(params AddParams) error
• func Get(params GetParams) (*models.Note, error)
• func List(params Params) (*models.Notes, error)
• func Update(params UpdateParams) (*models.Note, error)
• type AddParams
  • func (params AddParams) Validate() error
• type GetParams
  • func (params GetParams) Validate() error
• type ListParams
• type Params
• type UpdateParams
  • func (params UpdateParams) Validate() error

Functions

func Add

func Add(params AddParams) error

Add posts a new message to the specified deployment

func Get

func Get(params GetParams) (*models.Note, error)

Get obtains a note from a deployment and note ID

func List

func List(params Params) (*models.Notes, error)

List lists all of the notes for the deployment

func Update

func Update(params UpdateParams) (*models.Note, error)

Update updates a note from its deployment and note ID

Types

type AddParams

type AddParams struct {
	Params
	Message     string
	UserID      string
	Commentator ecctl.Commentator
}

AddParams is consumed by Add.

func (AddParams) Validate

func (params AddParams) Validate() error

Validate ensures the parameters are valid

type GetParams

type GetParams struct {
	Params
	NoteID string
}

GetParams is used on List

func (GetParams) Validate

func (params GetParams) Validate() error

Validate confirms the parmeters are valid

type ListParams

type ListParams struct {
	Params
}

ListParams is used by List

type Params

type Params struct {
	deployment.Params
}

Params is used on Get and Update Notes

type UpdateParams

type UpdateParams struct {
	Params
	NoteID  string
	UserID  string
	Message string
}

UpdateParams is used on Update

func (UpdateParams) Validate

func (params UpdateParams) Validate() error

Validate confirms the parmeters are valid