From 0e65ad1a14138d90f05cb77485b8856ba019a901 Mon Sep 17 00:00:00 2001 From: Christoph Helma Date: Fri, 11 Mar 2011 14:26:38 +0100 Subject: README converted to markdown, .yardopts added --- .yardopts | 1 + README | 51 --------------------------------------------------- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 48 insertions(+), 51 deletions(-) create mode 100644 .yardopts delete mode 100644 README create mode 100644 README.md diff --git a/.yardopts b/.yardopts new file mode 100644 index 0000000..c1a7ad0 --- /dev/null +++ b/.yardopts @@ -0,0 +1 @@ +application.rb diff --git a/README b/README deleted file mode 100644 index ade50d3..0000000 --- a/README +++ /dev/null @@ -1,51 +0,0 @@ -OpenTox Dataset -================= - -* An OpenTox REST Webservice -* Stores associations between compounds and features in datasets -* Implements a subset of the OpenTox compound API 1.1 (http://opentox.org/dev/apis/api-1.1/dataset) -* Supports the internal YAML representation of opentox-ruby - -REST operations ---------------- - -Get a list of datasets GET / - List of dataset URIs 200,400,404 -Get a dataset GET /{id} - Dataset representation 200,400,404 -Upload a dataset POST / Dataset representation Dataset URI 200,400,404 -Delete a dataset DELETE /{id} - - 200,404 -Delete all datasets DELETE / - - 200,404 - -Supported MIME formats (http://chemical-mime.sourceforge.net/) --------------------------------------------------------------- - - * application/rdf+xml (default): read/write OWL-DL - -Examples --------- - -Get a list of all datasets: - - curl http://webservices.in-silico.ch/dataset - -Upload a dataset: - - curl -X POST -H "Content-Type:application/rdf+xml" --data-binary @{my_rdf_file} http://webservices.in-silico.ch/dataset - -Get a dataset representation: - - curl http://webservices.in-silico.ch/dataset/{id} - -Delete a dataset: - - curl -X DELETE http://webservices.in-silico.ch/dataset/{id} - -API documentation ------------------ - -http://rdoc.info/github/opentox/dataset - -Copyright ---------- - -Copyright (c) 2009-2011 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details. - diff --git a/README.md b/README.md new file mode 100644 index 0000000..4f8175c --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +OpenTox Dataset +=============== + +* An OpenTox REST Webservice +* Stores associations between compounds and features in datasets +* Implements a subset of the [OpenTox compound API 1.2](http://opentox.org/dev/apis/api-1.2/dataset) +* Supports the internal YAML representation of opentox-ruby + +REST operations +--------------- + + Get a list of datasets GET / - List of dataset URIs 200,400,404 + Get a dataset GET /{id} - Dataset representation 200,400,404 + Upload a dataset POST / Dataset representation Dataset URI 200,400,404 + Delete a dataset DELETE /{id} - - 200,404 + Delete all datasets DELETE / - - 200,404 + +Supported MIME formats (http://chemical-mime.sourceforge.net/) +-------------------------------------------------------------- + +* application/rdf+xml (default): read/write OWL-DL +* application/x-yaml: read/write YAML + +Examples +-------- + +Get a list of all datasets + + curl http://webservices.in-silico.ch/dataset + +Upload a dataset + + curl -X POST -H "Content-Type:application/rdf+xml" --data-binary @{my_rdf_file} http://webservices.in-silico.ch/dataset + +Get a dataset representation + + curl http://webservices.in-silico.ch/dataset/{id} + +Delete a dataset + + curl -X DELETE http://webservices.in-silico.ch/dataset/{id} + +[API documentation](http://rdoc.info/github/opentox/dataset) +------------------------------------------------------------ + +Copyright (c) 2009-2011 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details. + -- cgit v1.2.3