JSONAPI Resources Anchor

Schema

Anchor::Schema

Example

class MySchema < Anchor::Schema
  resource UserResource
  resource PostResource
 
  enum UserRoleEnum
end
 
MySchema.register

Note: Currently, dependent resources and enums do not have their types generated. All resources and enums must be registered as part of the schema.

Class Methods

.register

.resource

  • Type: Anchor::Resource -> void

Anchor::Resource is not defined in Anchor. The definition is:

module Anchor::Resource
  abstract
  include Anchor::SchemaSerializable
end

Adds resource to register.

.enum

  • Type: Achor::Types::Enum -> void

Adds enum to register.

Classes

Anchor::Schema::Register

Instance Methods

#enums

  • Type: Anchor::Types::Enum[]

#resources

  • Type: Anchor::Resource[]

On this page