This is the toppest of the top-level targets or, if you wish, the "root target". If the base UID of your App::Dochazka::REST instance is http://dochazka.site:5000 and your username/password are "demo/demo", then this resource is triggered by either of the URLs:

    http://demo:demo@dochazka.site:5000
    http://demo:demo@dochazka.site:5000/

In terms of behavior, the "" resource is identical to "help" -- it returns the set of top-level resources available to the user. EOH }, 'activity' => { target => { GET => '_get_default', POST => '_post_default', PUT => '_put_default', DELETE => '_delete_default', }, target_module => 'App::Dochazka::REST::Dispatch::Activity', acl_profile => 'passerby', cli => 'employee', description => 'Display available employee resources for given HTTP method', documentation => <<'EOH', =pod

Lists activity resources available to the logged-in employee. EOH }, 'bugreport' => { target => { GET => '_get_bugreport', }, target_module => 'App::Dochazka::REST::Dispatch', acl_profile => 'passerby', cli => 'bugreport', description => 'Display the address for reporting bugs in App::Dochazka::REST', documentation => <<'EOH', =pod

Returns a "report_bugs_to" key in the payload, containing the address to report bugs to. EOH }, 'docu' => { target => { POST => '_docu', }, target_module => 'App::Dochazka::REST::Dispatch', acl_profile => 'passerby', cli => 'docu $RESOURCE', description => 'Display on-line Plain Old Documentation (POD) on the resource whose name is provided in the request body (in double-quotes)', documentation => <<'EOH', =pod

This resource provides access to App::Dochazka::REST on-line help documentation. It expects to find a resource (e.g. "employee/eid/:eid" including the double-quotes, and without leading or trailing slash) in the request body. It returns a string containing the POD source code of the resource documentation. EOH }, 'docu/html' => { target => { POST => '_docu_html', }, target_module => 'App::Dochazka::REST::Dispatch', acl_profile => 'passerby', cli => 'docu html $RESOURCE', description => 'Display on-line HTML documentation on the resource whose name is provided in the request body (in double-quotes)', documentation => <<'EOH', =pod

This resource provides access to App::Dochazka::REST on-line help documentation. It expects to find a resource (e.g. "employee/eid/:eid" including the double-quotes, and without leading or trailing slash) in the request body. It returns HTML source code of the resource documentation. EOH }, 'echo' => { target => { POST => '_echo', }, target_module => 'App::Dochazka::REST::Dispatch', acl_profile => 'admin', cli => 'echo [$JSON]', description => 'Echo the request body', documentation => <<'EOH', =pod

This resource simply takes whatever content body was sent and echoes it back in the response body. EOH }, 'employee' => { target => { GET => '_get_default', POST => '_post_default', PUT => '_put_default', DELETE => '_delete_default', }, target_module => 'App::Dochazka::REST::Dispatch::Employee', acl_profile => 'passerby', cli => 'employee', description => 'Display available employee resources for given HTTP method', documentation => <<'EOH', =pod

Lists employee resources available to the logged-in employee. EOH }, 'forbidden' => { target => { GET => '_forbidden', POST => '_forbidden', PUT => '_forbidden', DELETE => '_forbidden', }, target_module => 'App::Dochazka::REST::Dispatch', cli => 'forbidden', description => 'A resource that is forbidden to all', documentation => <<'EOH', =pod

This resource always returns 405 Method Not Allowed, no matter what. EOH }, 'help' => { target => { GET => '_get_default', POST => '_post_default', PUT => '_put_default', DELETE => '_delete_default', }, target_module => 'App::Dochazka::REST::Dispatch', acl_profile => 'passerby', cli => 'help', description => 'Display available top-level resources for given HTTP method', documentation => <<'EOH', =pod

The purpose of the "help" resource is to give the user an overview of all the top-level resources available to her, with regard to her privlevel and the HTTP method being used.

• If the HTTP method is GET, only resources with GET targets will be displayed (same applies to other HTTP methods)

• If the user's privlevel is 'inactive', only resources whose ACL profile is 'inactive' or lower (i.e., 'inactive' or 'passerby') will be displayed

The information provided is sent as a JSON string in the HTTP response body, and includes the resource's name, full URI, ACL profile, and brief description, as well as a link to the App::Dochazka::REST on-line documentation. EOH }, 'metaparam/:param' => { target => { GET => '_get_param', PUT => '_put_param', DELETE => 'not_implemented', }, target_module => 'App::Dochazka::REST::Dispatch', acl_profile => 'admin', cli => 'metaparam $PARAM [$JSON]', description => 'Display (GET) or set (PUT) meta configuration parameter', documentation => <<'EOH', =pod

• GET

  Assuming that the argument :param is the name of an existing meta parameter, displays the parameter's value and metadata (type, name, file and line number where it was defined). This resource is available only to users with admin privileges.

• PUT

  Regardless of whether :param is an existing metaparam or not, set that parameter's value to the (entire) request body. If the request body is "123", then the parameter will be set to that value. If it is { "value" : 123 }, then it will be set to that structure.

• DELETE

  If the argument is an existing metaparam, delete that parameter (NOT IMPLEMENTED)

Regardless of anything, returns a NOTICE status with status code DISPATCH_RESOURCE_NOT_IMPLEMENTED EOH }, 'priv' => { target => { GET => '_get_default', POST => '_post_default', PUT => '_put_default', DELETE => '_delete_default', }, target_module => 'App::Dochazka::REST::Dispatch::Priv', acl_profile => 'passerby', cli => 'priv', description => 'Display available priv resources for given HTTP method', documentation => <<'EOH', =pod

Lists priv resources available to the logged-in employee. EOH }, 'schedule' => { target => { GET => '_get_default', POST => '_post_default', PUT => '_put_default', DELETE => '_delete_default', }, target_module => 'App::Dochazka::REST::Dispatch::Schedule', acl_profile => 'passerby', cli => 'schedule', description => 'Display available schedule resources for given HTTP method', documentation => <<'EOH', =pod

Lists schedule resources available to the logged-in employee. EOH }, 'session' => { target => { GET => '_get_session', }, target_module => 'App::Dochazka::REST::Dispatch', acl_profile => 'passerby', cli => 'session', description => 'Display the current session', documentation => <<'EOH', =pod

Dumps the current session data (server-side). EOH }, 'siteparam/:param' => { target => { GET => '_get_param', }, target_module => 'App::Dochazka::REST::Dispatch', acl_profile => 'admin', cli => 'siteparam $PARAM', description => 'Display site configuration parameter', documentation => <<'EOH', =pod

Assuming that the argument ":param" is the name of an existing site parameter, displays the parameter's value and metadata (type, name, file and line number where it was defined). EOH }, 'version' => { target => { GET => '_get_version', }, target_module => 'App::Dochazka::REST::Dispatch', acl_profile => 'passerby', cli => 'version', description => 'Display App::Dochazka::REST version', documentation => <<'EOH', =pod

Shows the App::Dochazka::REST version running on the present instance. EOH }, 'whoami' => { target => { GET => '_get_current', }, target_module => 'App::Dochazka::REST::Dispatch::Employee', acl_profile => 'passerby', cli => 'whoami', description => 'Display the current employee (i.e. the one we authenticated with)', documentation => <<'EOH', =pod

Displays the profile of the currently logged-in employee (same as "employee/current") EOH },

});

1;