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/Plugin/Search/Device.pm

@@ -8,8 +8,52 @@ use List::MoreUtils ();
 
 use App::Netdisco::Web::Plugin;
 
-register_search_tab(
-    { tag => 'device', label => 'Device', provides_csv => 1 } );
+register_search_tab({
+    tag => 'device',
+    label => 'Device',
+    provides_csv => 1,
+    api_endpoint => 1,
+    api_parameters => [
+      q => {
+        description => 'Partial match of Device contact, serial, module serials, location, name, description, dns, or any IP alias',
+      },
+      name => {
+        description => 'Partial match of the Device name',
+      },
+      location => {
+        description => 'Partial match of the Device location',
+      },
+      dns => {
+        description => 'Partial match of any of the Device IP aliases',
+      },
+      ip => {
+        description => 'IP or IP Prefix within which the Device must have an interface address',
+      },
+      description => {
+        description => 'Partial match of the Device description',
+      },
+      model => {
+        description => 'Exact match of the Device model',
+      },
+      os => {
+        description => 'Exact match of the Device operating system',
+      },
+      os_ver => {
+        description => 'Exact match of the Device operating system version',
+      },
+      vendor => {
+        description => 'Exact match of the Device vendor',
+      },
+      layers => {
+        description => 'OSI Layer which the device must support',
+      },
+      matchall => {
+        description => 'If true, all fields (except "q") must match the Device',
+        type => 'boolean',
+        default => 'false',
+      },
+    ],
+});
 
 # device with various properties or a default match-all
 get '/ajax/content/search/device' => require_login sub {
@@ -40,13 +84,11 @@ get '/ajax/content/search/device' => require_login sub {
 
     if ( request->is_ajax ) {
         my $json = to_json( \@results );
-        template 'ajax/search/device.tt', { results => $json },
-            { layout => undef };
+        template 'ajax/search/device.tt', { results => $json };
     }
     else {
         header( 'Content-Type' => 'text/comma-separated-values' );
-        template 'ajax/search/device_csv.tt', { results => \@results, },
-            { layout => undef };
+        template 'ajax/search/device_csv.tt', { results => \@results, };
     }
 };