Author: buildbot Date: Wed Sep 12 14:38:52 2012 New Revision: 831811 Log: Staging update by buildbot for stanbol
Modified: websites/staging/stanbol/trunk/content/ (props changed) websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/rules/store.html Propchange: websites/staging/stanbol/trunk/content/ ------------------------------------------------------------------------------ --- cms:source-revision (original) +++ cms:source-revision Wed Sep 12 14:38:52 2012 @@ -1 +1 @@ -1383973 +1383974 Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/rules/store.html ============================================================================== --- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/rules/store.html (original) +++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/rules/store.html Wed Sep 12 14:38:52 2012 @@ -85,7 +85,34 @@ <ul> <li><a href="/">Home</a></li> <li class="item"><a href="/stanbol/">Stanbol</a></li> <li class="item"><a href="/stanbol/docs/">Docs</a></li> <li class="item"><a href="/stanbol/docs/trunk/">Trunk</a></li> <li class="item"><a href="/stanbol/docs/trunk/components/">Components</a></li> <li class="item"><a href="/stanbol/docs/trunk/components/rules/">Rules</a></li> </ul> </div> <h1 class="title">Rule Store</h1> - + <h2 id="service-endpoints">Service Endpoints</h2> +<p>The Rule Store provides a RESTful API that allows to persistently manage rules in Stanbol. +Rules organized into containers called recipes, which identify set of rules that share the same business logic.</p> +<h3 id="how-to-create-a-recipe">How to create a recipe</h3> +<ul> +<li>Service: <strong>/rules/recipe/</strong></li> +<li>Method: PUT</li> +<li>Parameters:<ul> +<li>recipe (Path parameter): the ID of the recipe as a path parameter(MANDATORY)</li> +<li>description: the textual description of the recipe (OPTIONAL)</li> +</ul> +</li> +</ul> +<p>Example:</p> +<div class="codehilite"><pre><span class="n">curl</span> <span class="o">-</span><span class="n">G</span> <span class="o">-</span><span class="n">X</span> <span class="n">PUT</span> <span class="n">description</span><span class="o">=</span><span class="s">"A test recipe."</span> <span class="o">\</span> +<span class="n">http:</span><span class="sr">//</span><span class="n">localhost:8080</span><span class="sr">/rules/</span><span class="n">recipe</span><span class="o">/</span><span class="n">recipeTestA</span> +</pre></div> + + +<h3 id="how-to-add-rules-to-a-recipe">How to add rules to a recipe</h3> +<ul> +<li>Service: <strong>/rules/recipe/</strong></li> +<li>Method: POST</li> +<li>Parameters: + <strong> recipe (Path parameter): the ID of the recipe as a path parameter (MANDATORY) + </strong> rules: the rules in Stanbol syntax (MANDATORY) + ** description: the textual description of the rules (OPTIONAL)</li> +</ul> </div> <div id="footer">