whitespace clean up

[catagits/Catalyst-Controller-DBIC-API.git] / lib / Catalyst / Controller / DBIC / API / REST.pm

diff --git a/lib/Catalyst/Controller/DBIC/API/REST.pm b/lib/Catalyst/Controller/DBIC/API/REST.pm
index a1c47e1..04fe041 100644 (file)
--- a/lib/Catalyst/Controller/DBIC/API/REST.pm
+++ b/lib/Catalyst/Controller/DBIC/API/REST.pm
@@ -14,12 +14,12 @@ __PACKAGE__->config(
 
 =head1 DESCRIPTION
 
-Provides a REST style API interface to the functionality described in L<Catalyst::Controller::DBIC::API>. 
+Provides a REST style API interface to the functionality described in L<Catalyst::Controller::DBIC::API>.
 
 By default provides the following endpoints:
 
-  $base (accepts PUT and GET)
-  $base/[identifier] (accepts POST and DELETE)
+  $base (operates on lists of objects and accepts GET, PUT, POST and DELETE)
+  $base/[identifier] (operates on a single object and accepts GET, PUT, POST and DELETE)
 
 Where $base is the URI described by L</setup>, the chain root of the controller, and the request type will determine the L<Catalyst::Controller::DBIC::API> method to forward.
 
@@ -32,74 +32,88 @@ CaptureArgs: 0
 As described in L<Catalyst::Controller::DBIC::API/setup>, this action is the chain root of the controller but has no pathpart or chain parent defined by default, so these must be defined in order for the controller to function. The neatest way is normally to define these using the controller's config.
 
   __PACKAGE__->config
-    ( action => { setup => { PathPart => 'track', Chained => '/api/rest/rest_base' } }, 
+    ( action => { setup => { PathPart => 'track', Chained => '/api/rest/rest_base' } },
        ...
   );
 
-=method_protected base
+=method_protected no_id
 
-Chained: L</setup>
+Chained: L</objects_no_id>
 PathPart: none
 CaptureArgs: 0
 
-Forwards to list level methods described in L<Catalyst::Controller::DBIC::API> as follows:
+Calls list level methods described in L<Catalyst::Controller::DBIC::API> as follows:
 
-DELETE: forwards to L<Catalyst::Controller::DBIC::API/object> then L<Catalyst::Controller::DBIC::API/delete>
-POST/PUT: forwards to L<Catalyst::Controller::DBIC::API/object> then L<Catalyst::Controller::DBIC::API/update_or_create>
+DELETE: L<Catalyst::Controller::DBIC::API/delete>
+POST/PUT: L<Catalyst::Controller::DBIC::API/update_or_create>
 GET: forwards to L<Catalyst::Controller::DBIC::API/list>
 
 =cut
 
-sub no_id : Chained('object_no_id') PathPart('') ActionClass('REST') :CaptureArgs(0) {}
+sub no_id : Chained('objects_no_id') PathPart('') ActionClass('REST') :Args(0) {}
 
 sub no_id_PUT
 {
        my ( $self, $c ) = @_;
-    $c->forward('update_or_create');
+    $self->update_or_create($c);
 }
 
 sub no_id_POST
 {
        my ( $self, $c ) = @_;
-    $c->forward('update_or_create');
+    $self->update_or_create($c);
 }
 
 sub no_id_DELETE
 {
        my ( $self, $c ) = @_;
-    $c->forward('delete');
+    $self->delete($c);
 }
 
 sub no_id_GET
 {
        my ( $self, $c ) = @_;
-       $c->forward('list');
+    $self->list($c);
 }
 
-sub with_id :Chained('object_with_id') :PathPart('') :ActionClass('REST') :CaptureArgs(0) {}
+=method_protected with_id
+
+Chained: L</object_with_id>
+PathPart: none
+CaptureArgs: 0
+
+Forwards to list level methods described in L<Catalyst::Controller::DBIC::API> as follows:
+
+DELETE: L<Catalyst::Controller::DBIC::API/delete>
+POST/PUT: L<Catalyst::Controller::DBIC::API/update_or_create>
+GET: forwards to L<Catalyst::Controller::DBIC::API/item>
+
+=cut
+
+sub with_id :Chained('object_with_id') :PathPart('') :ActionClass('REST') :Args(0) {}
 
 sub with_id_PUT
 {
        my ( $self, $c ) = @_;
-    $c->forward('update_or_create');
+    $self->update_or_create($c);
 }
 
 sub with_id_POST
 {
        my ( $self, $c ) = @_;
-    $c->forward('update_or_create');
+    $self->update_or_create($c);
 }
 
 sub with_id_DELETE
 {
        my ( $self, $c ) = @_;
-    $c->forward('delete');
+    $self->delete($c);
 }
 
 sub with_id_GET
 {
        my ( $self, $c ) = @_;
-       $c->forward('item');
+    $self->item($c);
 }
 
 1;