documentation improvements

[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 2414a9c..4b49562 100644 (file)
--- a/lib/Catalyst/Controller/DBIC/API/REST.pm
+++ b/lib/Catalyst/Controller/DBIC/API/REST.pm
@@ -10,18 +10,22 @@ __PACKAGE__->config(
     'map'       => {
         'application/x-www-form-urlencoded' => 'JSON',
         'application/json'                  => 'JSON',
-    });
+    }
+);
 
 =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 (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.
+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.
 
 =method_protected setup
 
@@ -29,74 +33,116 @@ Chained: override
 PathPart: override
 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.
+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.
+
+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' } },
        ...
   );
 
-=method_protected no_id
+=method_protected update_or_create_objects
 
 Chained: L</objects_no_id>
 PathPart: none
-CaptureArgs: 0
+Args: 0
+Method: POST/PUT
 
-Calls 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/list>
+Calls L<Catalyst::Controller::DBIC::API/update_or_create>. 
 
 =cut
 
-sub update_or_create_objects : Chained('objects_no_id') PathPart('') Does('MatchRequestMethod') Method('POST') Method('PUT') Args(0)
-{
-       my ( $self, $c ) = @_;
+sub update_or_create_objects : POST PUT Chained('objects_no_id') PathPart('')
+    Args(0) {
+    my ( $self, $c ) = @_;
     $self->update_or_create($c);
 }
 
-sub delete_many_objects : Chained('objects_no_id') PathPart('') Does('MatchRequestMethod') Method('DELETE') Args(0)
-{
-       my ( $self, $c ) = @_;
+=method_protected delete_many_objects
+
+Chained: L</objects_no_id>
+PathPart: none
+Args: 0
+Method: DELETE
+
+Calls L<Catalyst::Controller::DBIC::API/delete>. 
+
+=cut
+
+sub delete_many_objects : DELETE Chained('objects_no_id') PathPart('')
+    Args(0) {
+    my ( $self, $c ) = @_;
     $self->delete($c);
 }
 
-sub list_objects : Chained('objects_no_id') PathPart('') Does('MatchRequestMethod') Method('GET') Args(0)
-{
-       my ( $self, $c ) = @_;
+=method_protected list_objects
+
+Chained: L</objects_no_id>
+PathPart: none
+Args: 0
+Method: GET
+
+Calls L<Catalyst::Controller::DBIC::API/list>. 
+
+=cut
+
+sub list_objects : GET Chained('objects_no_id') PathPart('') Args(0) {
+    my ( $self, $c ) = @_;
     $self->list($c);
 }
 
-=method_protected with_id
+=method_protected update_or_create_one_object
 
 Chained: L</object_with_id>
 PathPart: none
-CaptureArgs: 0
-
-Forwards to list level methods described in L<Catalyst::Controller::DBIC::API> as follows:
+Args: 0
+Method: POST/PUT
 
-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>
+Calls L<Catalyst::Controller::DBIC::API/update_or_create>.
 
 =cut
 
-sub update_or_create_one_object : Chained('object_with_id') PathPart('') Does('MatchRequestMethod') Method('POST') Method('PUT') Args(0)
-{
-       my ( $self, $c ) = @_;
+sub update_or_create_one_object : POST PUT Chained('object_with_id')
+    PathPart('') Args(0) {
+    my ( $self, $c ) = @_;
     $self->update_or_create($c);
 }
 
-sub delete_one_object : Chained('object_with_id') PathPart('') Does('MatchRequestMethod') Method('DELETE') Args(0)
+=method_protected delete_one_object
+
+Chained: L</object_with_id>
+PathPart: none
+Args: 0
+Method: DELETE
+
+Calls L<Catalyst::Controller::DBIC::API/delete>.
+
+=cut
+
+sub delete_one_object : DELETE Chained('object_with_id') PathPart('') Args(0)
 {
-       my ( $self, $c ) = @_;
+    my ( $self, $c ) = @_;
     $self->delete($c);
 }
 
-sub list_one_object : Chained('object_with_id') PathPart('') Does('MatchRequestMethod') Method('GET') Args(0)
-{
-       my ( $self, $c ) = @_;
+=method_protected list_one_object
+
+Chained: L</object_with_id>
+PathPart: none
+Args: 0
+Method: GET
+
+Calls L<Catalyst::Controller::DBIC::API/item>.
+
+=cut
+
+sub list_one_object : GET Chained('object_with_id') PathPart('') Args(0) {
+    my ( $self, $c ) = @_;
     $self->item($c);
 }