Author: anuzzolese
Date: Wed Sep 12 14:05:06 2012
New Revision: 1383948
URL: http://svn.apache.org/viewvc?rev=1383948&view=rev
Log:
Editing documentation for Rules.
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components/rules/store.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components/rules/store.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components/rules/store.mdtext?rev=1383948&r1=1383947&r2=1383948&view=diff
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components/rules/store.mdtext
(original)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components/rules/store.mdtext
Wed Sep 12 14:05:06 2012
@@ -2,7 +2,20 @@ Title: Rule Store
## Service Endpoints
-The Rules RESTful API is structured as follows:
+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.
+
+### How to create a recipe
+
+A recipe can be created in the store with the service
__STANBOL_HOME/rules/recipe/__
+* Method: PUT
+* Parameters:
+** recipe: the ID of the recipe as a path parameter(MANDATORY)
+** description: the textual description of the recipe (OPTIONAL)
+
+ curl -G -X PUT description="A test recipe." \
+ http://localhost:8080/rules/recipe/recipeTestA
+
_(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)_
### Rule Manager ("/rules/rule"):
