Table of Contents - jsonapi_compliable-0.11.34 Documentation
Classes and Modules
- Jsonapi
- Jsonapi::ResourceGenerator
- JsonapiCompliable
- JsonapiCompliable::Adapters
- JsonapiCompliable::Adapters::Abstract
- JsonapiCompliable::Adapters::ActiveRecord
- JsonapiCompliable::Adapters::ActiveRecordSideloading
- JsonapiCompliable::Adapters::Null
- JsonapiCompliable::Base
- JsonapiCompliable::Base::ClassMethods
- JsonapiCompliable::Configuration
- JsonapiCompliable::Deserializer
- JsonapiCompliable::Errors
- JsonapiCompliable::Errors::BadFilter
- JsonapiCompliable::Errors::InvalidInclude
- JsonapiCompliable::Errors::MissingSerializer
- JsonapiCompliable::Errors::RecordNotFound
- JsonapiCompliable::Errors::RequiredFilter
- JsonapiCompliable::Errors::StatNotFound
- JsonapiCompliable::Errors::UnsupportedPageSize
- JsonapiCompliable::Errors::ValidationError
- JsonapiCompliable::Extensions
- JsonapiCompliable::Extensions::BooleanAttribute
- JsonapiCompliable::Extensions::BooleanAttribute::ClassMethods
- JsonapiCompliable::Extensions::ExtraAttribute
- JsonapiCompliable::Extensions::ExtraAttribute::ClassMethods
- JsonapiCompliable::Query
- JsonapiCompliable::Rails
- JsonapiCompliable::Resource
- JsonapiCompliable::Scope
- JsonapiCompliable::Scoping
- JsonapiCompliable::Scoping::Base
- JsonapiCompliable::Scoping::DefaultFilter
- JsonapiCompliable::Scoping::ExtraFields
- JsonapiCompliable::Scoping::Filter
- JsonapiCompliable::Scoping::Filterable
- JsonapiCompliable::Scoping::Paginate
- JsonapiCompliable::Scoping::Sort
- JsonapiCompliable::SerializableTempId
- JsonapiCompliable::Sideload
- JsonapiCompliable::Stats
- JsonapiCompliable::Stats::DSL
- JsonapiCompliable::Stats::Payload
- JsonapiCompliable::Util
- JsonapiCompliable::Util::FieldParams
- JsonapiCompliable::Util::Hash
- JsonapiCompliable::Util::Hooks
- JsonapiCompliable::Util::IncludeParams
- JsonapiCompliable::Util::Persistence
- JsonapiCompliable::Util::RelationshipPayload
- JsonapiCompliable::Util::RenderOptions
- JsonapiCompliable::Util::Sideload
- JsonapiCompliable::Util::ValidationResponse
- Object
Methods
- ::_hooks — JsonapiCompliable::Util::Hooks
- ::add — JsonapiCompliable::Util::Hooks
- ::allow_filter — JsonapiCompliable::Resource
- ::allow_stat — JsonapiCompliable::Resource
- ::before_commit — JsonapiCompliable::Resource
- ::config — JsonapiCompliable
- ::configure — JsonapiCompliable
- ::context — JsonapiCompliable
- ::context= — JsonapiCompliable
- ::deep_dup — JsonapiCompliable::Util::Hash
- ::deep_merge! — JsonapiCompliable::Util::Hash
- ::default_filter — JsonapiCompliable::Resource
- ::default_hash — JsonapiCompliable::Query
- ::default_page_number — JsonapiCompliable::Resource
- ::default_page_size — JsonapiCompliable::Resource
- ::default_sort — JsonapiCompliable::Resource
- ::extra_field — JsonapiCompliable::Resource
- ::generate — JsonapiCompliable::Util::RenderOptions
- ::hooks= — JsonapiCompliable::Util::Hooks
- ::included — JsonapiCompliable
- ::included — JsonapiCompliable::Extensions::BooleanAttribute
- ::included — JsonapiCompliable::Extensions::ExtraAttribute
- ::included — JsonapiCompliable::Rails
- ::inferrer — JsonapiCompliable::Util::RenderOptions
- ::inherited — Object
- ::inherited — JsonapiCompliable::Resource
- ::inherited — JsonapiCompliable::Base
- ::iterate — JsonapiCompliable::Util::RelationshipPayload
- ::keys — JsonapiCompliable::Util::Hash
- ::model — JsonapiCompliable::Resource
- ::namespace — JsonapiCompliable::Util::Sideload
- ::new — JsonapiCompliable::Configuration
- ::new — JsonapiCompliable::Deserializer
- ::new — JsonapiCompliable::Errors::ValidationError
- ::new — JsonapiCompliable::Errors::MissingSerializer
- ::new — JsonapiCompliable::Errors::UnsupportedPageSize
- ::new — JsonapiCompliable::Errors::InvalidInclude
- ::new — JsonapiCompliable::Errors::StatNotFound
- ::new — JsonapiCompliable::Errors::RequiredFilter
- ::new — JsonapiCompliable::Query
- ::new — JsonapiCompliable::Scope
- ::new — JsonapiCompliable::Scoping::Base
- ::new — JsonapiCompliable::Sideload
- ::new — JsonapiCompliable::Stats::DSL
- ::new — JsonapiCompliable::Stats::Payload
- ::new — JsonapiCompliable::Util::Persistence
- ::new — JsonapiCompliable::Util::RelationshipPayload
- ::new — JsonapiCompliable::Util::ValidationResponse
- ::paginate — JsonapiCompliable::Resource
- ::parse — JsonapiCompliable::Util::FieldParams
- ::record — JsonapiCompliable::Util::Hooks
- ::run — JsonapiCompliable::Util::Hooks
- ::scrub — JsonapiCompliable::Util::IncludeParams
- ::sideloading — JsonapiCompliable::Resource
- ::sort — JsonapiCompliable::Resource
- ::type — JsonapiCompliable::Resource
- ::use_adapter — JsonapiCompliable::Resource
- ::with_context — JsonapiCompliable
- #_persist — JsonapiCompliable::Base
- #actions — Jsonapi::ResourceGenerator
- #actions? — Jsonapi::ResourceGenerator
- #adapter — JsonapiCompliable::Resource
- #add_hook — JsonapiCompliable::Util::Persistence
- #add_scoping — JsonapiCompliable::Scope
- #after_save — JsonapiCompliable::Sideload
- #all_sideloads — JsonapiCompliable::Sideload
- #all_valid? — JsonapiCompliable::Util::ValidationResponse
- #allow_sideload — JsonapiCompliable::Sideload
- #api_namespace — Jsonapi::ResourceGenerator
- #application_resource_defined? — Jsonapi::ResourceGenerator
- #apply — JsonapiCompliable::Scoping::Base
- #apply — JsonapiCompliable::Scoping::DefaultFilter
- #apply — JsonapiCompliable::Scoping::ExtraFields
- #apply — JsonapiCompliable::Scoping::Filter
- #apply — JsonapiCompliable::Scoping::Paginate
- #apply? — JsonapiCompliable::Scoping::Base
- #apply? — JsonapiCompliable::Scoping::Paginate
- #apply_custom_scope — JsonapiCompliable::Scoping::Base
- #apply_custom_scope — JsonapiCompliable::Scoping::Paginate
- #apply_custom_scope — JsonapiCompliable::Scoping::Sort
- #apply_scoping — JsonapiCompliable::Scope
- #apply_standard_or_override — JsonapiCompliable::Scoping::Base
- #apply_standard_scope — JsonapiCompliable::Scoping::Base
- #apply_standard_scope — JsonapiCompliable::Scoping::Paginate
- #apply_standard_scope — JsonapiCompliable::Scoping::Sort
- #apply_standard_scope? — JsonapiCompliable::Scoping::Base
- #as_jsonapi — JsonapiCompliable::SerializableTempId
- #assign — JsonapiCompliable::Sideload
- #assign_temp_id — JsonapiCompliable::Util::Persistence
- #associate — JsonapiCompliable::Adapters::Abstract
- #associate — JsonapiCompliable::Adapters::ActiveRecord
- #associate — JsonapiCompliable::Adapters::Null
- #associate — JsonapiCompliable::Resource
- #associate — JsonapiCompliable::Sideload
- #associate_children — JsonapiCompliable::Util::Persistence
- #associate_many — JsonapiCompliable::Adapters::ActiveRecord
- #associate_parents — JsonapiCompliable::Util::Persistence
- #association? — JsonapiCompliable::Query
- #association_names — JsonapiCompliable::Query
- #association_names — JsonapiCompliable::Resource
- #association_names — JsonapiCompliable::Sideload
- #attributes — JsonapiCompliable::Deserializer
- #attributes= — JsonapiCompliable::Deserializer
- #average — JsonapiCompliable::Adapters::Abstract
- #average — JsonapiCompliable::Adapters::ActiveRecord
- #average — JsonapiCompliable::Adapters::Null
- #average! — JsonapiCompliable::Stats::DSL
- #before_commit — JsonapiCompliable::Resource
- #belongs_to — JsonapiCompliable::Adapters::ActiveRecordSideloading
- #boolean_attribute — JsonapiCompliable::Extensions::BooleanAttribute::ClassMethods
- #build_scope — JsonapiCompliable::Resource
- #calculation — JsonapiCompliable::Stats::DSL
- #call_resource_method — JsonapiCompliable::Util::Persistence
- #context_namespace — JsonapiCompliable::Resource
- #copy_resource_file — Jsonapi::ResourceGenerator
- #count — JsonapiCompliable::Adapters::Abstract
- #count — JsonapiCompliable::Adapters::ActiveRecord
- #count — JsonapiCompliable::Adapters::Null
- #count! — JsonapiCompliable::Stats::DSL
- #create — JsonapiCompliable::Adapters::Abstract
- #create — JsonapiCompliable::Adapters::ActiveRecord
- #create — JsonapiCompliable::Resource
- #custom_scope — JsonapiCompliable::Scoping::Paginate
- #custom_scope — JsonapiCompliable::Scoping::Sort
- #data — JsonapiCompliable::Deserializer
- #deep_merge! — JsonapiCompliable::Deserializer
- #default_filters — JsonapiCompliable::Resource
- #default_jsonapi_render_options — JsonapiCompliable::Base
- #default_page_number — JsonapiCompliable::Resource
- #default_page_size — JsonapiCompliable::Resource
- #default_sort — JsonapiCompliable::Resource
- #deserialized_params — JsonapiCompliable::Base
- #destroy — JsonapiCompliable::Adapters::Abstract
- #destroy — JsonapiCompliable::Adapters::ActiveRecord
- #destroy — JsonapiCompliable::Resource
- #disassociate — JsonapiCompliable::Adapters::Abstract
- #disassociate — JsonapiCompliable::Adapters::ActiveRecord
- #disassociate — JsonapiCompliable::Resource
- #disassociate — JsonapiCompliable::Sideload
- #docs_controller? — Jsonapi::ResourceGenerator
- #each_calculation — JsonapiCompliable::Stats::Payload
- #each_extra_field — JsonapiCompliable::Scoping::ExtraFields
- #each_filter — JsonapiCompliable::Scoping::Filter
- #each_sort — JsonapiCompliable::Scoping::Sort
- #experimental_concurrency= — JsonapiCompliable::Configuration
- #extra_attribute — JsonapiCompliable::Extensions::ExtraAttribute::ClassMethods
- #extra_fields — JsonapiCompliable::Resource
- #extra_fields — JsonapiCompliable::Scoping::ExtraFields
- #filter — JsonapiCompliable::Adapters::Abstract
- #filter — JsonapiCompliable::Adapters::ActiveRecord
- #filter — JsonapiCompliable::Adapters::Null
- #filter_param — JsonapiCompliable::Scoping::Filterable
- #filter_scope — JsonapiCompliable::Scoping::Filter
- #filters — JsonapiCompliable::Resource
- #find_filter — JsonapiCompliable::Scoping::Filterable
- #find_filter! — JsonapiCompliable::Scoping::Filterable
- #fire_hooks! — JsonapiCompliable::Sideload
- #force_includes? — JsonapiCompliable::Base
- #generate — JsonapiCompliable::Stats::Payload
- #generate_application_resource — Jsonapi::ResourceGenerator
- #generate_controller — Jsonapi::ResourceGenerator
- #generate_resource — Jsonapi::ResourceGenerator
- #generate_route — Jsonapi::ResourceGenerator
- #generate_serializer — Jsonapi::ResourceGenerator
- #generate_spec_payload — Jsonapi::ResourceGenerator
- #generate_strong_resource — Jsonapi::ResourceGenerator
- #generate_swagger — Jsonapi::ResourceGenerator
- #generate_tests — Jsonapi::ResourceGenerator
- #group_by — JsonapiCompliable::Sideload
- #has_and_belongs_to_many — JsonapiCompliable::Adapters::ActiveRecordSideloading
- #has_many — JsonapiCompliable::Adapters::ActiveRecordSideloading
- #has_one — JsonapiCompliable::Adapters::ActiveRecordSideloading
- #hooks — JsonapiCompliable::Sideload
- #id — JsonapiCompliable::Deserializer
- #include_directive — JsonapiCompliable::Deserializer
- #include_directive — JsonapiCompliable::Query
- #include_hash — JsonapiCompliable::Query
- #included — JsonapiCompliable::Deserializer
- #iterate — JsonapiCompliable::Util::Persistence
- #iterate — JsonapiCompliable::Util::RelationshipPayload
- #jsonapi — JsonapiCompliable::Base::ClassMethods
- #jsonapi_config — Jsonapi::ResourceGenerator
- #jsonapi_context — JsonapiCompliable::Base
- #jsonapi_create — JsonapiCompliable::Base
- #jsonapi_destroy — JsonapiCompliable::Base
- #jsonapi_resource — JsonapiCompliable::Base
- #jsonapi_scope — JsonapiCompliable::Base
- #jsonapi_update — JsonapiCompliable::Base
- #maximum — JsonapiCompliable::Adapters::Abstract
- #maximum — JsonapiCompliable::Adapters::ActiveRecord
- #maximum — JsonapiCompliable::Adapters::Null
- #maximum! — JsonapiCompliable::Stats::DSL
- #merge_include_directive — JsonapiCompliable::Deserializer
- #message — JsonapiCompliable::Errors::MissingSerializer
- #message — JsonapiCompliable::Errors::UnsupportedPageSize
- #message — JsonapiCompliable::Errors::InvalidInclude
- #message — JsonapiCompliable::Errors::StatNotFound
- #message — JsonapiCompliable::Errors::RequiredFilter
- #meta — JsonapiCompliable::Deserializer
- #method — JsonapiCompliable::Deserializer
- #method_missing — JsonapiCompliable::Stats::DSL
- #minimum — JsonapiCompliable::Adapters::Abstract
- #minimum — JsonapiCompliable::Adapters::ActiveRecord
- #minimum — JsonapiCompliable::Adapters::Null
- #minimum! — JsonapiCompliable::Stats::DSL
- #missing_required_filters — JsonapiCompliable::Scoping::Filterable
- #model — JsonapiCompliable::Resource
- #model_klass — Jsonapi::ResourceGenerator
- #normalize_string_value — JsonapiCompliable::Scoping::Filter
- #normalize_string_values — JsonapiCompliable::Scoping::Filter
- #number — JsonapiCompliable::Scoping::Paginate
- #omit_comments? — Jsonapi::ResourceGenerator
- #order — JsonapiCompliable::Adapters::Abstract
- #order — JsonapiCompliable::Adapters::ActiveRecord
- #order — JsonapiCompliable::Adapters::Null
- #overridden? — JsonapiCompliable::Scoping::DefaultFilter
- #page_param — JsonapiCompliable::Scoping::Paginate
- #paginate — JsonapiCompliable::Adapters::Abstract
- #paginate — JsonapiCompliable::Adapters::ActiveRecord
- #paginate — JsonapiCompliable::Adapters::Null
- #pagination — JsonapiCompliable::Resource
- #parse_fields — JsonapiCompliable::Query
- #parse_filter — JsonapiCompliable::Query
- #parse_include — JsonapiCompliable::Query
- #parse_pagination — JsonapiCompliable::Query
- #parse_sort — JsonapiCompliable::Query
- #parse_stats — JsonapiCompliable::Query
- #parse_string_arrays — JsonapiCompliable::Scoping::Filter
- #payload_for — JsonapiCompliable::Util::RelationshipPayload
- #perform_render_jsonapi — JsonapiCompliable::Base
- #persist_object — JsonapiCompliable::Util::Persistence
- #persist_with_relationships — JsonapiCompliable::Resource
- #polymorphic? — JsonapiCompliable::Sideload
- #polymorphic_belongs_to — JsonapiCompliable::Adapters::ActiveRecordSideloading
- #polymorphic_child_for_type — JsonapiCompliable::Sideload
- #polymorphic_grouper — JsonapiCompliable::Sideload
- #post_process — JsonapiCompliable::Util::Persistence
- #pretty — JsonapiCompliable::Errors::StatNotFound
- #process_belongs_to — JsonapiCompliable::Util::Persistence
- #process_has_many — JsonapiCompliable::Util::Persistence
- #process_relationship — JsonapiCompliable::Deserializer
- #process_relationship_datum — JsonapiCompliable::Deserializer
- #process_relationships — JsonapiCompliable::Deserializer
- #prompt — Jsonapi::ResourceGenerator
- #query — JsonapiCompliable::Base
- #query_hash — JsonapiCompliable::Scope
- #query_hash — JsonapiCompliable::Base
- #raw_attributes — JsonapiCompliable::Deserializer
- #raw_relationships — JsonapiCompliable::Deserializer
- #relationships — JsonapiCompliable::Deserializer
- #removed? — JsonapiCompliable::Deserializer
- #render_jsonapi — JsonapiCompliable::Base
- #requested_relationships — Object
- #required_filters — JsonapiCompliable::Scoping::Filterable
- #required_filters_provided? — JsonapiCompliable::Scoping::Filterable
- #resolve — JsonapiCompliable::Adapters::Abstract
- #resolve — JsonapiCompliable::Adapters::ActiveRecord
- #resolve — JsonapiCompliable::Adapters::Null
- #resolve — JsonapiCompliable::Resource
- #resolve — JsonapiCompliable::Scope
- #resolve — JsonapiCompliable::Sideload
- #resolve_basic — JsonapiCompliable::Sideload
- #resolve_polymorphic — JsonapiCompliable::Sideload
- #resolve_stats — JsonapiCompliable::Scope
- #resource — JsonapiCompliable::Sideload
- #run — JsonapiCompliable::Util::Persistence
- #scope — JsonapiCompliable::Sideload
- #should_yield? — JsonapiCompliable::Util::RelationshipPayload
- #sideload — JsonapiCompliable::Scope
- #sideload — JsonapiCompliable::Sideload
- #sideload_whitelist — JsonapiCompliable::Base
- #sideload_whitelist — JsonapiCompliable::Base::ClassMethods
- #sideloading — JsonapiCompliable::Resource
- #sideloading_module — JsonapiCompliable::Adapters::Abstract
- #sideloading_module — JsonapiCompliable::Adapters::ActiveRecord
- #size — JsonapiCompliable::Scoping::Paginate
- #sort_attr — JsonapiCompliable::Query
- #sort_param — JsonapiCompliable::Scoping::Sort
- #sorting — JsonapiCompliable::Resource
- #stat — JsonapiCompliable::Resource
- #stats — JsonapiCompliable::Resource
- #sub_directives — JsonapiCompliable::Deserializer
- #success? — JsonapiCompliable::Util::ValidationResponse
- #sum — JsonapiCompliable::Adapters::Abstract
- #sum — JsonapiCompliable::Adapters::ActiveRecord
- #sum — JsonapiCompliable::Adapters::Null
- #sum! — JsonapiCompliable::Stats::DSL
- #to_a — JsonapiCompliable::Util::ValidationResponse
- #to_hash — JsonapiCompliable::Query
- #transaction — JsonapiCompliable::Adapters::Abstract
- #transaction — JsonapiCompliable::Adapters::ActiveRecord
- #transaction — JsonapiCompliable::Adapters::Null
- #transaction — JsonapiCompliable::Resource
- #type — Jsonapi::ResourceGenerator
- #type — JsonapiCompliable::Resource
- #update — JsonapiCompliable::Adapters::Abstract
- #update — JsonapiCompliable::Adapters::ActiveRecord
- #update — JsonapiCompliable::Resource
- #update_config! — Jsonapi::ResourceGenerator
- #update_foreign_key — JsonapiCompliable::Util::Persistence
- #update_foreign_key_for_parents — JsonapiCompliable::Util::Persistence
- #update_foreign_type — JsonapiCompliable::Util::Persistence
- #valid_object? — JsonapiCompliable::Util::ValidationResponse
- #validate! — JsonapiCompliable::Util::ValidationResponse
- #validate_content_type — JsonapiCompliable::Deserializer
- #with_context — JsonapiCompliable::Resource
- #wrap_context — JsonapiCompliable::Base
- #zero_results? — JsonapiCompliable::Query