Module: JSONAPI

Defined in:
lib/json_api.rb,
lib/json_api.rb,
lib/json_api/railtie.rb,
lib/json_api/routing.rb,
lib/json_api/version.rb,
lib/json_api/configuration.rb,
lib/json_api/resources/resource.rb,
lib/json_api/support/responders.rb,
lib/json_api/testing/sti_helpers.rb,
lib/json_api/testing/test_helper.rb,
lib/json_api/support/sort_parsing.rb,
lib/json_api/support/param_helpers.rb,
lib/json_api/support/instrumentation.rb,
lib/json_api/support/type_conversion.rb,
lib/json_api/active_storage/detection.rb,
lib/json_api/serialization/serializer.rb,
lib/json_api/support/collection_query.rb,
lib/json_api/support/concerns/sorting.rb,
lib/json_api/support/response_helpers.rb,
lib/json_api/resources/resource_loader.rb,
lib/json_api/serialization/deserializer.rb,
lib/json_api/support/relationship_guard.rb,
lib/json_api/controllers/base_controller.rb,
lib/json_api/resources/concerns/meta_dsl.rb,
lib/json_api/support/concerns/pagination.rb,
lib/json_api/support/resource_identifier.rb,
lib/json_api/active_storage/serialization.rb,
lib/json_api/errors/parameter_not_allowed.rb,
lib/json_api/support/relationship_helpers.rb,
lib/json_api/active_storage/deserialization.rb,
lib/json_api/resources/concerns/filters_dsl.rb,
lib/json_api/support/active_storage_support.rb,
lib/json_api/support/concerns/nested_filters.rb,
lib/json_api/controllers/resources_controller.rb,
lib/json_api/support/concerns/regular_filters.rb,
lib/json_api/resources/concerns/attributes_dsl.rb,
lib/json_api/support/concerns/condition_building.rb,
lib/json_api/controllers/relationships_controller.rb,
lib/json_api/resources/concerns/relationships_dsl.rb,
lib/json_api/support/concerns/polymorphic_filters.rb,
lib/json_api/controllers/concerns/resource_actions.rb,
lib/json_api/resources/active_storage_blob_resource.rb,
lib/json_api/resources/concerns/model_class_helpers.rb,
lib/json_api/resources/concerns/sortable_fields_dsl.rb,
lib/json_api/controllers/concerns/controller_helpers.rb,
lib/json_api/controllers/concerns/relationships/events.rb,
lib/json_api/serialization/concerns/meta_serialization.rb,
lib/json_api/controllers/concerns/relationships/removal.rb,
lib/json_api/controllers/concerns/relationships/sorting.rb,
lib/json_api/serialization/concerns/links_serialization.rb,
lib/json_api/controllers/concerns/relationships/updating.rb,
lib/json_api/serialization/concerns/includes_serialization.rb,
lib/json_api/serialization/concerns/deserialization_helpers.rb,
lib/json_api/serialization/concerns/relationship_processing.rb,
lib/json_api/controllers/concerns/controller_helpers/parsing.rb,
lib/json_api/serialization/concerns/attributes_serialization.rb,
lib/json_api/controllers/concerns/relationships/serialization.rb,
lib/json_api/controllers/concerns/resource_actions/pagination.rb,
lib/json_api/controllers/concerns/resource_actions/preloading.rb,
lib/json_api/serialization/concerns/attributes_deserialization.rb,
lib/json_api/controllers/concerns/resource_actions/crud_helpers.rb,
lib/json_api/serialization/concerns/relationships_serialization.rb,
lib/json_api/controllers/concerns/relationships/response_helpers.rb,
lib/json_api/controllers/concerns/resource_actions/serialization.rb,
lib/json_api/serialization/concerns/relationships_deserialization.rb,
lib/json_api/controllers/concerns/controller_helpers/authorization.rb,
lib/json_api/controllers/concerns/controller_helpers/document_meta.rb,
lib/json_api/controllers/concerns/resource_actions/type_validation.rb,
lib/json_api/controllers/concerns/controller_helpers/resource_setup.rb,
lib/json_api/controllers/concerns/resource_actions/field_validation.rb,
lib/json_api/controllers/concerns/resource_actions/resource_loading.rb,
lib/json_api/serialization/concerns/model_attributes_transformation.rb,
lib/json_api/controllers/concerns/controller_helpers/error_rendering.rb,
lib/json_api/controllers/concerns/resource_actions/filter_validation.rb,
lib/json_api/controllers/concerns/relationships/active_storage_removal.rb

Defined Under Namespace

Modules: ActiveStorage, ActiveStorageSupport, ControllerHelpers, Errors, Exceptions, Instrumentation, ParamHelpers, RelationshipGuard, RelationshipHelpers, Relationships, ResourceActions, ResourceIdentifier, Resources, Responders, ResponseHelpers, Routing, Serialization, SortParsing, Support, Testing, TypeConversion Classes: ActiveStorageBlobResource, AuthorizationError, BaseController, CollectionQuery, Configuration, Deserializer, Error, Railtie, RelationshipsController, Resource, ResourceLoader, ResourcesController, Serializer

Constant Summary collapse

VERSION = 
"1.1.2"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



54
55
56
 
# File 'lib/json_api/configuration.rb', line 54

def self.configuration
  @configuration ||= Configuration.new
end

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

Yields:



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

def self.configure
  yield configuration if block_given?
end

.rebuild_base_controllers! ⇒ Object

Rebuild BaseController and RelationshipsController to reflect the current base_controller_class configuration. Safe to call repeatedly.



16
17
18
19
20
21
22
 
# File 'lib/json_api.rb', line 16

def self.rebuild_base_controllers!
  remove_const(:BaseController) if const_defined?(:BaseController)
  load "json_api/controllers/base_controller.rb"

  remove_const(:RelationshipsController) if const_defined?(:RelationshipsController)
  load "json_api/controllers/relationships_controller.rb"
end