summaryrefslogtreecommitdiff
path: root/markdown_blocks
diff options
context:
space:
mode:
authorrautenberg <rautenberg@in-silico.ch>2017-01-23 12:17:58 +0100
committerrautenberg <rautenberg@in-silico.ch>2017-01-23 12:17:58 +0100
commite233750914d5ba4630188c14f4617b457a59b506 (patch)
treefaca0fa8f1a1f8cf3f6200895fb6aa2b2e237ca5 /markdown_blocks
parentc0318a95e290a722c861a6124e5037ff4420aac6 (diff)
rest poster revision
Diffstat (limited to 'markdown_blocks')
-rw-r--r--markdown_blocks/rest_aa.md7
-rw-r--r--markdown_blocks/rest_examples.md6
-rw-r--r--markdown_blocks/rest_integration.md11
-rw-r--r--markdown_blocks/rest_lazar-rest.md6
-rw-r--r--markdown_blocks/rest_lazar_description.md5
-rw-r--r--markdown_blocks/rest_links.md15
-rw-r--r--markdown_blocks/rest_qmrf.md10
-rw-r--r--markdown_blocks/rest_rest.md4
-rw-r--r--markdown_blocks/rest_screenshot.md2
-rw-r--r--markdown_blocks/rest_summary.md2
10 files changed, 41 insertions, 27 deletions
diff --git a/markdown_blocks/rest_aa.md b/markdown_blocks/rest_aa.md
index 2022c54..3dca640 100644
--- a/markdown_blocks/rest_aa.md
+++ b/markdown_blocks/rest_aa.md
@@ -1,5 +1,6 @@
Data confidentiality, authentication and authorization (AA) is a common requirement for many resources.
Within the OpenTox\cite{hardy2010collaborative} project, in-silico toxicology gmbh has implemented a single-sign-on method with an OpenLDAP backend for user management
-and OpenAM for authentication and authorization. The revised technic is also used in eNanoMapper services to provide access control.
-Conforming to the OpenTox web service architecture principles\cite{hardy2010collaborative}, eNanoMapper services will be decoupled from AAI.
-This provides the opportunity to deploy a service without A&A, if/when possible. \ No newline at end of file
+and OpenAM for authentication and authorization.
+This system was updated and revised for eNanoMapper and provides access control for the current services.
+Conforming to the OpenTox web service architecture principles\cite{hardy2010collaborative}, eNanoMapper services can be decoupled from AA.
+This provides the opportunity to deploy a service without A&A, if required (e.g. for local installations). \ No newline at end of file
diff --git a/markdown_blocks/rest_examples.md b/markdown_blocks/rest_examples.md
index 3b3789d..ee9f615 100644
--- a/markdown_blocks/rest_examples.md
+++ b/markdown_blocks/rest_examples.md
@@ -1,14 +1,14 @@
-get an URI list for all models:
+Get an URI list for all models:
```Bash
curl -X GET --header 'Accept: text/uri-list' -H 'accept:text/uri-list' 'https://enm.in-silico.ch/model'
```
-retrieve an JSON representation of a model:
+Retrieve an JSON representation of a model:
```Bash
curl -X GET -H 'Accept: application/json' -H 'accept: application/json' 'https://enm.in-silico.ch/model/<MODELID>'
```
-predict a nano-particle:
+Predict a nano-particle:
```Bash
curl -X POST -H 'Content-Type: application/x-www-form-urlencoded' -H 'Accept:text/html' -d 'identifier= \ https://enm.in-silico.ch/nanoparticle/<NANOPARTICLEID>' 'https://enm.in-silico.ch/model/<MODELID>'
``` \ No newline at end of file
diff --git a/markdown_blocks/rest_integration.md b/markdown_blocks/rest_integration.md
index 3884fd7..e0cb402 100644
--- a/markdown_blocks/rest_integration.md
+++ b/markdown_blocks/rest_integration.md
@@ -1,4 +1,9 @@
-lazar-rest provides a RESTful webservice to connect the internet with the lazar & nano-lazar framework.
-The lazar framework integrate internal libraries, eNanoMapper resources as the Data Warehouse and Ontologies and external resources like UniProt and BioPortal.
+lazar-rest provides a REST webservice for the nano-lazar framework.
+The lazar framework integrates internal libraries, eNanoMapper
+resources (Data Warehouse and Ontologies) and external resources like UniProt and
+BioPortal. The lazar-rest services makes the lazar framework accessible
+for other webservices and web applications and for users who prefer the
+command line over graphical user interfaces.
-![nano-lazar Swagger UI](./images/rest_integration.pdf "nano-lazar Swagger UI") \ No newline at end of file
+
+![nano-lazar service integration](./images/rest_integration.pdf " nano-lazar service integration") \ No newline at end of file
diff --git a/markdown_blocks/rest_lazar-rest.md b/markdown_blocks/rest_lazar-rest.md
index 3c887ca..5a6ab82 100644
--- a/markdown_blocks/rest_lazar-rest.md
+++ b/markdown_blocks/rest_lazar-rest.md
@@ -1,3 +1,3 @@
-lazar-rest is a gem library written in Ruby. It provides a REST API webservice to lazar and nano-lazar.
-The API is documented in the Swagger RESTful API documentation specification version 2.0.
-This specification is conform to the Open API Iniciative specification. \ No newline at end of file
+lazar-rest is a Ruby library, that it provides a REST interface for nano-lazar.
+The API is compatible with eNanoMapper specifications and documented with the Swagger API framework (version 2.0),
+which conforms with the Open API Initiative specification. \ No newline at end of file
diff --git a/markdown_blocks/rest_lazar_description.md b/markdown_blocks/rest_lazar_description.md
index 2096877..1272146 100644
--- a/markdown_blocks/rest_lazar_description.md
+++ b/markdown_blocks/rest_lazar_description.md
@@ -1,4 +1,3 @@
*lazar* (lazy structure–activity relationships)\cite{Maunz2013} is a modular framework for read across predictions of chemical toxicities.
-Within the European Union’s FP7 eNanoMapper project lazar was extended with capabilities to handle nanomaterial data,
-interfaces to other eNanoMapper services (databases and ontologies) and a stable and user-friendly graphical interface
-for nanoparticle read-across predictions. lazar provides a ruby gem library to this developments. \ No newline at end of file
+Within the European Union’s FP7 eNanoMapper project lazar was extended with capabilities to handle nanomaterial data and interfaces
+to other eNanoMapper services (databases and ontologies). lazar libraries are publicly distributed as Ruby gems. \ No newline at end of file
diff --git a/markdown_blocks/rest_links.md b/markdown_blocks/rest_links.md
index 682e16e..37279a5 100644
--- a/markdown_blocks/rest_links.md
+++ b/markdown_blocks/rest_links.md
@@ -1,21 +1,24 @@
-* Nano-lazar Restful API GUI. Swagger UI based documentation for API visualization and interaction.
+* Nano-lazar REST API GUI. Swagger UI based documentation for API visualization and interaction.
\
<https://enm.in-silico.ch>
* Nano-lazar Swagger API definition file
<https://enm.in-silico.ch/api/api.json>
-* Nano-lazar Restful API services source code repository
+* Nano-lazar REST API services source code repository
<https://github.com/opentox/lazar-rest>
-* Nano-lazar Restful API services Rubydocs gem library documentation
+* Nano-lazar REST API services Rubydocs gem library documentation
<http://www.rubydoc.info/gems/lazar-rest>
-* Nano-lazar Restful API issue tracker
+* Nano-lazar REST API issue tracker
<https://github.com/opentox/lazar-rest/issues>
* Lazar (source code)
<https://github.com/opentox/lazar>
-* Nano-lazar GUI (graphical user interface)
- <https://github.com/eNanoMapper/nano-lazar>
+* Swagger framework for APIs
+ <http://swagger.io/>
+
+* Open API Initiative
+ <https://www.openapis.org/> \ No newline at end of file
diff --git a/markdown_blocks/rest_qmrf.md b/markdown_blocks/rest_qmrf.md
index 882bcc2..aa65b6b 100644
--- a/markdown_blocks/rest_qmrf.md
+++ b/markdown_blocks/rest_qmrf.md
@@ -1,4 +1,6 @@
-lazar-rest do provide QMRF reporting. The integrated QSAR-report Ruby gem library can generate initial QMRF reports in XML format with the basic
-information of a model.
-The QSAR-report gem was developed to extend the lazar and nano-lazar toxicity prediction application with QMRF and QPRF reporting features.
-The library gem is independent from lazar or nano-lazar and can also be used in any other ruby code. \ No newline at end of file
+lazar-rest supports QMRF reporting. The integrated QSAR-report library
+generates QMRF reports in XML format with basic model information (e.g.
+validation results according to OECD guidelines). The QMRF report
+library is independent of other IST libraries (e.g. lazar,
+nano-lazar-gui, lazar-rest) and can be used by other applications that
+need QMRF reporting. \ No newline at end of file
diff --git a/markdown_blocks/rest_rest.md b/markdown_blocks/rest_rest.md
new file mode 100644
index 0000000..d8d670e
--- /dev/null
+++ b/markdown_blocks/rest_rest.md
@@ -0,0 +1,4 @@
+Representational State Transfer or RESTful API is an architectural style to design webservices.
+REST uses HTTP protocol requests GET, POST, PUT, DELETE for the communication between distributed webservices.
+nano-lazar as a part of the eNanoMapper analysis and modelling infrastructure is built upon the OpenTox web services framework following
+the principles of the Representational State Transfer (REST) design model. \ No newline at end of file
diff --git a/markdown_blocks/rest_screenshot.md b/markdown_blocks/rest_screenshot.md
index 2945e8d..4d6140c 100644
--- a/markdown_blocks/rest_screenshot.md
+++ b/markdown_blocks/rest_screenshot.md
@@ -1 +1 @@
-![nano-lazar Restful API on Swagger UI](./images/rest_swagger_2.png "nano-lazar Restful API on Swagger UI"){width=1540px} \ No newline at end of file
+![Swagger UI for the nano-lazar REST API](./images/rest_swagger_2.png "Swagger UI for the nano-lazar REST API"){width=1540px} \ No newline at end of file
diff --git a/markdown_blocks/rest_summary.md b/markdown_blocks/rest_summary.md
index 7785192..3b77d93 100644
--- a/markdown_blocks/rest_summary.md
+++ b/markdown_blocks/rest_summary.md
@@ -1,5 +1,5 @@
During the eNanoMapper project *in silico* toxicologies (IST) webservices were
adapted in order to provide REST interfaces that adhere to eNanoMapper
standards and specifications and supplemented with interactive SWAGGER
-documentation. This poster will give an overview of ISTs eNanoMapper API
+documentation. This poster gives an overview of ISTs eNanoMapper API
compatible REST services\cite{rautenberg_micha_2016_187328} and demonstrate its usage with practical examples.