view release on metacpan or  search on metacpan

example/lib/Example/API/System.pm  view on Meta::CPAN

=head1 NAME

System - Interface to basic system function.

=head1 SYNOPSIS

    my $system = System->new();

    my $pong = $system->rpc_ping();
    my $version = $system->rpc_version();
    my $methods = $system->rpc_list_methods();

=head1 DESCRIPTION

=head2 rpc_ping()

=for jsonrpc ping rpc_ping /system

=for restrpc ping rpc_ping /system

=for xmlrpc ping rpc_ping  /system

Returns the string 'pong'.

=head2 rpc_version()

=for jsonrpc version rpc_version /system

=for restrpc version rpc_version /system

=for xmlrpc version rpc_version  /system

Returns a struct:

    {software_version => 'X.YZ'}

=head2 rpc_status

=for jsonrpc status rpc_status /system

=for restrpc status rpc_status /system

=for xmlrpc status rpc_status  /system

Returns:

    {
        app_version => ...,
        app_name    => ...,
        active_since => ...,
    }

=head2 rpc_list_methods()

=for jsonrpc list_methods rpc_list_methods /system

=for restrpc list_methods rpc_list_methods /system

=for xmlrpc list_methods rpc_list_methods  /system

Returns a struct for all protocols with all endpoints and functions for that endpoint.

=head1 COPYRIGHT

(c) MMXVII - Abe Timmerman <abeltje@cpan.org>

=cut