Categorygithub.com/neuronlabs/neuron-extensions/codec/cjsonapi
modulepackage
0.0.4
Repository: https://github.com/neuronlabs/neuron-extensions.git
Documentation: pkg.go.dev

# README

Neuron json:api

This repository contains Neuron codec.Codec implementation for the json:api specification.

More information about this specification could be found here: jsonapi.org.

# Functions

No description provided by the author
Codec gets the Codec value.

# Constants

KeyTotal is the meta key for the 'total' instances information.
MediaType is the identifier for the JSON API media type see http://jsonapi.org/format/#document-structure.
ParamLinks defines the links parameter name.
ParamLinks defines the links parameter name.
ParamLinks defines the links parameter name.
StructTag is the jsonapi defined struct tag.

# Variables

No description provided by the author

# Structs

Codec is jsonapi model.
ErrorsPayload is a serializer struct for representing a valid JSON API errors payload.
Link is used to represent a member of the `links` object.
ManyPayload is used to represent a generic JSON API payload where many resources (Nodes) were included in an [] in the "data" key.
Node is used to represent a generic JSON API Resource.
RelationshipManyNode is used to represent a generic has many JSON API relation.
RelationshipOneNode is used to represent a generic single JSON API relation.
SinglePayload is used to represent a generic JSON API payload where a single resource (Node) was included as an {} in the "data" key.
TopLinks is used to represent a `links` object.

# Interfaces

Payloader is used to encapsulate the One and Many payload types.

# Type aliases

Links is the structure used to represent a related 'links' object.
Meta is used to represent a `meta` object.