jsonapi

type EditToManyRelations ¶

type EditToManyRelations interface {
	AddToManyIDs(name string, IDs []string) error
	DeleteToManyIDs(name string, IDs []string) error
}

The EditToManyRelations interface can be optionally implemented to add and delete to-many relationships on a already unmarshalled struct. These methods are used by our API for the to-many relationship update routes.

There are 3 HTTP Methods to edit to-many relations:

PATCH /v1/posts/1/comments
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": [
	{ "type": "comments", "id": "2" },
	{ "type": "comments", "id": "3" }
  ]
}

this replaces all of the comments that belong to post with ID 1 and the SetToManyReferenceIDs method will be called

POST /v1/posts/1/comments
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": [
	{ "type": "comments", "id": "123" }
  ]
}

adds a new comment to the post with ID 1. The AddToManyIDs methid will be called.

DELETE /v1/posts/1/comments
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": [
	{ "type": "comments", "id": "12" },
	{ "type": "comments", "id": "13" }
  ]
}

deletes comments that belong to post with ID 1. The DeleteToManyIDs method will be called.

type EntityNamer ¶

type EntityNamer interface {
	GetName() string
}

The EntityNamer interface can be opionally implemented to rename a struct. The name returned by GetName will be used for the route generation as well as the "type" field in all responses

type MarshalIdentifier ¶

type MarshalIdentifier interface {
	GetID() string
}

MarshalIdentifier interface is necessary to give an element a unique ID. This interface must be implemented for marshal and unmarshal in order to let them store elements

type MarshalIncludedRelations ¶

type MarshalIncludedRelations interface {
	MarshalReferences
	MarshalIdentifier
	GetReferencedStructs() []MarshalIdentifier
}

MarshalIncludedRelations must be implemented if referenced structs should be included

type MarshalLinkedRelations ¶

type MarshalLinkedRelations interface {
	MarshalReferences
	MarshalIdentifier
	GetReferencedIDs() []ReferenceID
}

MarshalLinkedRelations must be implemented if there are references and the reference IDs should be included

type MarshalReferences ¶

type MarshalReferences interface {
	GetReferences() []Reference
}

MarshalReferences must be implemented if the struct to be serialized has relations. This must be done because jsonapi needs information about relations even if many to many relations or many to one relations are empty

type Reference ¶

type Reference struct {
	Type        string
	Name        string
	IsNotLoaded bool
}

Reference information about possible references of a struct If IsNotLoaded is set to true, the `data` field will be omitted and only the `links` object will be generated. You should do this if there are some references, but you do not want to load them. Otherwise, if IsNotLoaded is false and GetReferencedIDs() returns no IDs for this reference name, an empty `data` field will be added which means that there are no references.

type ReferenceID ¶

type ReferenceID struct {
	ID   string
	Type string
	Name string
}

ReferenceID contains all necessary information in order to reference another struct in jsonapi

type ServerInformation ¶

type ServerInformation interface {
	GetBaseURL() string
	GetPrefix() string
}

ServerInformation can be passed to MarshalWithURLs to generate the `self` and `related` urls inside `links`

type UnmarshalIdentifier ¶

type UnmarshalIdentifier interface {
	SetID(string) error
}

UnmarshalIdentifier interface to set ID when unmarshalling

type UnmarshalToManyRelations ¶

type UnmarshalToManyRelations interface {
	SetToManyReferenceIDs(name string, IDs []string) error
}

UnmarshalToManyRelations must be implemented to unmarshal to-many relations

type UnmarshalToOneRelations ¶

type UnmarshalToOneRelations interface {
	SetToOneReferenceID(name, ID string) error
}

UnmarshalToOneRelations must be implemented to unmarshal to-one relations