Author: anuzzolese
Date: Wed Sep 12 14:15:09 2012
New Revision: 1383954
URL: http://svn.apache.org/viewvc?rev=1383954&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=1383954&r1=1383953&r2=1383954&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:15:09 2012
@@ -7,23 +7,38 @@ Rules organized into containers called r
### How to create a recipe
-A recipe can be created in the store with the service
__STANBOL_HOME/rules/recipe/__
+* Service: __/rules/recipe/__
* Method: PUT
* Parameters:
-** recipe: the ID of the recipe as a path parameter(MANDATORY)
+
+** 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
-
-_(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)_
+ http://localhost:8080/rules/recipe/recipeTestA
+
+### How to add rules to a recipe
-### Rule Manager ("/rules/rule"):
+* Service: __/rules/recipe/__
+* Method: POST
+* Parameters:
-- The Rule Manager @ [/rules/rule](http://localhost:8080/rules/rule) allows to
manage and retrieve inference rules.
+** 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
-### Recipe Manager ("/rules/recipe"):
+* Service: __/rules/recipe/__
+* Method: GET
+* Parameters:
-- The Recipe Manager @ [/rules/recipe](http://localhost:8080/rules/recipe)
allows to manage, store and retrieve pre-defined rule sequences, or __recipes__.
+** 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
-TODO
\ No newline at end of file
+ curl -X GET ÐH ÒAccept: text/turtleÓ
http://localhost:8080/rules/recipe/recipeTestA \
+ -d rule=recipeTestA_rule1
