class PlaceOS::Core::Api::Root

Defined in:

api/root.cr

Constant Summary

PARSER_LIST = ["application/json"]
RESPONDER_LIST = ["application/json"]

Class Method Summary

Instance Method Summary

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.base_route #

Helper for obtaining base route


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


def self.module_manager : ModuleManager #

[View source]
def self.ready? #

[View source]
def self.resource_manager : ResourceManager #

[View source]

Instance Method Detail

def base_route(*args, **options) #

Helper for obtaining base route


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

Helper for obtaining base route


def healthcheck : Nil #

route for checking the health of the service


[View source]
def not_ready_error(_error) : Nil #

[View source]
def ready : Nil #

has the service finished loading


[View source]
def version : PlaceOS::Model::Version #

returns the build details of the service


[View source]