From 2e96d0d87abd6357868114b0b59ee66b08985235 Mon Sep 17 00:00:00 2001 From: Pjotr Prins Date: Tue, 21 Jul 2020 07:52:13 +0100 Subject: Documenting exports and REST API --- test/rest-api.html | 41 +++++++++++++++++++++++++---------------- test/rest-api.org | 17 +++++++++++++++++ 2 files changed, 42 insertions(+), 16 deletions(-) (limited to 'test') diff --git a/test/rest-api.html b/test/rest-api.html index c50d116..421d75a 100644 --- a/test/rest-api.html +++ b/test/rest-api.html @@ -3,10 +3,10 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + - +PubSeq REST API + -
+
+ UP + | + HOME +
+

PubSeq REST API

-
-

1 PubSeq REST API

+ + + +
+

1 PubSeq REST API

Here we document the public REST API that comes with PubSeq. The tests @@ -266,8 +275,8 @@ for running the tests inside emacs.

-
-

1.1 Introduction

+
+

1.1 Introduction

We built a REST API for COVID-19 PubSeq. The API source code can be @@ -330,8 +339,8 @@ response_body

-
-

1.2 Fetch EBI XML

+
+

1.2 Fetch EBI XML

PubSeq provides an API that is used to export formats that are @@ -401,8 +410,8 @@ documented -

2 Configure emacs to run tests

+
+

2 Configure emacs to run tests

Execute a code @@ -428,7 +437,7 @@ To skip confirmations you may also want to set

-
Created by
Pjotr Prins (pjotr.public768 at thebird 'dot' nl) using Emacs org-mode and a healthy dose of Lisp!
Modified 2020-07-20 Mon 06:13
. +
Created by Pjotr Prins (pjotr.public768 at thebird 'dot' nl) using Emacs org-mode and a healthy dose of Lisp!
Modified 2020-07-21 Tue 01:32
.
diff --git a/test/rest-api.org b/test/rest-api.org index 6d118b5..31fc792 100644 --- a/test/rest-api.org +++ b/test/rest-api.org @@ -1,3 +1,17 @@ +# C-c C-e h h publish +# C-c ! insert date (use . for active agenda, C-u C-c ! for date+time, C-u C-c . for time) +# C-c C-t task rotate +# RSS_IMAGE_URL: http://xxxx.xxxx.free.fr/rss_icon.png + +#+TITLE: PubSeq REST API +#+AUTHOR: Pjotr Prins +#+HTML_LINK_HOME: http://covid19.genenetwork.org/apidoc +# OPTIONS: section-numbers: nil, with-drawers: t + +#+HTML_HEAD: + + + * PubSeq REST API Here we document the public REST API that comes with PubSeq. The tests @@ -33,6 +47,9 @@ response_body #+RESULTS: | service | : | PubSeq | version | : | 0.1 | +** Fetch metadata + + ** Fetch EBI XML PubSeq provides an API that is used to export formats that are -- cgit v1.2.3