Table of Contents - easy-jsonapi-1.0.11 Documentation
Classes and Modules
- JSONAPI
- JSONAPI::Collection
- JSONAPI::ConfigManager
- JSONAPI::ConfigManager::Config
- JSONAPI::Document
- JSONAPI::Document::Error
- JSONAPI::Document::Error::ErrorMember
- JSONAPI::Document::Jsonapi
- JSONAPI::Document::Jsonapi::JsonapiMember
- JSONAPI::Document::Links
- JSONAPI::Document::Links::Link
- JSONAPI::Document::Meta
- JSONAPI::Document::Meta::MetaMember
- JSONAPI::Document::Resource
- JSONAPI::Document::Resource::Attributes
- JSONAPI::Document::Resource::Attributes::Attribute
- JSONAPI::Document::Resource::Relationships
- JSONAPI::Document::Resource::Relationships::Relationship
- JSONAPI::Document::ResourceId
- JSONAPI::Exceptions
- JSONAPI::Exceptions::DocumentExceptions
- JSONAPI::Exceptions::DocumentExceptions::InvalidDocument
- JSONAPI::Exceptions::HeadersExceptions
- JSONAPI::Exceptions::HeadersExceptions::InvalidHeader
- JSONAPI::Exceptions::JSONParseError
- JSONAPI::Exceptions::NamingExceptions
- JSONAPI::Exceptions::QueryParamsExceptions
- JSONAPI::Exceptions::QueryParamsExceptions::InvalidQueryParameter
- JSONAPI::Exceptions::UserDefinedExceptions
- JSONAPI::Exceptions::UserDefinedExceptions::InvalidComponent
- JSONAPI::Exceptions::UserDefinedExceptions::InvalidDocument
- JSONAPI::Exceptions::UserDefinedExceptions::InvalidHeader
- JSONAPI::Exceptions::UserDefinedExceptions::InvalidQueryParam
- JSONAPI::Field
- JSONAPI::HeaderCollection
- JSONAPI::HeaderCollection::Header
- JSONAPI::Item
- JSONAPI::Middleware
- JSONAPI::NameValuePair
- JSONAPI::NameValuePairCollection
- JSONAPI::Parser
- JSONAPI::Parser::DocumentParser
- JSONAPI::Parser::HeadersParser
- JSONAPI::Parser::JSONParser
- JSONAPI::Parser::RackReqParamsParser
- JSONAPI::Request
- JSONAPI::Request::QueryParamCollection
- JSONAPI::Request::QueryParamCollection::FieldsParam
- JSONAPI::Request::QueryParamCollection::FieldsParam::Fieldset
- JSONAPI::Request::QueryParamCollection::FilterParam
- JSONAPI::Request::QueryParamCollection::FilterParam::Filter
- JSONAPI::Request::QueryParamCollection::IncludeParam
- JSONAPI::Request::QueryParamCollection::PageParam
- JSONAPI::Request::QueryParamCollection::QueryParam
- JSONAPI::Request::QueryParamCollection::SortParam
- JSONAPI::Response
- JSONAPI::Utility
Methods
- ::accepts_jsonapi? — JSONAPI::Exceptions::HeadersExceptions
- ::add_the_param — JSONAPI::Parser::RackReqParamsParser
- ::all_hash_path? — JSONAPI::Utility
- ::any_additional_includes? — JSONAPI::Exceptions::DocumentExceptions
- ::array_to_s — JSONAPI::Utility
- ::both_are_hashes — JSONAPI::Exceptions::UserDefinedExceptions
- ::check_accept — JSONAPI::Exceptions::HeadersExceptions
- ::check_additional_constraints — JSONAPI::Exceptions::NamingExceptions
- ::check_attributes — JSONAPI::Exceptions::DocumentExceptions
- ::check_compliance — JSONAPI::Exceptions::QueryParamsExceptions
- ::check_compliance — JSONAPI::Exceptions::HeadersExceptions
- ::check_compliance — JSONAPI::Exceptions::DocumentExceptions
- ::check_content_type — JSONAPI::Exceptions::HeadersExceptions
- ::check_data — JSONAPI::Exceptions::DocumentExceptions
- ::check_delete_against_hdrs — JSONAPI::Exceptions::HeadersExceptions
- ::check_error — JSONAPI::Exceptions::DocumentExceptions
- ::check_errors — JSONAPI::Exceptions::DocumentExceptions
- ::check_essentials — JSONAPI::Exceptions::DocumentExceptions
- ::check_for_client_generated_id — JSONAPI::Exceptions::UserDefinedExceptions
- ::check_for_matching_types — JSONAPI::Exceptions::DocumentExceptions
- ::check_for_required_document_members — JSONAPI::Exceptions::UserDefinedExceptions
- ::check_for_required_headers — JSONAPI::Exceptions::UserDefinedExceptions
- ::check_for_required_params — JSONAPI::Exceptions::UserDefinedExceptions
- ::check_full_linkage — JSONAPI::Exceptions::DocumentExceptions
- ::check_get_against_hdrs — JSONAPI::Exceptions::HeadersExceptions
- ::check_http_method_against_headers — JSONAPI::Exceptions::HeadersExceptions
- ::check_included — JSONAPI::Exceptions::DocumentExceptions
- ::check_included_resources — JSONAPI::Exceptions::DocumentExceptions
- ::check_individual_members — JSONAPI::Exceptions::DocumentExceptions
- ::check_jsonapi — JSONAPI::Exceptions::DocumentExceptions
- ::check_link — JSONAPI::Exceptions::DocumentExceptions
- ::check_links — JSONAPI::Exceptions::DocumentExceptions
- ::check_member_constraints — JSONAPI::Exceptions::NamingExceptions
- ::check_member_names — JSONAPI::Exceptions::DocumentExceptions
- ::check_members — JSONAPI::Exceptions::DocumentExceptions
- ::check_meta — JSONAPI::Exceptions::DocumentExceptions
- ::check_name — JSONAPI::Exceptions::DocumentExceptions
- ::check_param_name — JSONAPI::Exceptions::QueryParamsExceptions
- ::check_patch_type — JSONAPI::Exceptions::DocumentExceptions
- ::check_post_against_hdrs — JSONAPI::Exceptions::HeadersExceptions
- ::check_post_type — JSONAPI::Exceptions::DocumentExceptions
- ::check_relationship — JSONAPI::Exceptions::DocumentExceptions
- ::check_relationship_data — JSONAPI::Exceptions::DocumentExceptions
- ::check_relationship_links — JSONAPI::Exceptions::DocumentExceptions
- ::check_relationships — JSONAPI::Exceptions::DocumentExceptions
- ::check_request — JSONAPI::Exceptions::HeadersExceptions
- ::check_resource — JSONAPI::Exceptions::DocumentExceptions
- ::check_resource_identifier — JSONAPI::Exceptions::DocumentExceptions
- ::check_resource_members — JSONAPI::Exceptions::DocumentExceptions
- ::check_structure — JSONAPI::Exceptions::UserDefinedExceptions
- ::check_top_level — JSONAPI::Exceptions::DocumentExceptions
- ::check_user_document_requirements — JSONAPI::Exceptions::UserDefinedExceptions
- ::check_user_header_requirements — JSONAPI::Exceptions::UserDefinedExceptions
- ::check_user_query_param_requirements — JSONAPI::Exceptions::UserDefinedExceptions
- ::check_values — JSONAPI::Exceptions::UserDefinedExceptions
- ::clearing_relationship_link? — JSONAPI::Exceptions::DocumentExceptions
- ::contains_at_least_one_jsonapi_media_type_without_params? — JSONAPI::Exceptions::HeadersExceptions
- ::contains_type_or_id_member? — JSONAPI::Exceptions::DocumentExceptions
- ::content_type_not_included_or_is_compliant? — JSONAPI::Exceptions::HeadersExceptions
- ::dump — JSONAPI::Parser::JSONParser
- ::ensure! — JSONAPI::Exceptions::DocumentExceptions
- ::full_linkage? — JSONAPI::Exceptions::DocumentExceptions
- ::get_config — JSONAPI::Exceptions::UserDefinedExceptions
- ::get_possible_includes — JSONAPI::Exceptions::DocumentExceptions
- ::includes_jsonapi_document? — JSONAPI::Parser
- ::integer? — JSONAPI::Utility
- ::jsonapi_and_has_params? — JSONAPI::Exceptions::HeadersExceptions
- ::keys_intersection_empty? — JSONAPI::Exceptions::DocumentExceptions
- ::member_to_s — JSONAPI::Utility
- ::new — JSONAPI::Collection
- ::new — JSONAPI::ConfigManager
- ::new — JSONAPI::ConfigManager::Config
- ::new — JSONAPI::Document
- ::new — JSONAPI::Document::Error
- ::new — JSONAPI::Document::Jsonapi
- ::new — JSONAPI::Document::Links
- ::new — JSONAPI::Document::Meta
- ::new — JSONAPI::Document::Resource
- ::new — JSONAPI::Document::Resource::Attributes
- ::new — JSONAPI::Document::Resource::Attributes::Attribute
- ::new — JSONAPI::Document::Resource::Relationships
- ::new — JSONAPI::Document::Resource::Relationships::Relationship
- ::new — JSONAPI::Document::ResourceId
- ::new — JSONAPI::Exceptions::DocumentExceptions::InvalidDocument
- ::new — JSONAPI::Exceptions::HeadersExceptions::InvalidHeader
- ::new — JSONAPI::Exceptions::QueryParamsExceptions::InvalidQueryParameter
- ::new — JSONAPI::Exceptions::UserDefinedExceptions::InvalidComponent
- ::new — JSONAPI::Field
- ::new — JSONAPI::HeaderCollection
- ::new — JSONAPI::Item
- ::new — JSONAPI::Middleware
- ::new — JSONAPI::NameValuePair
- ::new — JSONAPI::NameValuePairCollection
- ::new — JSONAPI::Request
- ::new — JSONAPI::Request::QueryParamCollection
- ::new — JSONAPI::Request::QueryParamCollection::FieldsParam
- ::new — JSONAPI::Request::QueryParamCollection::FieldsParam::Fieldset
- ::new — JSONAPI::Request::QueryParamCollection::FilterParam
- ::new — JSONAPI::Request::QueryParamCollection::FilterParam::Filter
- ::new — JSONAPI::Request::QueryParamCollection::IncludeParam
- ::new — JSONAPI::Request::QueryParamCollection::PageParam
- ::new — JSONAPI::Request::QueryParamCollection::QueryParam
- ::new — JSONAPI::Request::QueryParamCollection::SortParam
- ::parse — JSONAPI::Parser::DocumentParser
- ::parse — JSONAPI::Parser::HeadersParser
- ::parse — JSONAPI::Parser::JSONParser
- ::parse — JSONAPI::Parser::RackReqParamsParser
- ::parse_attributes — JSONAPI::Parser::DocumentParser
- ::parse_error — JSONAPI::Parser::DocumentParser
- ::parse_errors — JSONAPI::Parser::DocumentParser
- ::parse_fields_param — JSONAPI::Parser::RackReqParamsParser
- ::parse_filter_param — JSONAPI::Parser::RackReqParamsParser
- ::parse_hash — JSONAPI::Parser::DocumentParser
- ::parse_include_param — JSONAPI::Parser::RackReqParamsParser
- ::parse_included — JSONAPI::Parser::DocumentParser
- ::parse_links — JSONAPI::Parser::DocumentParser
- ::parse_meta — JSONAPI::Parser::DocumentParser
- ::parse_page_param — JSONAPI::Parser::RackReqParamsParser
- ::parse_query_param — JSONAPI::Parser::RackReqParamsParser
- ::parse_relationship — JSONAPI::Parser::DocumentParser
- ::parse_relationships — JSONAPI::Parser::DocumentParser
- ::parse_request — JSONAPI::Parser
- ::parse_resource — JSONAPI::Parser::DocumentParser
- ::parse_resource_identifier — JSONAPI::Parser::DocumentParser
- ::parse_resource_identifiers — JSONAPI::Parser::DocumentParser
- ::parse_resources — JSONAPI::Parser::DocumentParser
- ::parse_sort_param — JSONAPI::Parser::RackReqParamsParser
- ::parse_top_level_members — JSONAPI::Parser::DocumentParser
- ::path_to_res_type — JSONAPI::Utility
- ::populate_w_include_mem — JSONAPI::Exceptions::DocumentExceptions
- ::populate_w_primary_data — JSONAPI::Exceptions::DocumentExceptions
- ::populate_w_res_rels — JSONAPI::Exceptions::DocumentExceptions
- ::raise_error — JSONAPI::Exceptions::QueryParamsExceptions
- ::raise_error — JSONAPI::Exceptions::HeadersExceptions
- ::reached_value_to_check? — JSONAPI::Exceptions::UserDefinedExceptions
- ::relationship_link? — JSONAPI::Exceptions::DocumentExceptions
- ::res_id_to_sym — JSONAPI::Exceptions::DocumentExceptions
- ::shares_common_namespace? — JSONAPI::Exceptions::DocumentExceptions
- ::to_h_collection — JSONAPI::Utility
- ::to_h_member — JSONAPI::Utility
- ::to_h_value — JSONAPI::Utility
- ::to_string_collection — JSONAPI::Utility
- ::unique_pair? — JSONAPI::Exceptions::DocumentExceptions
- ::uuid? — JSONAPI::Utility
- ::validate — JSONAPI::Response
- #<< — JSONAPI::Document::Error
- #<< — JSONAPI::NameValuePairCollection
- #[] — JSONAPI::Collection
- #[] — JSONAPI::ConfigManager
- #[]= — JSONAPI::Collection
- #[]= — JSONAPI::ConfigManager
- #accept_header_jsonapi? — JSONAPI::Middleware
- #add — JSONAPI::Collection
- #add — JSONAPI::ConfigManager
- #add — JSONAPI::Document::Error
- #add — JSONAPI::Document::Jsonapi
- #add — JSONAPI::Document::Links
- #add — JSONAPI::Document::Meta
- #add — JSONAPI::Document::Resource::Attributes
- #add — JSONAPI::Document::Resource::Relationships
- #add — JSONAPI::HeaderCollection
- #add — JSONAPI::NameValuePairCollection
- #add — JSONAPI::Request::QueryParamCollection
- #add_member — JSONAPI::Request::QueryParamCollection::IncludeParam
- #all_configs_default? — JSONAPI::ConfigManager
- #call — JSONAPI::Middleware
- #check_body_compliance — JSONAPI::Middleware
- #check_compliance — JSONAPI::Middleware
- #check_headers_compliance — JSONAPI::Middleware
- #check_query_param_compliance — JSONAPI::Middleware
- #configs — JSONAPI::ConfigManager
- #content_type_header_jsonapi? — JSONAPI::Middleware
- #default? — JSONAPI::ConfigManager
- #default? — JSONAPI::ConfigManager::Config
- #each — JSONAPI::Collection
- #each — JSONAPI::ConfigManager
- #empty? — JSONAPI::Collection
- #ensure_keys_are_sym — JSONAPI::Item
- #environment_development? — JSONAPI::Middleware
- #fieldsets — JSONAPI::Request::QueryParamCollection::FieldsParam
- #get — JSONAPI::Collection
- #get — JSONAPI::ConfigManager
- #get — JSONAPI::HeaderCollection
- #in_maintenance_mode? — JSONAPI::Middleware
- #include? — JSONAPI::Collection
- #include? — JSONAPI::ConfigManager
- #insert — JSONAPI::Collection
- #insert — JSONAPI::ConfigManager
- #jsonapi_request? — JSONAPI::Middleware
- #keys — JSONAPI::Collection
- #limit — JSONAPI::Request::QueryParamCollection::PageParam
- #limit= — JSONAPI::Request::QueryParamCollection::PageParam
- #maintenance_response — JSONAPI::Middleware
- #method_missing — JSONAPI::Collection
- #method_missing — JSONAPI::ConfigManager
- #method_missing — JSONAPI::ConfigManager::Config
- #method_missing — JSONAPI::Item
- #method_missing — JSONAPI::NameValuePairCollection
- #method_missing — JSONAPI::Request::QueryParamCollection
- #name — JSONAPI::Field
- #name — JSONAPI::NameValuePair
- #name= — JSONAPI::Field
- #name= — JSONAPI::NameValuePair
- #name= — JSONAPI::Request::QueryParamCollection::QueryParam
- #offset — JSONAPI::Request::QueryParamCollection::PageParam
- #offset= — JSONAPI::Request::QueryParamCollection::PageParam
- #post_put_or_patch? — JSONAPI::Middleware
- #remove — JSONAPI::Collection
- #remove — JSONAPI::ConfigManager
- #res_included? — JSONAPI::Request::QueryParamCollection::IncludeParam
- #respond_to_missing? — JSONAPI::Collection
- #respond_to_missing? — JSONAPI::ConfigManager
- #respond_to_missing? — JSONAPI::ConfigManager::Config
- #respond_to_missing? — JSONAPI::Item
- #respond_to_missing? — JSONAPI::NameValuePairCollection
- #respond_to_missing? — JSONAPI::Request::QueryParamCollection
- #set — JSONAPI::Collection
- #set — JSONAPI::ConfigManager
- #should_get_var? — JSONAPI::Item
- #should_update_var? — JSONAPI::Item
- #size — JSONAPI::Collection
- #size — JSONAPI::ConfigManager
- #store_include — JSONAPI::Request::QueryParamCollection::IncludeParam
- #store_includes — JSONAPI::Request::QueryParamCollection::IncludeParam
- #stringify_includes_hash — JSONAPI::Request::QueryParamCollection::IncludeParam
- #to_h — JSONAPI::Document
- #to_h — JSONAPI::Document::Error
- #to_h — JSONAPI::Document::Resource
- #to_h — JSONAPI::Document::Resource::Relationships
- #to_h — JSONAPI::Document::Resource::Relationships::Relationship
- #to_h — JSONAPI::Document::ResourceId
- #to_h — JSONAPI::Item
- #to_h — JSONAPI::NameValuePair
- #to_h — JSONAPI::NameValuePairCollection
- #to_s — JSONAPI::Collection
- #to_s — JSONAPI::ConfigManager
- #to_s — JSONAPI::Document
- #to_s — JSONAPI::Document::Resource
- #to_s — JSONAPI::Document::Resource::Relationships::Relationship
- #to_s — JSONAPI::Document::ResourceId
- #to_s — JSONAPI::Field
- #to_s — JSONAPI::Item
- #to_s — JSONAPI::NameValuePair
- #to_s — JSONAPI::NameValuePairCollection
- #to_s — JSONAPI::Request
- #to_s — JSONAPI::Request::QueryParamCollection
- #to_s — JSONAPI::Request::QueryParamCollection::FieldsParam
- #to_s — JSONAPI::Request::QueryParamCollection::FieldsParam::Fieldset
- #to_s — JSONAPI::Request::QueryParamCollection::FilterParam
- #to_s — JSONAPI::Request::QueryParamCollection::FilterParam::Filter
- #to_s — JSONAPI::Request::QueryParamCollection::IncludeParam
- #to_s — JSONAPI::Request::QueryParamCollection::PageParam
- #to_s — JSONAPI::Request::QueryParamCollection::QueryParam
- #to_s — JSONAPI::Request::QueryParamCollection::SortParam
- #to_s_mem — JSONAPI::Request::QueryParamCollection::IncludeParam
- #type — JSONAPI::Field
- #type= — JSONAPI::Field
- #validate — JSONAPI::Document
- #value — JSONAPI::NameValuePair
- #value — JSONAPI::Request::QueryParamCollection::FilterParam::Filter
- #value — JSONAPI::Request::QueryParamCollection::PageParam
- #value= — JSONAPI::NameValuePair
- #value= — JSONAPI::Request::QueryParamCollection::PageParam
- #value= — JSONAPI::Request::QueryParamCollection::QueryParam