/ 
Dezi-0.004003
River stage one • 4 direct dependents • 4 total dependents
/ Dezi::Server::About

NAME

Dezi::Server::About - Dezi server introspection metadata

SYNOPSIS

my $resp = Dezi::Server::About->new(
   require_root    => 1,   # request must be for /
   server          => $server,
   request         => $plack_request,
   search_path     => $search_path,
   index_path      => $index_path,
   commit_path     => $commit_path,
   rollback_path   => $rollback_path,
   config          => $dezi_config,
   version         => $VERSION,
);

DESCRIPTION

Dezi::Server::About allows a Dezi::Server to introspect, and returns an object describing the server.

The About response is what you get, in JSON format, when you issue a GET request to the Dezi root path. It allows client applications to find out details about the server, including what methods are available and which URI paths should be used for searching and indexing.

This class is used internally by Dezi::Server.

METHODS

new( %args )

See the SYNOPSIS for a description of %args.

Returns an array ref suitable for use as a Plack::Response.

AUTHOR

Peter Karman, <karman at cpan.org>

BUGS

Please report any bugs or feature requests to bug-dezi at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dezi. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Dezi::Server::About

You can also look for information at:

COPYRIGHT & LICENSE

Copyright 2012-2018 Peter Karman.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

SEE ALSO

Search::OpenSearch, SWISH::3, Dezi::App, Plack, Lucy