Author: anuzzolese
Date: Wed Sep 12 14:24:00 2012
New Revision: 1383963
URL: http://svn.apache.org/viewvc?rev=1383963&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=1383963&r1=1383962&r2=1383963&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:24:00 2012
@@ -10,8 +10,36 @@ Rules organized into containers called r
* Service: __/rules/recipe/__
* Method: PUT
* Parameters:
- * recipe (Path parameter): the ID of the recipe as a path
parameter(MANDATORY)
- * description: the textual description of the recipe (OPTIONAL)
+ * recipe (Path parameter): 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
+
+
+ curl -G -X PUT description="A test recipe." \
+ http://localhost:8080/rules/recipe/recipeTestA
+
+### How to add rules to a recipe
+
+* Service: __/rules/recipe/__
+* Method: POST
+ * Parameters:
+ ** recipe (Path parameter): the ID of the recipe as a path
parameter(MANDATORY)
+ ** rules: the rules in Stanbol syntax(MANDATORY)
+ ** description: the textual description of the rules (OPTIONAL)
+
+
+ curl -X POST ÐH ÒContent-type: multipart/form-dataÓ ÐF \
+ rules=@myRuleFile -F description="My rules in the recipe" \
+ http://localhost:8080/rules/recipe/recipeTestA
+
+### How to get a recipe or a recipe from the store
+
+* Service: __/rules/recipe/__
+* Method: GET
+* Parameters:
+ ** recipe (Path parameter): the ID of the recipe as a path
parameter(MANDATORY)
+ ** rule: the ID of the rule (OPTIONAL). If it is null than the whole
recipe is returned. Otherwise it is returned the single rule identified by the
parameter value
+
+ curl -X GET ÐH ÒAccept: text/turtleÓ
http://localhost:8080/rules/recipe/recipeTestA \
+ -d rule=recipeTestA_rule1
+
\ No newline at end of file
