Module: JSONAPIonify::Structure

Included in:

Api::Resource::Builders::BaseBuilder, Api::Resource::Builders::ClassMethods, Api::Resource::Includer

Defined in:

lib/jsonapionify/structure/objects/top_level.rb,
lib/jsonapionify/structure.rb,
lib/jsonapionify/structure/maps/base.rb,
lib/jsonapionify/structure/maps/links.rb,
lib/jsonapionify/structure/objects/base.rb,
lib/jsonapionify/structure/objects/link.rb,
lib/jsonapionify/structure/objects/meta.rb,
lib/jsonapionify/structure/objects/error.rb,
lib/jsonapionify/structure/helpers/errors.rb,
lib/jsonapionify/structure/objects/source.rb,
lib/jsonapionify/structure/objects/jsonapi.rb,
lib/jsonapionify/structure/collections/base.rb,
lib/jsonapionify/structure/maps/error_links.rb,
lib/jsonapionify/structure/objects/resource.rb,
lib/jsonapionify/structure/collections/errors.rb,
lib/jsonapionify/structure/maps/relationships.rb,
lib/jsonapionify/structure/objects/attributes.rb,
lib/jsonapionify/structure/helpers/validations.rb,
lib/jsonapionify/structure/maps/resource_links.rb,
lib/jsonapionify/structure/helpers/member_names.rb,
lib/jsonapionify/structure/maps/top_level_links.rb,
lib/jsonapionify/structure/objects/relationship.rb,
lib/jsonapionify/structure/collections/resources.rb,
lib/jsonapionify/structure/helpers/object_setters.rb,
lib/jsonapionify/structure/helpers/inherits_origin.rb,
lib/jsonapionify/structure/helpers/object_defaults.rb,
lib/jsonapionify/structure/maps/relationship_links.rb,
lib/jsonapionify/structure/helpers/pagination_links.rb,
lib/jsonapionify/structure/objects/included_resource.rb,
lib/jsonapionify/structure/objects/resource_identifier.rb,
lib/jsonapionify/structure/collections/included_resources.rb,
lib/jsonapionify/structure/collections/resource_identifiers.rb

Overview

TopLevelObject

A JSON object MUST be at the root of every JSON API request and response containing data. This object defines a document’s “top level”.

Defined Under Namespace

Modules: Collections, Helpers, Maps, Objects

Constant Summary

ValidationError =

Class.new StandardError