API implementation (#712)

* initial v0 creator

* working json api for generic reports

* add require login

* move report swagger into plugin, and set new default layout of noop

* require proper role and also use new util func

* start to tidy authn

* some work on cleaning up web authn

* clean up the authN checks

* fix bug

* fix the auth for api

* fixes to json handling

* set swagger sort order

* enable most reports for api endpoints

* fix doc

* add paramters to reports

* add missed report

* allow api_parameters in reports config

* reorganise api

* add vlan search

* add port search

* make sure to enable layout processing

* add device search

* add v1 to api paths

* add Node Search

* support api_responses

* add device object search; fix spurious ports field in device result class

* handle some plugins just returning undef if search fails

* errors from api seamlessley

* fix error in date range default

* more sensible default for prefix

* change order of endpoints in swagger-ui

* all db row classes can now TO_JSON

* add device_port api endpoint

* add device ports endpoint

* do not expand docs

* add swagger ui json tree formatter

* add all relations from Device table

* add port relations

* add nodes retrieve on device or vlan

* rename to GetAPIKey

* update config for previous commit

lib/App/Netdisco/Web/GenericReport.pm

@@ -21,6 +21,9 @@ foreach my $report (@{setting('reports')}) {
     category => ($report->{category} || 'My Reports'),
     ($report->{hidden} ? (hidden => true) : ()),
     provides_csv => true,
+    api_endpoint => true,
+    bind_params  => $report->{bind_params},
+    api_parameters => $report->{api_parameters},
   });
 
   get "/ajax/content/report/$r" => require_login sub {
@@ -76,16 +79,14 @@ foreach my $report (@{setting('reports')}) {
                 is_custom_report => true,
                 column_options => \%column_config,
                 headings => [map {$column_config{$_}->{displayname}} @column_order],
-                columns => [@column_order] },
-              { layout => undef };
+                columns => [@column_order] };
       }
       else {
           header( 'Content-Type' => 'text/comma-separated-values' );
           template 'ajax/report/generic_report_csv.tt',
               { results => \@results,
                 headings => [map {$column_config{$_}->{displayname}} @column_order],
-                columns => [@column_order] },
-              { layout => undef };
+                columns => [@column_order] };
       }
   };
 }