abstract class ApiAction

Overview

Include modules and add methods that are for all API requests

Included Modules

Direct Known Subclasses

Defined in:

actions/api_action.cr

Constant Summary

AFTER_PIPES = [] of Symbol

Include modules and add methods that are for all API requests

BEFORE_PIPES = [verify_accepted_format, require_auth_token] of Symbol

Include modules and add methods that are for all API requests

EXPOSURES = [] of Symbol

Include modules and add methods that are for all API requests

PARAM_DECLARATIONS = [] of Crystal::Macros::TypeDeclaration

Include modules and add methods that are for all API requests

ROUTE_SETTINGS = {prefix: ""}

Include modules and add methods that are for all API requests

SKIPPED_PIPES = [] of Symbol

Include modules and add methods that are for all API requests

Class Method Summary

Instance Method Summary

Macros inherited from module Api::Custom::ManyToMany

many_to_many(param_key, related_ids_key, id, id_column, related_id_column, related_id_type, association_query, association_operation) many_to_many, many_to_many_for_bulk(related_ids_key, id, id_column, related_id_column, related_id_type, association_query, association_operation) many_to_many_for_bulk

Instance methods inherited from module Api::Custom::Bulk

validate_params_for_bulk(params) validate_params_for_bulk

Macros inherited from module Api::Custom::Bulk

bulk_update(query, update_data, *allowed_columns) bulk_update

Macros inherited from module Api::Custom::FilterMacros

bool_chain_filters(query, *columns) bool_chain_filters, bool_chain_filters_for_relation(query, relation_name, *columns) bool_chain_filters_for_relation, datetime_chain_filters(query, *columns) datetime_chain_filters, datetime_chain_filters_for_relation(query, relation_name, *columns) datetime_chain_filters_for_relation, geo_point_chain_filters(query, *columns) geo_point_chain_filters, geo_point_chain_filters_for_relation(query, relation_name, *columns) geo_point_chain_filters_for_relation, geo_point_distance_filters(query, *columns) geo_point_distance_filters, geo_point_distance_filters_for_relation(query, relation_name, *columns) geo_point_distance_filters_for_relation, number_chain_filters(query, *columns) number_chain_filters, number_chain_filters_for_relation(query, relation_name, *columns) number_chain_filters_for_relation, ordering_single_column_query(query, ordering_sym, default_column, *allowed_columns) ordering_single_column_query, ordering_single_column_query_for_relation(query, relation_name, ordering_sym, default_column, *allowed_columns) ordering_single_column_query_for_relation, string_chain_filters(query, *columns) string_chain_filters, string_chain_filters_for_relation(query, relation_name, *columns) string_chain_filters_for_relation

Instance methods inherited from module Api::Auth::Auth0Helpers

current_user? : AuthUser | Nil current_user?, current_user__tuple_cached? : Tuple(AuthUser | Nil) current_user__tuple_cached?, current_user__uncached? : AuthUser | Nil current_user__uncached?

Class Method Detail

def self._accepted_formats #

Instance Method Detail

def paginater_per_page : Int32 #

[View source]