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/Node.pm

@@ -12,7 +12,51 @@ use NetAddr::MAC ();
 use App::Netdisco::Web::Plugin;
 use App::Netdisco::Util::Web 'sql_match';
 
-register_search_tab({ tag => 'node', label => 'Node' });
+register_search_tab({
+    tag => 'node',
+    label => 'Node',
+    api_endpoint => 1,
+    api_parameters => [
+      q => {
+        description => 'MAC Address or IP Address or Hostname (without Domain Suffix) of a Node (supports SQL or "*" wildcards)',
+        required => 1,
+      },
+      partial => {
+        description => 'Partially match the "q" parameter (wildcard characters not required)',
+        type => 'boolean',
+        default => 'false',
+      },
+      deviceports => {
+        description => 'MAC Address search will include Device Port MACs',
+        type => 'boolean',
+        default => 'true',
+      },
+      show_vendor => {
+        description => 'Include interface Vendor in results',
+        type => 'boolean',
+        default => 'false',
+      },
+      archived => {
+        description => 'Include archived records in results',
+        type => 'boolean',
+        default => 'false',
+      },
+      daterange => {
+        description => 'Date Range in format "YYYY-MM-DD to YYYY-MM-DD"',
+      },
+      age_invert => {
+        description => 'Date Range is NOT within the supplied range',
+        type => 'boolean',
+        default => 'false',
+      },
+      # mac_format is used only in the template (will be IEEE) in results
+      #mac_format => {
+      #},
+      # stamps param is used only in the template (they will be included)
+      #stamps => {
+      #},
+    ],
+});
 
 # nodes matching the param as an IP or DNS hostname or MAC
 ajax '/ajax/content/search/node' => require_login sub {
@@ -144,7 +188,7 @@ ajax '/ajax/content/search/node' => require_login sub {
           ports     => $ports,
           wireless  => $wireless,
           netbios   => $netbios,
-        }, { layout => undef };
+        };
     }
     else {
         my $ports = param('deviceports')
@@ -157,7 +201,7 @@ ajax '/ajax/content/search/node' => require_login sub {
               ports     => $ports,
               wireless  => $wireless,
               netbios   => $netbios,
-            }, { layout => undef };
+            };
         }
     }
 
@@ -200,7 +244,7 @@ ajax '/ajax/content/search/node' => require_login sub {
     template 'ajax/search/node_by_ip.tt', {
       macs => $set,
       archive_filter => {@active},
-    }, { layout => undef };
+    };
 };
 
 true;