add a few comments about the new routes

metacpan · Nov 22, 2016 · 439f14f · 439f14f
1 parent e6b9f0c
commit 439f14f
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/MetaCPAN/Server/Controller/Search/Web.pm b/lib/MetaCPAN/Server/Controller/Search/Web.pm
@@ -13,6 +13,8 @@ with 'MetaCPAN::Server::Role::JSONP';
 sub get { }
 sub all { }
 
+# The simple search avoids most of the input and output aggregation and munging and is therefore easier to reason about for say search optimization.
+
 sub simple : Chained('/search/index') : PathPart('simple') : Args(0) {
     my ( $self, $c ) = @_;
     my $args = $c->req->params;
@@ -23,6 +25,8 @@ sub simple : Chained('/search/index') : PathPart('simple') : Args(0) {
     $c->stash($results);
 }
 
+# The web endpoint is the primary one, this handles the front-end's user-facing search
+
 sub web : Chained('/search/index') : PathPart('web') : Args(0) {
     my ( $self, $c ) = @_;
     my $args = $c->req->params;