module Extension::ClassMethods

Public Instance Methods

fastapi() click to toggle source
# File lib/fastapi/extension.rb, line 68
def fastapi
  FastAPI::Wrapper.new(self)
end
fastapi_custom_order() click to toggle source
# File lib/fastapi/extension.rb, line 48
def fastapi_custom_order
  @fastapi_custom_order || {}
end
fastapi_default_filters(filters) click to toggle source

Used to set any default filters for the top level fastapi response

@param filters [Hash] a hash containing the intended filters @return [Hash] the same filters hash

# File lib/fastapi/extension.rb, line 36
def fastapi_default_filters(filters)
  @fastapi_filters = filters
end
fastapi_define_order(keys) click to toggle source

Define custom ORDER BY strings for specific keys

@param keys [Hash] a hash containing the keys: strings for order filters @return [Hash] the same keys hash

# File lib/fastapi/extension.rb, line 44
def fastapi_define_order(keys)
  @fastapi_custom_order = keys
end
fastapi_fields() click to toggle source
# File lib/fastapi/extension.rb, line 52
def fastapi_fields
  @fastapi_fields || [:id]
end
fastapi_fields_sub() click to toggle source
# File lib/fastapi/extension.rb, line 56
def fastapi_fields_sub
  @fastapi_fields_sub || [:id]
end
fastapi_filters() click to toggle source
# File lib/fastapi/extension.rb, line 64
def fastapi_filters
  @fastapi_filters || {}
end
fastapi_filters_whitelist() click to toggle source
# File lib/fastapi/extension.rb, line 60
def fastapi_filters_whitelist
  @fastapi_filters_whitelist || @fastapi_fields || [:id]
end
fastapi_safe_fields(fields) click to toggle source

Set safe fields for FastAPIInstance.safe_filter These are the fields that can be actively filtered by

@param fields [Array] a list of fields in the form of symbols @return [Array] the same array of fields

# File lib/fastapi/extension.rb, line 28
def fastapi_safe_fields(fields)
  @fastapi_filters_whitelist = fields
end
fastapi_standard_interface(fields) click to toggle source

Used to set the standard interface for the top level of a fastapi response

@param fields [Array] a list of fields in the form of symbols @return [Array] the same array of fields

# File lib/fastapi/extension.rb, line 11
def fastapi_standard_interface(fields)
  @fastapi_fields = fields
end
fastapi_standard_interface_nested(fields) click to toggle source

Used to set the standard interface for the second level of a fastapi response (nested)

@param fields [Array] a list of fields in the form of symbols @return [Array] the same array of fields

# File lib/fastapi/extension.rb, line 19
def fastapi_standard_interface_nested(fields)
  @fastapi_fields_sub = fields
end