diff options
| author | Pjotr Prins | 2020-07-21 07:52:13 +0100 |
|---|---|---|
| committer | Pjotr Prins | 2020-07-21 07:52:13 +0100 |
| commit | 2e96d0d87abd6357868114b0b59ee66b08985235 (patch) | |
| tree | ddf38f6dca5f5a9ae69b430693ef0d1e64193ff5 /test | |
| parent | c5b337fb20790fad3ae3e7a4c2928081de1c98ba (diff) | |
| download | bh20-seq-resource-2e96d0d87abd6357868114b0b59ee66b08985235.tar.gz bh20-seq-resource-2e96d0d87abd6357868114b0b59ee66b08985235.tar.lz bh20-seq-resource-2e96d0d87abd6357868114b0b59ee66b08985235.zip | |
Documenting exports and REST API
Diffstat (limited to 'test')
| -rw-r--r-- | test/rest-api.html | 41 | ||||
| -rw-r--r-- | test/rest-api.org | 17 |
2 files changed, 42 insertions, 16 deletions
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"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <head> -<!-- 2020-07-20 Mon 06:13 --> +<!-- 2020-07-21 Tue 01:32 --> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> -<title>‎</title> +<title>PubSeq REST API</title> <meta name="generator" content="Org mode" /> <meta name="author" content="Pjotr Prins" /> <style type="text/css"> @@ -193,6 +193,7 @@ .org-svg { width: 90%; } /*]]>*/--> </style> +<link rel="Blog stylesheet" type="text/css" href="blog.css" /> <script type="text/javascript"> /* @licstart The following is the entire license notice for the @@ -241,23 +242,31 @@ for the JavaScript code in this tag. </script> </head> <body> -<div id="content"> +<div id="org-div-home-and-up"> + <a accesskey="h" href=""> UP </a> + | + <a accesskey="H" href="http://covid19.genenetwork.org/apidoc"> HOME </a> +</div><div id="content"> +<h1 class="title">PubSeq REST API</h1> <div id="table-of-contents"> <h2>Table of Contents</h2> <div id="text-table-of-contents"> <ul> -<li><a href="#orgb24ef14">1. PubSeq REST API</a> +<li><a href="#org0db7287">1. PubSeq REST API</a> <ul> -<li><a href="#orgd7c015d">1.1. Introduction</a></li> -<li><a href="#orgb2caa89">1.2. Fetch EBI XML</a></li> +<li><a href="#orgd98cd95">1.1. Introduction</a></li> +<li><a href="#org8951ab6">1.2. Fetch EBI XML</a></li> </ul> </li> -<li><a href="#org68f26b2">2. Configure emacs to run tests</a></li> +<li><a href="#orgbde9911">2. Configure emacs to run tests</a></li> </ul> </div> </div> -<div id="outline-container-orgb24ef14" class="outline-2"> -<h2 id="orgb24ef14"><span class="section-number-2">1</span> PubSeq REST API</h2> + + + +<div id="outline-container-org0db7287" class="outline-2"> +<h2 id="org0db7287"><span class="section-number-2">1</span> PubSeq REST API</h2> <div class="outline-text-2" id="text-1"> <p> Here we document the public REST API that comes with PubSeq. The tests @@ -266,8 +275,8 @@ for running the tests inside emacs. </p> </div> -<div id="outline-container-orgd7c015d" class="outline-3"> -<h3 id="orgd7c015d"><span class="section-number-3">1.1</span> Introduction</h3> +<div id="outline-container-orgd98cd95" class="outline-3"> +<h3 id="orgd98cd95"><span class="section-number-3">1.1</span> Introduction</h3> <div class="outline-text-3" id="text-1-1"> <p> We built a REST API for COVID-19 PubSeq. The API source code can be @@ -330,8 +339,8 @@ response_body </div> </div> -<div id="outline-container-orgb2caa89" class="outline-3"> -<h3 id="orgb2caa89"><span class="section-number-3">1.2</span> Fetch EBI XML</h3> +<div id="outline-container-org8951ab6" class="outline-3"> +<h3 id="org8951ab6"><span class="section-number-3">1.2</span> Fetch EBI XML</h3> <div class="outline-text-3" id="text-1-2"> <p> PubSeq provides an API that is used to export formats that are @@ -401,8 +410,8 @@ documented <a href="http://covid19.genenetwork.org/blog?id=using-covid-19-pubseq </div> </div> -<div id="outline-container-org68f26b2" class="outline-2"> -<h2 id="org68f26b2"><span class="section-number-2">2</span> Configure emacs to run tests</h2> +<div id="outline-container-orgbde9911" class="outline-2"> +<h2 id="orgbde9911"><span class="section-number-2">2</span> Configure emacs to run tests</h2> <div class="outline-text-2" id="text-2"> <p> Execute a code @@ -428,7 +437,7 @@ To skip confirmations you may also want to set </div> </div> <div id="postamble" class="status"> -<hr><small>Created by <a href="http://thebird.nl/">Pjotr Prins</a> (pjotr.public768 at thebird 'dot' nl) using Emacs org-mode and a healthy dose of Lisp!<br />Modified 2020-07-20 Mon 06:13</small>. +<hr><small>Created by <a href="http://thebird.nl/">Pjotr Prins</a> (pjotr.public768 at thebird 'dot' nl) using Emacs org-mode and a healthy dose of Lisp!<br />Modified 2020-07-21 Tue 01:32</small>. </div> </body> </html> 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: <link rel="Blog stylesheet" type="text/css" href="blog.css" /> + + + * 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 |