jsonapi

Jun 6, 2023

Changes in this version

+ var ErrErrorUnmarshalingNotImplemented = errors.New("error unmarshaling is not implemented")

May 16, 2023

Changes in this version

+ var ErrDocumentMissingRequiredMembers = errors.New(...)

+ var ErrRelationshipMissingRequiredMembers = errors.New(...)

type MarshalOption

+ func MarshalSetNameValidation(mode MemberNameValidationMode) MarshalOption

+ type MemberNameValidationMode int

+ const DefaultValidation

+ const DisableValidation

+ const StrictValidation

type UnmarshalOption

+ func UnmarshalSetNameValidation(mode MemberNameValidationMode) UnmarshalOption

May 4, 2023

Changes in this version

+ var ErrEmptyDataObject = errors.New("resource \"data\" members may not be represented by an empty object {}")

+ var ErrMissingDataField = errors.New("document is missing a required top-level or relationship-level data member")

type Error

+ func (e *Error) UnmarshalJSON(data []byte) error

Apr 18, 2023

Changes in this version

type MarshalOption

+ func MarshalDisableNameValidation() MarshalOption

+ func MarshalStrictNameValidation() MarshalOption

+ type MemberNameValidationError struct

+ MemberName string

+ func (e *MemberNameValidationError) Error() string

type UnmarshalOption

+ func UnmarshalDisableNameValidation() UnmarshalOption

+ func UnmarshalStrictNameValidation() UnmarshalOption

Jan 27, 2023

Changes in this version

+ func Status(s int) *int

type Error

+ func (e *Error) MarshalJSON() ([]byte, error)

Jan 6, 2023

Changes in this version

type Error

+ func (e *Error) Error() string

Nov 29, 2022

Changes in this version

+ var ErrUnmarshalDuplicatePrimaryField = errors.New("there must be only one `jsonapi:\"primary\"` field to Unmarshal")

type MarshalOption

+ func MarshalClientMode() MarshalOption

Aug 31, 2022

Changes in this version

+ var ErrEmptyPrimaryField = errors.New("the `jsonapi:\"primary\"` field value must not be empty")

+ var ErrMarshalInvalidPrimaryField = errors.New(...)

+ var ErrMissingLinkFields = errors.New(...)

+ var ErrMissingPrimaryField = errors.New("primary/id field must labeled with `jsonapi:\"primary,{type}\"`")

+ var ErrUnmarshalInvalidPrimaryField = errors.New(...)

+ func Marshal(v any, opts ...MarshalOption) (b []byte, err error)

+ func Unmarshal(data []byte, v any, opts ...UnmarshalOption) (err error)

+ type Error struct

+ Code string

+ Detail string

+ ID string

+ Links *ErrorLink

+ Meta any

+ Source *ErrorSource

+ Status string

+ Title string

+ type ErrorLink struct

+ About string

+ type ErrorSource struct

+ Parameter string

+ Pointer string

+ type Link struct

+ First string

+ Last string

+ Next string

+ Previous string

+ Related any

+ Self any

+ type LinkObject struct

+ Href string

+ Meta any

+ type Linkable interface

+ Link func() *Link

+ type LinkableRelation interface

+ LinkRelation func(relation string) *Link

+ type MarshalIdentifier interface

+ MarshalID func() string

+ type MarshalOption func(m *Marshaler)

+ func MarshalFields(query url.Values) MarshalOption

+ func MarshalInclude(v ...any) MarshalOption

+ func MarshalJSONAPI(meta any) MarshalOption

+ func MarshalLinks(l *Link) MarshalOption

+ func MarshalMeta(meta any) MarshalOption

+ type Marshaler struct

+ type PartialLinkageError struct

+ func (e *PartialLinkageError) Error() string

+ type RequestBodyError struct

+ func (e *RequestBodyError) Error() string

+ type TagError struct

+ Field string

+ Reason string

+ TagName string

+ func (e *TagError) Error() string

+ type TypeError struct

+ Actual string

+ Expected []string

+ func (e *TypeError) Error() string

+ type UnmarshalIdentifier interface

+ UnmarshalID func(id string) error

+ type UnmarshalOption func(m *Unmarshaler)

+ func UnmarshalMeta(meta any) UnmarshalOption

+ type Unmarshaler struct