adl-support/docs/adl-support.rest-support.html

<!DOCTYPE html PUBLIC ""
    "">
<html><head><meta charset="UTF-8" /><title>adl-support.rest-support documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Adl-support</span> <span class="project-version">0.1.7-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>adl-support</span></div></div></li><li class="depth-2 branch"><a href="adl-support.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="adl-support.filters.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>filters</span></div></a></li><li class="depth-2 branch"><a href="adl-support.forms-support.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>forms-support</span></div></a></li><li class="depth-2 branch"><a href="adl-support.print-usage.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>print-usage</span></div></a></li><li class="depth-2 branch current"><a href="adl-support.rest-support.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rest-support</span></div></a></li><li class="depth-2 branch"><a href="adl-support.tags.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tags</span></div></a></li><li class="depth-2"><a href="adl-support.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="adl-support.rest-support.html#var-do-or-server-fail"><div class="inner"><span>do-or-server-fail</span></div></a></li><li class="depth-1"><a href="adl-support.rest-support.html#var-if-valid-user"><div class="inner"><span>if-valid-user</span></div></a></li><li class="depth-1"><a href="adl-support.rest-support.html#var-valid-user-or-forbid"><div class="inner"><span>valid-user-or-forbid</span></div></a></li><li class="depth-1"><a href="adl-support.rest-support.html#var-with-params-or-error"><div class="inner"><span>with-params-or-error</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">adl-support.rest-support</h1><div class="doc"><div class="markdown"><p>Application Description Language support - functions useful in generating JSON route handlers.</p></div></div><div class="public anchor" id="var-do-or-server-fail"><h3>do-or-server-fail</h3><h4 class="type">macro</h4><div class="usage"><code>(do-or-server-fail form status)</code></div><div class="doc"><div class="markdown"><p>Evaluate this <code>form</code>; if it succeeds, return an HTTP response with this status code and the JSON-formatted result as body; if it fails, return an HTTP 500 response.</p></div></div></div><div class="public anchor" id="var-if-valid-user"><h3>if-valid-user</h3><h4 class="type">macro</h4><div class="usage"><code>(if-valid-user form request error-return)</code><code>(if-valid-user form request)</code></div><div class="doc"><div class="markdown"><p>Evaluate this <code>form</code> only if there is a valid user in the session of this <code>request</code>; otherwise return the <code>error-return</code> value.</p></div></div></div><div class="public anchor" id="var-valid-user-or-forbid"><h3>valid-user-or-forbid</h3><h4 class="type">macro</h4><div class="usage"><code>(valid-user-or-forbid form request)</code></div><div class="doc"><div class="markdown"><p>Evaluate this <code>form</code> only if there is a valid user in the session of this <code>request</code>; otherwise return an HTTP forbidden response.</p></div></div></div><div class="public anchor" id="var-with-params-or-error"><h3>with-params-or-error</h3><h4 class="type">macro</h4><div class="usage"><code>(with-params-or-error form params required)</code></div><div class="doc"><div class="markdown"><p>Evaluate this <code>form</code> only if these <code>params</code> contain all these <code>required</code> keys; otherwise return an HTTP 400 response.</p></div></div></div></div></body></html>
	`<!DOCTYPE html PUBLIC ""`
	`"">`
	<html><head><meta charset="UTF-8" /><title>adl-support.rest-support documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Adl-support</span> <span class="project-version">0.1.7-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>adl-support</span></div></div></li><li class="depth-2 branch"><a href="adl-support.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="adl-support.filters.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>filters</span></div></a></li><li class="depth-2 branch"><a href="adl-support.forms-support.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>forms-support</span></div></a></li><li class="depth-2 branch"><a href="adl-support.print-usage.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>print-usage</span></div></a></li><li class="depth-2 branch current"><a href="adl-support.rest-support.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rest-support</span></div></a></li><li class="depth-2 branch"><a href="adl-support.tags.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tags</span></div></a></li><li class="depth-2"><a href="adl-support.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="adl-support.rest-support.html#var-do-or-server-fail"><div class="inner"><span>do-or-server-fail</span></div></a></li><li class="depth-1"><a href="adl-support.rest-support.html#var-if-valid-user"><div class="inner"><span>if-valid-user</span></div></a></li><li class="depth-1"><a href="adl-support.rest-support.html#var-valid-user-or-forbid"><div class="inner"><span>valid-user-or-forbid</span></div></a></li><li class="depth-1"><a href="adl-support.rest-support.html#var-with-params-or-error"><div class="inner"><span>with-params-or-error</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">adl-support.rest-support</h1><div class="doc"><div class="markdown"><p>Application Description Language support - functions useful in generating JSON route handlers.</p></div></div><div class="public anchor" id="var-do-or-server-fail"><h3>do-or-server-fail</h3><h4 class="type">macro</h4><div class="usage"><code>(do-or-server-fail form status)</code></div><div class="doc"><div class="markdown"><p>Evaluate this <code>form</code>; if it succeeds, return an HTTP response with this status code and the JSON-formatted result as body; if it fails, return an HTTP 500 response.</p></div></div></div><div class="public anchor" id="var-if-valid-user"><h3>if-valid-user</h3><h4 class="type">macro</h4><div class="usage"><code>(if-valid-user form request error-return)</code><code>(if-valid-user form request)</code></div><div class="doc"><div class="markdown"><p>Evaluate this <code>form</code> only if there is a valid user in the session of this <code>request</code>; otherwise return the <code>error-return</code> value.</p></div></div></div><div class="public anchor" id="var-valid-user-or-forbid"><h3>valid-user-or-forbid</h3><h4 class="type">macro</h4><div class="usage"><code>(valid-user-or-forbid form request)</code></div><div class="doc"><div class="markdown"><p>Evaluate this <code>form</code> only if there is a valid user in the session of this <code>request</code>; otherwise return an HTTP forbidden response.</p></div></div></div><div class="public anchor" id="var-with-params-or-error"><h3>with-params-or-error</h3><h4 class="type">macro</h4><div class="usage"><code>(with-params-or-error form params required)</code></div><div class="doc"><div class="markdown"><p>Evaluate this <code>form</code> only if these <code>params</code> contain all these <code>required</code> keys; otherwise return an HTTP 400 response.</p></div></div></div></div></body></html>