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 df58115..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,7 +33,13 @@ 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' } },
@@ -47,9 +57,9 @@ Calls L<Catalyst::Controller::DBIC::API/update_or_create>.
 
 =cut
 
-sub update_or_create_objects : POST PUT Chained('objects_no_id') PathPart('') 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);
 }
 
@@ -64,9 +74,9 @@ Calls L<Catalyst::Controller::DBIC::API/delete>.
 
 =cut
 
-sub delete_many_objects : DELETE Chained('objects_no_id') PathPart('') Args(0)
-{
-       my ( $self, $c ) = @_;
+sub delete_many_objects : DELETE Chained('objects_no_id') PathPart('')
+    Args(0) {
+    my ( $self, $c ) = @_;
     $self->delete($c);
 }
 
@@ -81,9 +91,8 @@ Calls L<Catalyst::Controller::DBIC::API/list>.
 
 =cut
 
-sub list_objects : GET Chained('objects_no_id') PathPart('') Args(0)
-{
-       my ( $self, $c ) = @_;
+sub list_objects : GET Chained('objects_no_id') PathPart('') Args(0) {
+    my ( $self, $c ) = @_;
     $self->list($c);
 }
 
@@ -98,9 +107,9 @@ Calls L<Catalyst::Controller::DBIC::API/update_or_create>.
 
 =cut
 
-sub update_or_create_one_object : POST PUT Chained('object_with_id') PathPart('') 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);
 }
 
@@ -117,7 +126,7 @@ Calls L<Catalyst::Controller::DBIC::API/delete>.
 
 sub delete_one_object : DELETE Chained('object_with_id') PathPart('') Args(0)
 {
-       my ( $self, $c ) = @_;
+    my ( $self, $c ) = @_;
     $self->delete($c);
 }
 
@@ -132,9 +141,8 @@ Calls L<Catalyst::Controller::DBIC::API/item>.
 
 =cut
 
-sub list_one_object : GET Chained('object_with_id') PathPart('') Args(0)
-{
-       my ( $self, $c ) = @_;
+sub list_one_object : GET Chained('object_with_id') PathPart('') Args(0) {
+    my ( $self, $c ) = @_;
     $self->item($c);
 }