deploy: a304e89

redBorder · May 20, 2024 · a1f76dd · a1f76dd
1 parent 0a64677
commit a1f76dd
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 12 deletions.
diff --git a/classrest_1_1APIServer-members.html b/classrest_1_1APIServer-members.html
@@ -89,7 +89,7 @@
   <tr class="odd"><td class="entry"><a class="el" href="classrest_1_1APIServer.html#aa2dcc588af885f30968019eae18bd8c3">execute_model</a>(self, data, metric, model='default')</td><td class="entry"><a class="el" href="classrest_1_1APIServer.html">APIServer</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classrest_1_1APIServer.html#ab45d8ea6639edac36ac747cbf562be9a">exit_code</a></td><td class="entry"><a class="el" href="classrest_1_1APIServer.html">APIServer</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classrest_1_1APIServer.html#abd3e5726dcc3ecb5cd005350fe8da97e">get_data_from_druid</a>(self, druid_query, model='default')</td><td class="entry"><a class="el" href="classrest_1_1APIServer.html">APIServer</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classrest_1_1APIServer.html#a62567b0caaa1b7cdbba24df441c0625d">return_error</a>(self, error=&quot;error&quot;)</td><td class="entry"><a class="el" href="classrest_1_1APIServer.html">APIServer</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classrest_1_1APIServer.html#a76881d2ca33b2160499ebd0779c51261">return_error</a>(self, msg=&quot;error&quot;, exception=None)</td><td class="entry"><a class="el" href="classrest_1_1APIServer.html">APIServer</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classrest_1_1APIServer.html#a226b012c2968bdefd981622ad548a37b">run_test_app</a>(self)</td><td class="entry"><a class="el" href="classrest_1_1APIServer.html">APIServer</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classrest_1_1APIServer.html#ad6cbdddba4ed1be7c6d0af492611bf16">s3_client</a></td><td class="entry"><a class="el" href="classrest_1_1APIServer.html">APIServer</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classrest_1_1APIServer.html#a93a7c8675757ce10d27e0599a9f006b5">s3_sync_interval</a></td><td class="entry"><a class="el" href="classrest_1_1APIServer.html">APIServer</a></td><td class="entry"></td></tr>

diff --git a/classrest_1_1APIServer.html b/classrest_1_1APIServer.html
@@ -95,8 +95,8 @@
 <tr class="separator:aa2dcc588af885f30968019eae18bd8c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:abd3e5726dcc3ecb5cd005350fe8da97e"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrest_1_1APIServer.html#abd3e5726dcc3ecb5cd005350fe8da97e">get_data_from_druid</a> (self, druid_query, model='default')</td></tr>
 <tr class="separator:abd3e5726dcc3ecb5cd005350fe8da97e"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a62567b0caaa1b7cdbba24df441c0625d"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrest_1_1APIServer.html#a62567b0caaa1b7cdbba24df441c0625d">return_error</a> (self, error=&quot;error&quot;)</td></tr>
-<tr class="separator:a62567b0caaa1b7cdbba24df441c0625d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a76881d2ca33b2160499ebd0779c51261"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrest_1_1APIServer.html#a76881d2ca33b2160499ebd0779c51261">return_error</a> (self, msg=&quot;error&quot;, exception=None)</td></tr>
+<tr class="separator:a76881d2ca33b2160499ebd0779c51261"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a226b012c2968bdefd981622ad548a37b"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrest_1_1APIServer.html#a226b012c2968bdefd981622ad548a37b">run_test_app</a> (self)</td></tr>
 <tr class="separator:a226b012c2968bdefd981622ad548a37b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a6342303e3b6e03de6d0695b26c987861"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrest_1_1APIServer.html#a6342303e3b6e03de6d0695b26c987861">start_s3_sync_thread</a> (self)</td></tr>
@@ -348,8 +348,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#abd3e5726dcc3ecb5cd005350
 </pre> 
 </div>
 </div>
-<a id="a62567b0caaa1b7cdbba24df441c0625d" name="a62567b0caaa1b7cdbba24df441c0625d"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a62567b0caaa1b7cdbba24df441c0625d">&#9670;&#160;</a></span>return_error()</h2>
+<a id="a76881d2ca33b2160499ebd0779c51261" name="a76881d2ca33b2160499ebd0779c51261"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a76881d2ca33b2160499ebd0779c51261">&#9670;&#160;</a></span>return_error()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -364,7 +364,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#a62567b0caaa1b7cdbba24df4
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">&#160;</td>
-          <td class="paramname"><em>error</em> = <code>&quot;error&quot;</code>&#160;</td>
+          <td class="paramname"><em>msg</em> = <code>&quot;error&quot;</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>exception</em> = <code>None</code>&#160;</td>
         </tr>
         <tr>
           <td></td>
@@ -373,10 +379,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#a62567b0caaa1b7cdbba24df4
         </tr>
       </table>
 </div><div class="memdoc">
-<pre class="fragment">Returns an adequate formatted JSON for whenever there is an error.
+<pre class="fragment">Returns a properly formatted JSON response for errors.
 
 Args:
-    error (string): message detailing what type of error has been fired.
+    msg (str): Message detailing the type of error that has occurred.
+    exception (Exception, optional): Exception object to include in the error message. Defaults to None.
+
+Returns:
+    Response: JSON response indicating an error status.
 </pre> 
 </div>
 </div>

diff --git a/functions.html b/functions.html
@@ -214,7 +214,7 @@ <h3><a id="index_q" name="index_q"></a>- q -</h3><ul>
 
 <h3><a id="index_r" name="index_r"></a>- r -</h3><ul>
 <li>rescale()&#160;:&#160;<a class="el" href="classoutliers_1_1Autoencoder.html#a81efd85946d8e5ac80b3d58e1dfdf63a">Autoencoder</a></li>
-<li>return_error()&#160;:&#160;<a class="el" href="classoutliers_1_1Autoencoder.html#a64f52234879e3153b151a915d9549927">Autoencoder</a>, <a class="el" href="classrest_1_1APIServer.html#a62567b0caaa1b7cdbba24df441c0625d">APIServer</a>, <a class="el" href="classshallow__outliers_1_1ShallowOutliers.html#a64f52234879e3153b151a915d9549927">ShallowOutliers</a></li>
+<li>return_error()&#160;:&#160;<a class="el" href="classoutliers_1_1Autoencoder.html#a64f52234879e3153b151a915d9549927">Autoencoder</a>, <a class="el" href="classrest_1_1APIServer.html#a76881d2ca33b2160499ebd0779c51261">APIServer</a>, <a class="el" href="classshallow__outliers_1_1ShallowOutliers.html#a64f52234879e3153b151a915d9549927">ShallowOutliers</a></li>
 <li>rq_manager&#160;:&#160;<a class="el" href="class____main_____1_1Outliers.html#afb7fb1638cd86df75576dd639f46f128">Outliers</a></li>
 <li>rq_queue&#160;:&#160;<a class="el" href="classrq_1_1RqManager.html#a8bc09aa188185cc57dd9009903baaf3b">RqManager</a></li>
 <li>run()&#160;:&#160;<a class="el" href="class____main_____1_1Outliers.html#ad22709b2e67308af35f55680d5a026e0">Outliers</a></li>

diff --git a/functions_func.html b/functions_func.html
@@ -173,7 +173,7 @@ <h3><a id="index_p" name="index_p"></a>- p -</h3><ul>
 
 <h3><a id="index_r" name="index_r"></a>- r -</h3><ul>
 <li>rescale()&#160;:&#160;<a class="el" href="classoutliers_1_1Autoencoder.html#a81efd85946d8e5ac80b3d58e1dfdf63a">Autoencoder</a></li>
-<li>return_error()&#160;:&#160;<a class="el" href="classoutliers_1_1Autoencoder.html#a64f52234879e3153b151a915d9549927">Autoencoder</a>, <a class="el" href="classrest_1_1APIServer.html#a62567b0caaa1b7cdbba24df441c0625d">APIServer</a>, <a class="el" href="classshallow__outliers_1_1ShallowOutliers.html#a64f52234879e3153b151a915d9549927">ShallowOutliers</a></li>
+<li>return_error()&#160;:&#160;<a class="el" href="classoutliers_1_1Autoencoder.html#a64f52234879e3153b151a915d9549927">Autoencoder</a>, <a class="el" href="classrest_1_1APIServer.html#a76881d2ca33b2160499ebd0779c51261">APIServer</a>, <a class="el" href="classshallow__outliers_1_1ShallowOutliers.html#a64f52234879e3153b151a915d9549927">ShallowOutliers</a></li>
 <li>run()&#160;:&#160;<a class="el" href="class____main_____1_1Outliers.html#ad22709b2e67308af35f55680d5a026e0">Outliers</a></li>
 <li>run_production_server()&#160;:&#160;<a class="el" href="class____main_____1_1Outliers.html#aea09bc34c2d2aeb676290e4574fd0eee">Outliers</a></li>
 <li>run_test_app()&#160;:&#160;<a class="el" href="classrest_1_1APIServer.html#a226b012c2968bdefd981622ad548a37b">APIServer</a></li>

diff --git a/search/all_f.js b/search/all_f.js
@@ -6,7 +6,7 @@ var searchData=
   ['rescale_3',['rescale',['../classoutliers_1_1Autoencoder.html#a81efd85946d8e5ac80b3d58e1dfdf63a',1,'outliers::Autoencoder']]],
   ['rest_4',['rest',['../namespacerest.html',1,'']]],
   ['rest_2epy_5',['rest.py',['../rest_8py.html',1,'']]],
-  ['return_5ferror_6',['return_error',['../classshallow__outliers_1_1ShallowOutliers.html#a64f52234879e3153b151a915d9549927',1,'shallow_outliers.ShallowOutliers.return_error()'],['../classrest_1_1APIServer.html#a62567b0caaa1b7cdbba24df441c0625d',1,'rest.APIServer.return_error()'],['../classoutliers_1_1Autoencoder.html#a64f52234879e3153b151a915d9549927',1,'outliers.Autoencoder.return_error()']]],
+  ['return_5ferror_6',['return_error',['../classshallow__outliers_1_1ShallowOutliers.html#a64f52234879e3153b151a915d9549927',1,'shallow_outliers.ShallowOutliers.return_error()'],['../classrest_1_1APIServer.html#a76881d2ca33b2160499ebd0779c51261',1,'rest.APIServer.return_error()'],['../classoutliers_1_1Autoencoder.html#a64f52234879e3153b151a915d9549927',1,'outliers.Autoencoder.return_error()']]],
   ['rq_7',['rq',['../namespacerq.html',1,'']]],
   ['rq_2epy_8',['rq.py',['../rq_8py.html',1,'']]],
   ['rq_5fmanager_9',['rq_manager',['../class____main_____1_1Outliers.html#afb7fb1638cd86df75576dd639f46f128',1,'__main__::Outliers']]],

diff --git a/search/functions_b.js b/search/functions_b.js
@@ -1,7 +1,7 @@
 var searchData=
 [
   ['rescale_0',['rescale',['../classoutliers_1_1Autoencoder.html#a81efd85946d8e5ac80b3d58e1dfdf63a',1,'outliers::Autoencoder']]],
-  ['return_5ferror_1',['return_error',['../classoutliers_1_1Autoencoder.html#a64f52234879e3153b151a915d9549927',1,'outliers.Autoencoder.return_error()'],['../classshallow__outliers_1_1ShallowOutliers.html#a64f52234879e3153b151a915d9549927',1,'shallow_outliers.ShallowOutliers.return_error()'],['../classrest_1_1APIServer.html#a62567b0caaa1b7cdbba24df441c0625d',1,'rest.APIServer.return_error()']]],
+  ['return_5ferror_1',['return_error',['../classoutliers_1_1Autoencoder.html#a64f52234879e3153b151a915d9549927',1,'outliers.Autoencoder.return_error()'],['../classshallow__outliers_1_1ShallowOutliers.html#a64f52234879e3153b151a915d9549927',1,'shallow_outliers.ShallowOutliers.return_error()'],['../classrest_1_1APIServer.html#a76881d2ca33b2160499ebd0779c51261',1,'rest.APIServer.return_error()']]],
   ['run_2',['run',['../class____main_____1_1Outliers.html#ad22709b2e67308af35f55680d5a026e0',1,'__main__::Outliers']]],
   ['run_5fproduction_5fserver_3',['run_production_server',['../class____main_____1_1Outliers.html#aea09bc34c2d2aeb676290e4574fd0eee',1,'__main__::Outliers']]],
   ['run_5ftest_5fapp_4',['run_test_app',['../classrest_1_1APIServer.html#a226b012c2968bdefd981622ad548a37b',1,'rest::APIServer']]],