resources

Documentation

Index

• type CreateNote
• type CreateNoteAttributes
• type CreateNoteListRequest
• type CreateNoteRequest
• type Details
  • func (d Details) MarshalJSON() ([]byte, error)
  • func (r *Details) Scan(src interface{}) error
  • func (d Details) String() string
  • func (d *Details) UnmarshalJSON(data []byte) error
  • func (r Details) Value() (driver.Value, error)
• type Flag
• type Flagger
• type Flags
  • func FlagsFromMask(mask int32, allFlags map[int32]string) Flags
• type IdResponse
  • func NewIdResponse(key Key) IdResponse
• type Included
  • func (c *Included) Add(includes ...Resource)
  • func (c Included) MarshalJSON() ([]byte, error)
  • func (c *Included) MustCreateNote(key Key) *CreateNote
  • func (c *Included) MustNote(key Key) *Note
  • func (c *Included) MustUpdateNote(key Key) *UpdateNote
  • func (c *Included) UnmarshalJSON(data []byte) error
• type Key
  • func NewKeyInt64(id int64, resourceType ResourceType) Key
  • func (r Key) AsRelation() *Relation
  • func (r *Key) GetKey() Key
  • func (r Key) GetKeyP() *Key
• type Links
• type Note
• type NoteAttributes
• type NoteListResponse
• type NoteResponse
• type Relation
• type RelationCollection
  • func (r RelationCollection) MarshalJSON() ([]byte, error)
• type Resource
• type ResourceType
• type UpdateNote
• type UpdateNoteAttributes
• type UpdateNoteListResponse
• type UpdateNoteResponse

Types

type CreateNote

type CreateNote struct {
	Key
	Attributes CreateNoteAttributes `json:"attributes"`
}

type CreateNoteAttributes

type CreateNoteAttributes struct {
	// Content to share
	Content string `json:"content"`
	// A time when the note was created
	CreatedAt time.Time `json:"created_at"`
}

type CreateNoteListRequest

type CreateNoteListRequest struct {
	Data     []CreateNote `json:"data"`
	Included Included     `json:"included"`
	Links    *Links       `json:"links"`
}

type CreateNoteRequest

type CreateNoteRequest struct {
	Data     CreateNote `json:"data"`
	Included Included   `json:"included"`
}

type Details

type Details json.RawMessage

func (Details) MarshalJSON

func (d Details) MarshalJSON() ([]byte, error)

MarshalJSON - casts Details to []byte

func (*Details) Scan

func (r *Details) Scan(src interface{}) error

Scan - implements db driver method for auto unmarshal

func (Details) String

func (d Details) String() string

func (*Details) UnmarshalJSON

func (d *Details) UnmarshalJSON(data []byte) error

UnmarshalJSON - casts data to Details

func (Details) Value

func (r Details) Value() (driver.Value, error)

Value - implements db driver method for auto marshal

type Flag

type Flag struct {
	Name  string `json:"name"`
	Value int32  `json:"value"`
}

type Flagger

type Flagger interface {
	IsFlag() bool
}

type Flags

type Flags struct {
	Mask   int32  `json:"mask"`
	Values []Flag `json:"flags"`
}

func FlagsFromMask

func FlagsFromMask(mask int32, allFlags map[int32]string) Flags

type IdResponse

type IdResponse struct {
	Data Key `json:"data"`
}

func NewIdResponse

func NewIdResponse(key Key) IdResponse

type Included

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

Included - an array of Resource objects that are related to the primary data and/or each other (“included resources”).

func (*Included) Add

func (c *Included) Add(includes ...Resource)

Add - adds new include into collection. If one already present - skips it

func (Included) MarshalJSON

func (c Included) MarshalJSON() ([]byte, error)

MarshalJSON - marshals include collection as array of json objects

func (*Included) MustCreateNote

func (c *Included) MustCreateNote(key Key) *CreateNote

MustCreateNote - returns CreateNote from include collection. if entry with specified key does not exist - returns nil if entry with specified key exists but type or ID mismatches - panics

func (*Included) MustNote

func (c *Included) MustNote(key Key) *Note

MustNote - returns Log from include collection. if entry with specified key does not exist - returns nil if entry with specified key exists but type or ID mismatches - panics

func (*Included) MustUpdateNote

func (c *Included) MustUpdateNote(key Key) *UpdateNote

MustUpdateNote - returns UpdateNote from include collection. if entry with specified key does not exist - returns nil if entry with specified key exists but type or ID mismatches - panics

func (*Included) UnmarshalJSON

func (c *Included) UnmarshalJSON(data []byte) error

UnmarshalJSON - unmarshal array of json objects into include collection

type Key

type Key struct {
	ID   string       `json:"id"`
	Type ResourceType `json:"type"`
}

func NewKeyInt64

func NewKeyInt64(id int64, resourceType ResourceType) Key

func (Key) AsRelation

func (r Key) AsRelation() *Relation

func (*Key) GetKey

func (r *Key) GetKey() Key

func (Key) GetKeyP

func (r Key) GetKeyP() *Key

type Links

type Links struct {
	First string `json:"first,omitempty"`
	Last  string `json:"last,omitempty"`
	Next  string `json:"next,omitempty"`
	Prev  string `json:"prev,omitempty"`
	Self  string `json:"self,omitempty"`
}

type Note

type Note struct {
	Key
	Attributes NoteAttributes `json:"attributes"`
}

type NoteAttributes

type NoteAttributes struct {
	// Content to share
	Content string `json:"content"`
	// A time when the note was created
	CreatedAt time.Time `json:"created_at"`
}

type NoteListResponse

type NoteListResponse struct {
	Data     []Note   `json:"data"`
	Included Included `json:"included"`
	Links    *Links   `json:"links"`
}

type NoteResponse

type NoteResponse struct {
	Data     Note     `json:"data"`
	Included Included `json:"included"`
}

type Relation

type Relation struct {
	Data  *Key   `json:"data,omitempty"`
	Links *Links `json:"links,omitempty"`
}

type RelationCollection

type RelationCollection struct {
	Data  []Key  `json:"data"`
	Links *Links `json:"links,omitempty"`
}

func (RelationCollection) MarshalJSON

func (r RelationCollection) MarshalJSON() ([]byte, error)

type Resource

type Resource interface {
	//GetKey - returns key of the Resource
	GetKey() Key
}

type ResourceType

type ResourceType string

const (
	NOTES ResourceType = "notes"
)

List of ResourceType

type UpdateNote

type UpdateNote struct {
	Key
	Attributes UpdateNoteAttributes `json:"attributes"`
}

type UpdateNoteAttributes

type UpdateNoteAttributes struct {
	// Content to share
	Content string `json:"content"`
	// Timestamp that shows when user was created.
	CreatedAt time.Time `json:"created_at"`
}

type UpdateNoteListResponse

type UpdateNoteListResponse struct {
	Data     []UpdateNote `json:"data"`
	Included Included     `json:"included"`
	Links    *Links       `json:"links"`
}

type UpdateNoteResponse

type UpdateNoteResponse struct {
	Data     UpdateNote `json:"data"`
	Included Included   `json:"included"`
}