added report examples and example tests, new module Validation

1 files changed, 95 insertions, 1 deletions

diff --git a/EXAMPLES b/EXAMPLES
index cdf2b47..1f56b99 100644
--- a/EXAMPLES
+++ b/EXAMPLES
@@ -4,7 +4,7 @@ API-Definition
 see http://opentox.org/dev/apis/api-1.1/Validation
 
 
-API-Examples
+API-Examples Validation
 ===================================================================
 
 how to
@@ -141,3 +141,97 @@ result example (accept-header: text/uri-list)
 
 
 
+API-Examples Reports
+===================================================================
+
+
+get list of available report types
+-------------------------------------------------------------------
+
+>>> curl <validation_service>/report
+
+result example (accept-header: application/rdf-xml)			
+<<< not yet supported
+
+result example (accept-header: text/uri-list)
+<<< <validation_service>/report/validation
+<<< <validation_service>/report/crossvalidation
+<<< <validation_service>/report/algorithm_comparison
+
+
+get list of available reports of type validation
+-------------------------------------------------------------------
+
+>>> curl ot.validation.de/report/validation
+
+result example (accept-header: application/rdf-xml)			
+<<< not yet supported
+
+result example (accept-header: text/uri-list)
+<<< <validation_service>/report/validation/<validation_report_id>
+<<< <validation_service>/report/validation/id_i
+<<< <validation_service>/report/validation/id_j
+
+
+get validation report
+-------------------------------------------------------------------
+
+>>> curl <validation_service>/report/validation/<validation_report_id>
+
+Supported formats (accept-headers):
+* "text/xml" content of report in docbook-article format
+* "text/html" report formated with default docbook-article-xsl
+
+Hint: Visit <validation_service>/report/validation/<validation_report_id> with a browser to see the report in html format
+
+
+create validation report from validation
+-------------------------------------------------------------------
+
+>>> curl -X POST -d validation_uris="<validation_service>/<validation_id>" \
+ ot.validation.de/report/validation
+
+result example (accept-header: application/rdf-xml)			
+<<< not yet supported
+
+result example (accept-header: text/uri-list)
+<<< <validation_service>/report/validation/id_i
+
+
+get list of available reports of type crossvalidation
+-------------------------------------------------------------------
+
+>>> curl <validation_service>/report/crossvalidation
+
+result example (accept-header: application/rdf-xml)			
+<<< not yet supported
+
+result example (accept-header: text/uri-list)
+<<< <validation_service>/report/crossvalidation/<crossvalidation_report_id>
+<<< <validation_service>/report/crossvalidation/id_i
+<<< <validation_service>/report/crossvalidation/id_j
+
+
+get crossvalidation report
+-------------------------------------------------------------------
+
+>>> curl <validation_service>/report/crossvalidation/<crossvalidation_report_id>
+
+Supported formats (accept-headers):
+* "text/xml" content of report in docbook-article format
+* "text/html" report formated with default docbook-article-xsl
+
+Hint: Visit <validation_service>/report/crossvalidation/<crossvalidation_report_id> with a browser to see the report in html format
+
+
+create crossvalidation report from crossvalidation
+-------------------------------------------------------------------
+
+>>> curl -X POST -d validation_uris="<validation_service>/crossvalidation/<crossvalidation_id>" \
+ ot.validation.de/report/crossvalidation
+
+result example (accept-header: application/rdf-xml)			
+<<< not yet supported
+
+result example (accept-header: text/uri-list)
+<<< <validation_service>/report/crossvalidation/id_i
\ No newline at end of file