Author: buildbot
Date: Thu Sep 13 15:09:18 2012
New Revision: 831911
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/refactor.html
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 Thu Sep 13 15:09:18 2012
@@ -1 +1 @@
-1383987
+1384360
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/rules/refactor.html
==============================================================================
---
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/rules/refactor.html
(original)
+++
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/rules/refactor.html
Thu Sep 13 15:09:18 2012
@@ -146,8 +146,43 @@ translated into the construct template,
<em>(Please note, that the following links to the actual service endpoint link
to a running instance of Apache Stanbol. If you use other domains or ports than
"localhost:8080", then please change accordingly)</em></p>
<h3 id="refactor-engine-refactor">Refactor Engine ("/refactor"):</h3>
<ul>
-<li>The Refactor Engine <strong>@/refactor</strong> performs a refactoring
applying an existing recipe in the rule store to the provided RDF graph.</li>
+<li>
+<p>The Refactor Engine <strong>@/refactor</strong> performs a refactoring
applying an existing recipe in the rule store to the provided RDF graph. The
RDF graph can be either in the Stanbol triplestore or provided as a file.
+In the first case the output of the refactoring is stored in the triplestore.
The request should be done as it follows:</p>
+</li>
+<li>
+<p>Method: POST</p>
+</li>
+<li>Parameters:<ul>
+<li>input-graph: the ID of RDF graph in the triplestore provided as input</li>
+<li>output-graph: the ID of RDF graph in the triplestore in which we want to
store the result.</li>
+<li>recipe: the ID of the recipe in the rule store</li>
</ul>
+</li>
+</ul>
+<p>Example:</p>
+<div class="codehilite"><pre>curl -G -X GET <span class="se">\</span>
+-d input-graph<span class="o">=</span>stored_graph -d <span
class="nv">recipe</span><span class="o">=</span>myTestRecipeA -d
output-graph<span class="o">=</span>result_graph <span class="se">\</span>
+http://localhost:8080/refactor
+</pre></div>
+
+
+<p>In the case we want to refactor an external RDF graph provided as file the
request should be done as follows:</p>
+<ul>
+<li>Method: POST</li>
+<li>Parameters:<ul>
+<li>recipe: the ID of the recipe (MANDATORY)</li>
+<li>input: the RDF graph to which the refactoring has to be applied. The graph
has to be provided as a binary file (MANDATORY)</li>
+</ul>
+</li>
+</ul>
+<p>Example:</p>
+<div class="codehilite"><pre>curl -X POST -H <span
class="s2">"Content-type: multipart/form-data"</span> <span
class="se">\</span>
+-F <span class="nv">description</span><span class="o">=</span>recipeTestA -F
<span class="nv">rules</span><span class="o">=</span>@graph.rdf <span
class="se">\</span>
+http://localhost:8080/refactor
+</pre></div>
+
+
<h3 id="refactor-engine-refactorapply">Refactor Engine
("/refactor/apply"):</h3>
<ul>
<li>Refactor Engine <strong>@/refactor/apply</strong> performs a refactoring
applying an recipe as string to the provided RDF graph as input source.</li>
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
Thu Sep 13 15:09:18 2012
@@ -88,7 +88,7 @@
<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="recipe-management">Recipe management</h3>
+<h3 id="recipe-and-rule-management">Recipe and rule management</h3>
<h4 id="how-to-create-a-recipe">How to create a recipe</h4>
<ul>
<li>Service: <strong>/rules/recipe/</strong></li>
@@ -145,7 +145,7 @@ http://localhost:8080/rules/recipe/recip
</li>
</ul>
<p>Example:</p>
-<div class="codehilite"><pre>curl -X GET -H <span class="s2">"Accept:
text/turtle"</span> <span class="se">\ </span>
+<div class="codehilite"><pre>curl -G -X GET -H <span class="s2">"Accept:
text/turtle"</span> <span class="se">\ </span>
-d <span class="nv">rule</span><span class="o">=</span>recipeTestA_rule1 <span
class="se">\</span>
http://localhost:8080/rules/recipe/recipeTestA
</pre></div>
@@ -167,6 +167,66 @@ http://localhost:8080/rules/recipe/recip
-d <span class="nv">rule</span><span class="o">=</span>recipeTestA_rule1 <span
class="se">\</span>
http://localhost:8080/rules/recipe/recipeTestA
</pre></div>
+
+
+<p>#### How to find a recipe in the store</p>
+<ul>
+<li>Service: <strong>/rules/find/recipes</strong></li>
+<li>Method: GET</li>
+<li>Parameters:<ul>
+<li>description: some word describing the recipe. This parameter is used as
search field.</li>
+</ul>
+</li>
+<li>Accepts:<ul>
+<li>application/rdf+xml</li>
+<li>text/html</li>
+<li>text/plain</li>
+<li>application/owl+xml</li>
+<li>text/owl-functional</li>
+<li>text/owl-manchester</li>
+<li>application/rdf+json,</li>
+<li>text/turle</li>
+</ul>
+</li>
+</ul>
+<p>Example: <br />
+</p>
+<div class="codehilite"><pre>curl -G -X GET <span class="se">\</span>
+-d <span class="nv">description</span><span class="o">=</span><span
class="s2">"test recipe"</span> <span class="se">\</span>
+http://localhost:8080/rules/find/recipes
+</pre></div>
+
+
+<h4 id="how-to-find-a-rule-in-the-store">How to find a rule in the store</h4>
+<ul>
+<li>Service: <strong>/rules/find/rules</strong></li>
+<li>Method: GET</li>
+<li>Parameters:<ul>
+<li>description: some word describing the rule. This parameter is used as
search field.</li>
+</ul>
+</li>
+<li>Accepts:<ul>
+<li>application/rdf+xml</li>
+<li>text/html</li>
+<li>text/plain</li>
+<li>application/owl+xml</li>
+<li>text/owl-functional</li>
+<li>text/owl-manchester</li>
+<li>application/rdf+json,</li>
+<li>text/turle</li>
+</ul>
+</li>
+</ul>
+<p>Example: <br />
+</p>
+<div class="codehilite"><pre>curl -G -X GET <span class="se">\</span>
+-d <span class="nv">description</span><span class="o">=</span><span
class="s2">"My rules"</span> <span class="se">\</span>
+http://localhost:8080/rules/find/rules
+</pre></div>
+
+
+<hr />
+<p><em><a href="../rules.html">Back to Stanbol Rules</a></em></p>
</div>
<div id="footer">
