view release on metacpan or  search on metacpan

lib/App/Dochazka/REST/Docs/Resources.pm  view on Meta::CPAN

=item * GET

Retrieves an activity object by its code.

=item * PUT

Inserts new or updates existing activity object whose code is specified by the
':code' URI parameter.  The fields to be updated and their new values should be
sent in the request body, e.g., like this:

    { "long_desc" : "new description", "disabled" : "f" }

=item * DELETE

Deletes an activity object by its code whose code is specified by the ':code'
URI parameter.  This will work only if nothing in the database refers to this
activity.

=back


=back

=head2 C<< bugreport >>


=over

Allowed methods: GET

Returns a JSON structure containing instructions for reporting bugs.


=back

=head2 C<< component >>


=over

Allowed methods: CONNECT, DELETE, GET, OPTIONS, POST, PUT, TRACE

Parent for component resources


=back

=head2 C<< component/all >>


=over

Allowed methods: GET

Retrieves all component objects in the database.


=back

=head2 C<< component/cid >>


=over

Allowed methods: POST

Enables existing component objects to be updated by sending a POST request to
the REST server. Along with the properties to be modified, the request body
must include an 'cid' property, the value of which specifies the cid to be
updated.


=back

=head2 C<< component/cid/:cid >>


=over

Allowed methods: DELETE, GET, PUT

This resource allows the user to GET, PUT, or DELETE an component object by its
cid.

=over

=item * GET

Retrieves an component object by its cid.

=item * PUT

Updates the component object whose cid is specified by the ':cid' URI parameter.
The fields to be updated and their new values should be sent in the request
body, e.g., like this:

    { "path" : "new/path", "source" : "new source", "acl" : "inactive" }

=item * DELETE

Deletes the component object whose cid is specified by the ':cid' URI parameter.
This will work only if nothing in the database refers to this component.

=back


=back

=head2 C<< component/path >>


=over

Allowed methods: POST

This resource enables existing component objects to be updated, and new
component objects to be inserted, by sending a POST request to the REST server.
Along with the properties to be modified/inserted, the request body must
include an 'path' property, the value of which specifies the component to be
updated.  


=back

=head2 C<< configinfo >>


=over

Allowed methods: GET

Returns a list of directories that were scanned for configuration files.


=back

=head2 C<< dbstatus >>


=over

Allowed methods: GET

This resource checks the employee's database connection and reports on its status.
The result - either "UP" or "DOWN" - will be encapsulated in a payload like this:

    { "dbstatus" : "UP" }

Each employee gets her own database connection when she logs in to Dochazka.
Calling this resource causes the server to execute a 'ping' on the connection.
If the ping test fails, the server will attempt to open a new connection. Only
if this, too, fails will "DOWN" be returned.


=back

=head2 C<< docu >>


=over