documentation improvements

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

diff --git a/lib/Catalyst/Controller/DBIC/API/RPC.pm b/lib/Catalyst/Controller/DBIC/API/RPC.pm
index e9ff286..adfb7ea 100644 (file)
--- a/lib/Catalyst/Controller/DBIC/API/RPC.pm
+++ b/lib/Catalyst/Controller/DBIC/API/RPC.pm
@@ -1,11 +1,12 @@
 package Catalyst::Controller::DBIC::API::RPC;
+
 #ABSTRACT: Provides an RPC interface to DBIx::Class
 
 use Moose;
 BEGIN { extends 'Catalyst::Controller::DBIC::API'; }
 
 __PACKAGE__->config(
-    'action'    => { object_with_id => { PathPart => 'id' } }, 
+    'action'    => { object_with_id => { PathPart => 'id' } },
     'default'   => 'application/json',
     'stash_key' => 'response',
     'map'       => {
@@ -16,7 +17,8 @@ __PACKAGE__->config(
 
 =head1 DESCRIPTION
 
-Provides an RPC API interface to the functionality described in L<Catalyst::Controller::DBIC::API>. 
+Provides an RPC API interface to the functionality described in
+L<Catalyst::Controller::DBIC::API>.
 
 By default provides the following endpoints:
 
@@ -34,35 +36,34 @@ 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/rpc/rpc_base' } }, 
+    ( action => { setup => { PathPart => 'track', Chained => '/api/rpc/rpc_base' } },
        ...
   );
 
 =cut
 
-sub index : Chained('setup') PathPart('') Args(0) {
-       my ( $self, $c ) = @_;
-
-       $self->push_error($c, { message => 'Not implemented' });
-       $c->res->status( '404' );
-}
-
 =method_protected create
 
 Chained: L</objects_no_id>
 PathPart: create
 CaptureArgs: 0
 
-Provides an endpoint to the functionality described in L<Catalyst::Controller::DBIC::API/update_or_create>.
+Provides an endpoint to the functionality described in
+L<Catalyst::Controller::DBIC::API/update_or_create>.
 
 =cut
 
-sub create :Chained('objects_no_id') :PathPart('create') :Args(0) 
-{
-       my ($self, $c) = @_;
+sub create : Chained('objects_no_id') : PathPart('create') : Args(0) {
+    my ( $self, $c ) = @_;
     $self->update_or_create($c);
 }
 
@@ -72,13 +73,13 @@ Chained: L</deserialize>
 PathPart: list
 CaptureArgs: 0
 
-Provides an endpoint to the functionality described in L<Catalyst::Controller::DBIC::API/list>.
+Provides an endpoint to the functionality described in
+L<Catalyst::Controller::DBIC::API/list>.
 
 =cut
 
-sub list :Chained('deserialize') :PathPart('list') :Args(0) 
-{
-       my ($self, $c) = @_;
+sub list : Chained('deserialize') : PathPart('list') : Args(0) {
+    my ( $self, $c ) = @_;
     $self->next::method($c);
 }
 
@@ -88,13 +89,13 @@ Chained: L</object_with_id>
 PathPart: ''
 Args: 0
 
-Provides an endpoint to the functionality described in L<Catalyst::Controller::DBIC::API/item>.
+Provides an endpoint to the functionality described in
+L<Catalyst::Controller::DBIC::API/item>.
 
 =cut
 
-sub item :Chained('object_with_id') :PathPart('') :Args(0) 
-{
-    my ($self, $c) = @_;
+sub item : Chained('object_with_id') : PathPart('') : Args(0) {
+    my ( $self, $c ) = @_;
     $self->next::method($c);
 }
 
@@ -104,13 +105,13 @@ Chained: L</object_with_id>
 PathPart: update
 Args: 0
 
-Provides an endpoint to the functionality described in L<Catalyst::Controller::DBIC::API/update_or_create>.
+Provides an endpoint to the functionality described in
+L<Catalyst::Controller::DBIC::API/update_or_create>.
 
 =cut
 
-sub update :Chained('object_with_id') :PathPart('update') :Args(0) 
-{
-    my ($self, $c) = @_;
+sub update : Chained('object_with_id') : PathPart('update') : Args(0) {
+    my ( $self, $c ) = @_;
     $self->update_or_create($c);
 }
 
@@ -120,13 +121,13 @@ Chained: L</object_with_id>
 PathPart: delete
 Args: 0
 
-Provides an endpoint to the functionality described in L<Catalyst::Controller::DBIC::API/delete>.
+Provides an endpoint to the functionality described in
+L<Catalyst::Controller::DBIC::API/delete>.
 
 =cut
 
-sub delete :Chained('object_with_id') :PathPart('delete') :Args(0) 
-{
-    my ($self, $c) = @_;
+sub delete : Chained('object_with_id') : PathPart('delete') : Args(0) {
+    my ( $self, $c ) = @_;
     $self->next::method($c);
 }
 
@@ -136,13 +137,13 @@ Chained: L</objects_no_id>
 PathPart: update
 Args: 0
 
-Provides an endpoint to the functionality described in L<Catalyst::Controller::DBIC::API/update_or_create> for multiple objects.
+Provides an endpoint to the functionality described in
+L<Catalyst::Controller::DBIC::API/update_or_create> for multiple objects.
 
 =cut
 
-sub update_bulk :Chained('objects_no_id') :PathPart('update') :Args(0) 
-{
-    my ($self, $c) = @_;
+sub update_bulk : Chained('objects_no_id') : PathPart('update') : Args(0) {
+    my ( $self, $c ) = @_;
     $self->update_or_create($c);
 }
 
@@ -152,14 +153,14 @@ Chained: L</objects_no_id>
 PathPart: delete
 Args: 0
 
-Provides an endpoint to the functionality described in L<Catalyst::Controller::DBIC::API/delete> for multiple objects.
+Provides an endpoint to the functionality described in
+L<Catalyst::Controller::DBIC::API/delete> for multiple objects.
 
 =cut
 
-sub delete_bulk :Chained('objects_no_id') :PathPart('delete') :Args(0) 
-{
-    my ($self, $c) = @_;
-    $self->next::method($c);
+sub delete_bulk : Chained('objects_no_id') : PathPart('delete') : Args(0) {
+    my ( $self, $c ) = @_;
+    $self->delete($c);
 }
 
 1;