summaryrefslogtreecommitdiff
path: root/vendor/github.com/google/jsonapi/node.go
diff options
context:
space:
mode:
authormo khan <mo@mokhan.ca>2025-05-11 21:12:57 -0600
committermo khan <mo@mokhan.ca>2025-05-11 21:12:57 -0600
commit60440f90dca28e99a31dd328c5f6d5dc0f9b6a2e (patch)
tree2f54adf55086516f162f0a55a5347e6b25f7f176 /vendor/github.com/google/jsonapi/node.go
parent05ca9b8d3a9c7203a3a3b590beaa400900bd9007 (diff)
chore: vendor go dependencies
Diffstat (limited to 'vendor/github.com/google/jsonapi/node.go')
-rw-r--r--vendor/github.com/google/jsonapi/node.go121
1 files changed, 121 insertions, 0 deletions
diff --git a/vendor/github.com/google/jsonapi/node.go b/vendor/github.com/google/jsonapi/node.go
new file mode 100644
index 0000000..a58488c
--- /dev/null
+++ b/vendor/github.com/google/jsonapi/node.go
@@ -0,0 +1,121 @@
+package jsonapi
+
+import "fmt"
+
+// Payloader is used to encapsulate the One and Many payload types
+type Payloader interface {
+ clearIncluded()
+}
+
+// OnePayload is used to represent a generic JSON API payload where a single
+// resource (Node) was included as an {} in the "data" key
+type OnePayload struct {
+ Data *Node `json:"data"`
+ Included []*Node `json:"included,omitempty"`
+ Links *Links `json:"links,omitempty"`
+ Meta *Meta `json:"meta,omitempty"`
+}
+
+func (p *OnePayload) clearIncluded() {
+ p.Included = []*Node{}
+}
+
+// ManyPayload is used to represent a generic JSON API payload where many
+// resources (Nodes) were included in an [] in the "data" key
+type ManyPayload struct {
+ Data []*Node `json:"data"`
+ Included []*Node `json:"included,omitempty"`
+ Links *Links `json:"links,omitempty"`
+ Meta *Meta `json:"meta,omitempty"`
+}
+
+func (p *ManyPayload) clearIncluded() {
+ p.Included = []*Node{}
+}
+
+// Node is used to represent a generic JSON API Resource
+type Node struct {
+ Type string `json:"type"`
+ ID string `json:"id,omitempty"`
+ ClientID string `json:"client-id,omitempty"`
+ Attributes map[string]interface{} `json:"attributes,omitempty"`
+ Relationships map[string]interface{} `json:"relationships,omitempty"`
+ Links *Links `json:"links,omitempty"`
+ Meta *Meta `json:"meta,omitempty"`
+}
+
+// RelationshipOneNode is used to represent a generic has one JSON API relation
+type RelationshipOneNode struct {
+ Data *Node `json:"data"`
+ Links *Links `json:"links,omitempty"`
+ Meta *Meta `json:"meta,omitempty"`
+}
+
+// RelationshipManyNode is used to represent a generic has many JSON API
+// relation
+type RelationshipManyNode struct {
+ Data []*Node `json:"data"`
+ Links *Links `json:"links,omitempty"`
+ Meta *Meta `json:"meta,omitempty"`
+}
+
+// Links is used to represent a `links` object.
+// http://jsonapi.org/format/#document-links
+type Links map[string]interface{}
+
+func (l *Links) validate() (err error) {
+ // Each member of a links object is a “link”. A link MUST be represented as
+ // either:
+ // - a string containing the link’s URL.
+ // - an object (“link object”) which can contain the following members:
+ // - href: a string containing the link’s URL.
+ // - meta: a meta object containing non-standard meta-information about the
+ // link.
+ for k, v := range *l {
+ _, isString := v.(string)
+ _, isLink := v.(Link)
+
+ if !(isString || isLink) {
+ return fmt.Errorf(
+ "The %s member of the links object was not a string or link object",
+ k,
+ )
+ }
+ }
+ return
+}
+
+// Link is used to represent a member of the `links` object.
+type Link struct {
+ Href string `json:"href"`
+ Meta Meta `json:"meta,omitempty"`
+}
+
+// Linkable is used to include document links in response data
+// e.g. {"self": "http://example.com/posts/1"}
+type Linkable interface {
+ JSONAPILinks() *Links
+}
+
+// RelationshipLinkable is used to include relationship links in response data
+// e.g. {"related": "http://example.com/posts/1/comments"}
+type RelationshipLinkable interface {
+ // JSONAPIRelationshipLinks will be invoked for each relationship with the corresponding relation name (e.g. `comments`)
+ JSONAPIRelationshipLinks(relation string) *Links
+}
+
+// Meta is used to represent a `meta` object.
+// http://jsonapi.org/format/#document-meta
+type Meta map[string]interface{}
+
+// Metable is used to include document meta in response data
+// e.g. {"foo": "bar"}
+type Metable interface {
+ JSONAPIMeta() *Meta
+}
+
+// RelationshipMetable is used to include relationship meta in response data
+type RelationshipMetable interface {
+ // JSONRelationshipMeta will be invoked for each relationship with the corresponding relation name (e.g. `comments`)
+ JSONAPIRelationshipMeta(relation string) *Meta
+}