Table of Contents - model-api-0.8.12 Documentation
Classes and Modules
- ModelApi
- ModelApi::ApiContext
- ModelApi::BaseController
- ModelApi::BaseController::ClassMethods
- ModelApi::BaseController::InstanceMethods
- ModelApi::BaseController::Utils
- ModelApi::BypassParseMiddleware
- ModelApi::HashMetadata
- ModelApi::Model
- ModelApi::Model::ClassMethods
- ModelApi::NotFoundException
- ModelApi::OpenApiExtensions
- ModelApi::OpenApiExtensions::ClassMethods
- ModelApi::OpenApiExtensions::Utils
- ModelApi::Renderer
- ModelApi::SimpleMetadata
- ModelApi::SuppressLoginRedirectMiddleware
- ModelApi::UnauthorizedException
- ModelApi::Utils
Methods
- ::action_filter — ModelApi::Utils
- ::add_ignored_field — ModelApi::Utils
- ::add_sort_params — ModelApi::OpenApiExtensions::Utils
- ::after_save_callbacks — ModelApi::Utils
- ::api_attrs — ModelApi::Utils
- ::api_links — ModelApi::Utils
- ::apply_updates — ModelApi::Utils
- ::assoc_opts — ModelApi::Utils
- ::attr_types_from_columns — ModelApi::OpenApiExtensions::Utils
- ::attrs_by_type — ModelApi::Renderer
- ::before_save_callbacks — ModelApi::Utils
- ::before_validate_callbacks — ModelApi::Utils
- ::build_hateoas_route_args — ModelApi::Renderer
- ::build_object_hateoas_route_args — ModelApi::Renderer
- ::build_response_obj_json — ModelApi::Renderer
- ::class_model_assoc_property — ModelApi::OpenApiExtensions::Utils
- ::class_model_base — ModelApi::OpenApiExtensions::Utils
- ::class_model_base_property — ModelApi::OpenApiExtensions::Utils
- ::common_http_headers — ModelApi::Utils
- ::configure — ModelApi
- ::contextual_metadata_opts — ModelApi::Utils
- ::default_global_metadata — ModelApi
- ::define_api_collection_response — ModelApi::OpenApiExtensions::Utils
- ::define_api_response — ModelApi::OpenApiExtensions::Utils
- ::define_open_api_object — ModelApi::OpenApiExtensions::Utils
- ::define_open_api_object_from_model — ModelApi::OpenApiExtensions::Utils
- ::define_open_api_objects — ModelApi::OpenApiExtensions::Utils
- ::do_resolve_assoc_obj — ModelApi::Utils
- ::eval_bool — ModelApi::Utils
- ::eval_can — ModelApi::Utils
- ::exclude_associations_metadata — ModelApi::Utils
- ::expand_metadata — ModelApi::Utils
- ::ext_attr — ModelApi::Utils
- ::ext_hash — ModelApi::Utils
- ::ext_query_attr — ModelApi::Utils
- ::ext_value — ModelApi::Utils
- ::extract_assoc_error_msgs — ModelApi::Utils
- ::extract_error_msgs — ModelApi::Utils
- ::filter_and_sort_params — ModelApi::OpenApiExtensions::Utils
- ::filter_description — ModelApi::OpenApiExtensions::Utils
- ::filtered_attrs — ModelApi::Utils
- ::filtered_ext_attrs — ModelApi::Utils
- ::filtered_links — ModelApi::Utils
- ::filtered_metadata — ModelApi::Utils
- ::find_class — ModelApi::Utils
- ::format_value — ModelApi::Utils
- ::get_attr_metadata — ModelApi::Utils
- ::get_collection_root_elem — ModelApi::Renderer
- ::get_format — ModelApi::Renderer
- ::get_object_root_elem — ModelApi::Renderer
- ::global_metadata — ModelApi
- ::handle_api_setter_exception — ModelApi::Utils
- ::hateoas_collection — ModelApi::Renderer
- ::hateoas_link_xml — ModelApi::Renderer
- ::hateoas_links — ModelApi::Renderer
- ::hateoas_object — ModelApi::Renderer
- ::hateoas_pagination_values_json — ModelApi::Renderer
- ::hateoas_pagination_values_xml — ModelApi::Renderer
- ::http_status — ModelApi::Utils
- ::http_status_and_status_code — ModelApi::Renderer
- ::http_status_code — ModelApi::Utils
- ::include_item? — ModelApi::Utils
- ::include_item_meets_admin_criteria? — ModelApi::Utils
- ::include_item_meets_incl_excl_criteria? — ModelApi::Utils
- ::include_item_meets_read_write_criteria? — ModelApi::Utils
- ::included — ModelApi::BaseController
- ::included — ModelApi::Model
- ::included — ModelApi::OpenApiExtensions
- ::internal_hash — ModelApi::Utils
- ::internal_value — ModelApi::Utils
- ::invoke_callback — ModelApi::Utils
- ::merge_metadata_overrides — ModelApi::Utils
- ::merge_superclass_metadata — ModelApi::HashMetadata
- ::merge_superclass_metadata — ModelApi::SimpleMetadata
- ::model_metadata — ModelApi::Utils
- ::model_name — ModelApi::Utils
- ::new — ModelApi::ApiContext
- ::new — ModelApi::BypassParseMiddleware
- ::new — ModelApi::NotFoundException
- ::new — ModelApi::SuppressLoginRedirectMiddleware
- ::not_found_response_body — ModelApi::Utils
- ::object_destroy — ModelApi::BaseController::Utils
- ::object_hateoas_links — ModelApi::Renderer
- ::open_api_attr_hash — ModelApi::OpenApiExtensions::Utils
- ::parse_request_body — ModelApi::Utils
- ::pretty_xml — ModelApi::Renderer
- ::process_collection_includes — ModelApi::Utils
- ::process_metadata — ModelApi::HashMetadata
- ::process_metadata — ModelApi::SimpleMetadata
- ::process_object_destroy — ModelApi::BaseController::Utils
- ::process_serializable_hash — ModelApi::Renderer
- ::process_updated_model_save — ModelApi::BaseController::Utils
- ::query_by_id_attrs — ModelApi::Utils
- ::remove_association_from_array — ModelApi::Utils
- ::remove_association_from_hash — ModelApi::Utils
- ::remove_excluded_associations — ModelApi::Utils
- ::render — ModelApi::Renderer
- ::render_json_response — ModelApi::Renderer
- ::render_xml_response — ModelApi::Renderer
- ::render_xml_response_body — ModelApi::Renderer
- ::render_xml_response_heading — ModelApi::Renderer
- ::required_attrs_from_validators — ModelApi::OpenApiExtensions::Utils
- ::resolve_assoc_obj — ModelApi::Utils
- ::resolve_one_to_many_assoc_obj — ModelApi::Utils
- ::resolve_one_to_one_assoc_obj — ModelApi::Utils
- ::response_successful? — ModelApi::Utils
- ::route_name — ModelApi::Utils
- ::save_obj — ModelApi::Utils
- ::serializable_object — ModelApi::Renderer
- ::serialize_associations — ModelApi::Renderer
- ::serialize_value — ModelApi::Renderer
- ::serialize_value_obj_attr — ModelApi::Renderer
- ::serialize_value_proc — ModelApi::Renderer
- ::serialize_values — ModelApi::Renderer
- ::set_api_attr — ModelApi::Utils
- ::set_context_attrs — ModelApi::Utils
- ::set_location_header — ModelApi::Renderer
- ::set_open_api_type_and_format — ModelApi::Utils
- ::transform_value — ModelApi::Utils
- ::translate_external_api_filter — ModelApi::Utils
- ::update_api_attr — ModelApi::Utils
- ::update_one_to_many_assoc — ModelApi::Utils
- ::update_one_to_many_assoc_obj — ModelApi::Utils
- ::update_one_to_one_assoc — ModelApi::Utils
- ::validate_operation — ModelApi::Utils
- ::validate_preserving_existing_errors — ModelApi::Utils
- ::xml_collection_elem_tags_with_attrs — ModelApi::Renderer
- ::xml_elem_tags_with_attrs — ModelApi::Renderer
- #add_collection_object_route — ModelApi::BaseController::InstanceMethods
- #add_hateoas_links_for_update — ModelApi::BaseController::InstanceMethods
- #add_hateoas_links_for_updated_object — ModelApi::BaseController::InstanceMethods
- #add_open_api_action — ModelApi::OpenApiExtensions::ClassMethods
- #add_pagination_links — ModelApi::BaseController::InstanceMethods
- #admin? — ModelApi::BaseController::InstanceMethods
- #admin_content? — ModelApi::BaseController::InstanceMethods
- #admin_user? — ModelApi::BaseController::InstanceMethods
- #api_attributes — ModelApi::Model::ClassMethods
- #api_context — ModelApi::BaseController::InstanceMethods
- #api_links — ModelApi::Model::ClassMethods
- #api_model — ModelApi::Model::ClassMethods
- #api_model_post_process_metadata — ModelApi::Model::ClassMethods
- #api_query — ModelApi::ApiContext
- #apply_context — ModelApi::ApiContext
- #apply_filter_param — ModelApi::ApiContext
- #bad_payload — ModelApi::BaseController::InstanceMethods
- #bad_request — ModelApi::BaseController::InstanceMethods
- #base_admin_api_options — ModelApi::BaseController::ClassMethods
- #base_admin_api_options — ModelApi::BaseController::InstanceMethods
- #base_api_options — ModelApi::BaseController::ClassMethods
- #base_api_options — ModelApi::BaseController::InstanceMethods
- #call — ModelApi::BypassParseMiddleware
- #call — ModelApi::SuppressLoginRedirectMiddleware
- #class_or_sti_subclass — ModelApi::ApiContext
- #collection_query — ModelApi::BaseController::InstanceMethods
- #common_headers — ModelApi::BaseController::InstanceMethods
- #common_object_query — ModelApi::ApiContext
- #common_object_query — ModelApi::BaseController::InstanceMethods
- #common_response_links — ModelApi::BaseController::InstanceMethods
- #create_and_render_object — ModelApi::BaseController::InstanceMethods
- #current_user — ModelApi::BaseController::InstanceMethods
- #do_create — ModelApi::BaseController::InstanceMethods
- #do_destroy — ModelApi::BaseController::InstanceMethods
- #do_update — ModelApi::BaseController::InstanceMethods
- #doorkeeper_unauthorized_render_options — ModelApi::BaseController::InstanceMethods
- #ensure_admin — ModelApi::BaseController::InstanceMethods
- #ensure_admin_if_admin_only — ModelApi::BaseController::InstanceMethods
- #filter_by_user — ModelApi::BaseController::InstanceMethods
- #filter_collection — ModelApi::ApiContext
- #filter_process_param — ModelApi::ApiContext
- #filter_process_param_array — ModelApi::ApiContext
- #filtered_by_foreign_key? — ModelApi::BaseController::InstanceMethods
- #find_filter_params — ModelApi::BaseController::InstanceMethods
- #find_sort_params — ModelApi::BaseController::InstanceMethods
- #format_value_for_query — ModelApi::ApiContext
- #get_operation — ModelApi::BaseController::InstanceMethods
- #get_updated_object — ModelApi::ApiContext
- #handle_api_exceptions — ModelApi::BaseController::InstanceMethods
- #id_info — ModelApi::BaseController::InstanceMethods
- #identify_format — ModelApi::BaseController::InstanceMethods
- #initialize_options — ModelApi::BaseController::InstanceMethods
- #model_class — ModelApi::ApiContext
- #model_class — ModelApi::BaseController::ClassMethods
- #model_class — ModelApi::BaseController::InstanceMethods
- #not_found — ModelApi::BaseController::InstanceMethods
- #not_implemented — ModelApi::BaseController::InstanceMethods
- #object_from_req_body — ModelApi::ApiContext
- #object_query — ModelApi::BaseController::InstanceMethods
- #paginate_collection — ModelApi::BaseController::InstanceMethods
- #params_array — ModelApi::ApiContext
- #parse_filter_operator — ModelApi::ApiContext
- #parse_request_body — ModelApi::BaseController::InstanceMethods
- #prepare_object_for_create — ModelApi::BaseController::InstanceMethods
- #prepare_object_for_update — ModelApi::BaseController::InstanceMethods
- #prepare_options — ModelApi::ApiContext
- #prepare_options — ModelApi::BaseController::InstanceMethods
- #process_filter_assoc_param — ModelApi::ApiContext
- #process_filter_attr_param — ModelApi::ApiContext
- #process_filter_params — ModelApi::ApiContext
- #process_json_sort_params — ModelApi::BaseController::InstanceMethods
- #process_simple_sort_params — ModelApi::BaseController::InstanceMethods
- #process_sort_param_assoc — ModelApi::ApiContext
- #process_sort_params — ModelApi::ApiContext
- #render_collection — ModelApi::BaseController::InstanceMethods
- #render_object — ModelApi::BaseController::InstanceMethods
- #resolve_key_to_column — ModelApi::ApiContext
- #resource_parent_id — ModelApi::BaseController::InstanceMethods
- #save_and_render_object — ModelApi::BaseController::InstanceMethods
- #simple_error — ModelApi::BaseController::InstanceMethods
- #sort_collection — ModelApi::ApiContext
- #unauthorized — ModelApi::BaseController::InstanceMethods
- #unhandled_exception — ModelApi::BaseController::InstanceMethods
- #update_and_render_object — ModelApi::BaseController::InstanceMethods
- #user_query — ModelApi::ApiContext
- #validate_read_operation — ModelApi::ApiContext
- #verify_update_request_body — ModelApi::ApiContext