Module: JSONAPI

Defined in:
lib/jsonapi/error.rb,
lib/jsonapi/request.rb,
lib/jsonapi/resource.rb,
lib/jsonapi/callbacks.rb,
lib/jsonapi/formatter.rb,
lib/jsonapi/operation.rb,
lib/jsonapi/paginator.rb,
lib/jsonapi/exceptions.rb,
lib/jsonapi/mime_types.rb,
lib/jsonapi/association.rb,
lib/jsonapi/error_codes.rb,
lib/jsonapi/resource_for.rb,
lib/jsonapi/configuration.rb,
lib/jsonapi/operation_result.rb,
lib/jsonapi/resources/version.rb,
lib/jsonapi/resource_controller.rb,
lib/jsonapi/resource_serializer.rb,
lib/jsonapi/operations_processor.rb,
lib/jsonapi/active_record_operations_processor.rb

Defined Under Namespace

Modules: Callbacks, Exceptions, ResourceFor, Resources Classes: ActiveRecordOperationsProcessor, Association, Configuration, CreateHasManyAssociationOperation, CreateResourceOperation, Error, Formatter, KeyFormatter, Operation, OperationResult, OperationsProcessor, Paginator, RemoveHasManyAssociationOperation, RemoveHasOneAssociationOperation, RemoveResourceOperation, ReplaceFieldsOperation, ReplaceHasManyAssociationOperation, ReplaceHasOneAssociationOperation, Request, Resource, ResourceController, ResourceSerializer, RouteFormatter, ValueFormatter

Constant Summary collapse

MEDIA_TYPE = 
"application/vnd.api+json"
VALIDATION_ERROR = 
100
INVALID_RESOURCE = 
101
FILTER_NOT_ALLOWED = 
102
INVALID_FIELD_VALUE = 
103
INVALID_FIELD = 
104
PARAM_NOT_ALLOWED = 
105
PARAM_MISSING = 
106
INVALID_FILTER_VALUE = 
107
COUNT_MISMATCH = 
108
KEY_ORDER_MISMATCH = 
109
KEY_NOT_INCLUDED_IN_URL = 
110
INVALID_INCLUDE = 
112
RELATION_EXISTS = 
113
INVALID_SORT_CRITERIA = 
114
115
TYPE_MISMATCH = 
116
INVALID_PAGE_OBJECT = 
117
INVALID_PAGE_VALUE = 
118
INVALID_SORT_FORMAT = 
119
RECORD_NOT_FOUND = 
404
UNSUPPORTED_MEDIA_TYPE = 
415
LOCKED = 
423

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Returns the value of attribute configuration.



58
59
60
 
# File 'lib/jsonapi/configuration.rb', line 58

def configuration
  @configuration
end

Class Method Details

.configure {|@configuration| ... } ⇒ Object

Yields:



63
64
65
 
# File 'lib/jsonapi/configuration.rb', line 63

def self.configure
  yield(@configuration)
end