Bug 16497: Add POD in Koha/REST/V1/Library.pm
authorAlex Arnaud <alex.arnaud@biblibre.com>
Tue, 5 Dec 2017 14:56:34 +0000 (14:56 +0000)
committerroot <root@f1ebe1bec408>
Tue, 19 Feb 2019 13:52:14 +0000 (13:52 +0000)
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

Signed-off-by: Josef Moravec <josef.moravec@gmail.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>

Koha/REST/V1/Library.pm

index 9772217..c0b92b2 100644 (file)
@@ -24,6 +24,22 @@ use Scalar::Util qw( blessed );
 
 use Try::Tiny;
 
+=head1 NAME
+
+Koha::REST::V1::Library - Koha REST API for handling libraries (V1)
+
+=head1 API
+
+=head2 Methods
+
+=cut
+
+=head3 list
+
+Controller function that handles listing Koha::Library objects
+
+=cut
+
 sub list {
     my $c = shift->openapi->valid_input or return;
 
@@ -51,6 +67,12 @@ sub list {
     };
 }
 
+=head3 get
+
+Controller function that handles retrieving a single Koha::Library
+
+=cut
+
 sub get {
     my $c = shift->openapi->valid_input or return;
 
@@ -64,6 +86,12 @@ sub get {
     return $c->render( status => 200, openapi => $library );
 }
 
+=head3 add
+
+Controller function that handles adding a new Koha::Library object
+
+=cut
+
 sub add {
     my $c = shift->openapi->valid_input or return;
 
@@ -89,6 +117,12 @@ sub add {
     };
 }
 
+=head3 update
+
+Controller function that handles updating a Koha::Library object
+
+=cut
+
 sub update {
     my $c = shift->openapi->valid_input or return;
 
@@ -114,6 +148,12 @@ sub update {
     };
 }
 
+=head3 delete
+
+Controller function that handles deleting a Koha::Library object
+
+=cut
+
 sub delete {
     my $c = shift->openapi->valid_input or return;