class PlaceOS::FrontendLoader::Api::Root

• PlaceOS::FrontendLoader::Api::Root
• PlaceOS::FrontendLoader::Api::Base
• ActionController::Base
• Reference
• Object

Defined in:

placeos-frontend-loader/api/root.cr

Constant Summary

AFTER = {} of Nil => Nil

AROUND = {} of Nil => Nil

BEFORE = {set_request_id => {nil, nil}} of Nil => Nil

FORCE = {} of Nil => Nil

LOCAL_AFTER = {} of Nil => Nil

function => options

LOCAL_AROUND = {} of Nil => Nil

function => options

LOCAL_BEFORE = {} of Nil => Nil

function => options

LOCAL_FORCE = {} of Nil => Nil

function => options

LOCAL_RESCUE = {} of Nil => Nil

function => options

LOCAL_ROUTES = {root => {"get", "/", nil, do head(:ok) end, false}, startup => {"get", "/startup", nil, do if PlaceOS::FrontendLoader::Loader.instance.startup_finished? head(:ok) else head(:service_unavailable) end end, false}, version => {"get", "/version", nil, do render(:ok, json: PlaceOS::Model::Version.new(version: VERSION, build_time: BUILD_TIME, commit: BUILD_COMMIT, service: APP_NAME)) end, false}} of Nil => Nil

function => options

LOCAL_SKIP = {} of Nil => Nil

function => options

NAMESPACE = ["/api/frontend-loader/v1"]

default namespace based on class

RESCUE = {} of Nil => Nil

ROUTES = {root => {"get", "/", nil, do head(:ok) end, false}, startup => {"get", "/startup", nil, do if PlaceOS::FrontendLoader::Loader.instance.startup_finished? head(:ok) else head(:service_unavailable) end end, false}, version => {"get", "/version", nil, do render(:ok, json: PlaceOS::Model::Version.new(version: VERSION, build_time: BUILD_TIME, commit: BUILD_COMMIT, service: APP_NAME)) end, false}} of Nil => Nil

SKIP = {} of Nil => Nil

Class Method Summary

• .__init_routes__(router)

  Routes call the functions generated above

• .__route_list__

  Create draw_routes function

• .base_route

  Helper for obtaining base route

• .context(method : String, route : String, route_params : Hash(String, String) | Nil = nil, headers : Hash(String, String) | Nil = nil, body : String | Bytes | IO | Nil = nil, &)
• .get__api_frontend_loader_v1_(context, head_request)

  Generate functions for each route

• .get__api_frontend_loader_v1_startup(context, head_request)

  Create draw_routes function

• .get__api_frontend_loader_v1_version(context, head_request)

  Create draw_routes function

• .root(hash_parts : Hash(String | Symbol, Nil | Bool | Int32 | Int64 | Float32 | Float64 | String | Symbol) | Nil = nil, **tuple_parts)

  Helper methods for performing redirect_to calls

• .startup(hash_parts : Hash(String | Symbol, Nil | Bool | Int32 | Int64 | Float32 | Float64 | String | Symbol) | Nil = nil, **tuple_parts)

  Create draw_routes function

• .version(hash_parts : Hash(String | Symbol, Nil | Bool | Int32 | Int64 | Float32 | Float64 | String | Symbol) | Nil = nil, **tuple_parts)

  Create draw_routes function

Instance Method Summary

• #base_route(*args, **options)

  Helper for obtaining base route

• #base_route(*args, **options, &)

  Helper for obtaining base route

• #root

  Create functions for named routes Skip the CRUD verbs, as they are already defined Annotations defined via the annotations argument are applied here

• #startup
• #version

Macro Summary

• __inherit_after_filters__
• __inherit_around_filters__
• __inherit_before_filters__
• __inherit_force_filters__
• __inherit_rescue_filters__
• __inherit_routes_filters__
• __inherit_skip_filters__

Class Method Detail

Instance Method Detail

Macro Detail