class PlaceOS::Core::Api::Root
- PlaceOS::Core::Api::Root
- PlaceOS::Core::Api::Application
- ActionController::Base
- Reference
- Object
Defined in:
api/root.crConstant Summary
-
PARSER_LIST =
["application/json"]
-
RESPONDER_LIST =
["application/json"]
Class Method Summary
-
.base_route
Helper for obtaining base route
-
.healthcheck(hash_parts : Hash(String | Symbol, Nil | Bool | Int32 | Int64 | Float32 | Float64 | String | Symbol) | Nil = nil, **tuple_parts)
Helper methods for performing redirect_to calls
- .module_manager : ModuleManager
- .ready?
- .resource_manager : ResourceManager
Instance Method Summary
-
#base_route(*args, **options)
Helper for obtaining base route
-
#base_route(*args, **options, &)
Helper for obtaining base route
-
#healthcheck : Nil
route for checking the health of the service
- #not_ready_error(_error) : Nil
-
#ready : Nil
has the service finished loading
-
#version : PlaceOS::Model::Version
returns the build details of the service
Instance methods inherited from class PlaceOS::Core::Api::Application
bad_media_type(error) : ContentError
bad_media_type,
common_error(error) : CommonError
common_error,
invalid_param(error) : ParameterError
invalid_param,
request_id : String
request_id
Class Method Detail
def self.healthcheck(hash_parts : Hash(String | Symbol, Nil | Bool | Int32 | Int64 | Float32 | Float64 | String | Symbol) | Nil = nil, **tuple_parts)
#
Helper methods for performing redirect_to calls