Improved documentation on APIs
Change-Id: Ie594217ceb87e4833a94096fa12d61ea1dafd80b
diff --git a/Changes b/Changes
index d501d7e..d0bff7f 100755
--- a/Changes
+++ b/Changes
@@ -7,6 +7,7 @@
- Update API for statistics.
- Introduced documentation on CQL (margaretha).
- Introduced documentation on Cosmas 2.
+ - Improved documentation on APIs.
0.34 2019-06-26
- Introduced guided tour (hebasta, #19).
diff --git a/templates/de/doc/api/koralquery.html.ep b/templates/de/doc/api/koralquery.html.ep
deleted file mode 100644
index 2348cf9..0000000
--- a/templates/de/doc/api/koralquery.html.ep
+++ /dev/null
@@ -1,7 +0,0 @@
-% layout 'main', title => 'KorAP: KoralQuery';
-
-<h2 id="tutorial-top">KoralQuery</h2>
-
-<p><strong>Hauptentwickler:</strong> Nils Diewald, Joachim Bingel</p>
-
-<p>Die Spezifikation für KoralQuery ist auf <%=doc_ext_link_to 'GitHub', "http://korap.github.io/Koral"%> verfügbar.</p>
diff --git a/templates/doc/api.html.ep b/templates/doc/api.html.ep
index 7fa7a11..df5bcea 100644
--- a/templates/doc/api.html.ep
+++ b/templates/doc/api.html.ep
@@ -2,15 +2,8 @@
<h2 id="tutorial-top">Application Programming Interface</h2>
-<p>Internally the communication between the KorAP components is done using the <%= doc_link_to('KoralQuery', 'api', 'koralquery') %> protocol. The following endpoints make use of this protocol or establish additional mechanisms. All described endpoints are (more or lest) REST-ful web APIs.</p>
+<p>Internally the communication between KorAP components is done using the KoralQuery protocol.
+ The specification for KoralQuery is available on <%= doc_ext_link_to 'GitHub', "http://korap.github.io/Koral" %>.
+ All API endpoints either use KoralQuery or are (more or lest) REST-ful web APIs.</p>
-<dl>
- <dt><%= doc_link_to('Search API', 'api', 'search') %></dt>
- <dd>Initiate queries, create virtual corpora.</dd>
-
- <dt><%= doc_link_to('Match API', 'api', 'match') %></dt>
- <dd>Retrieve further information like annotations for a certain match.</dd>
-
- <dt><%= doc_link_to('User API', 'api', 'user') %></dt>
- <dd>Log in, log out, and set and retrieve user properties.</dd>
-</dl>
+<p>All publicly available API endpoints including their requests and responses are described in the <%= doc_ext_link_to 'GitHub Wiki', "https://github.com/KorAP/Kustvakt/wiki" %> of <%= doc_link_to 'Kustvakt', 'korap', 'kustvakt' %>.</p>
diff --git a/templates/doc/api/koralquery.html.ep b/templates/doc/api/koralquery.html.ep
deleted file mode 100644
index 9d7640f..0000000
--- a/templates/doc/api/koralquery.html.ep
+++ /dev/null
@@ -1,7 +0,0 @@
-% layout 'main', title => 'KorAP: KoralQuery';
-
-<h2 id="tutorial-top">KoralQuery</h2>
-
-<p><strong>Main developer:</strong> Nils Diewald, Joachim Bingel</p>
-
-<p>The specification for KoralQuery is available on <%= doc_ext_link_to 'GitHub', "http://korap.github.io/Koral" %>.</p>
diff --git a/templates/doc/api/match.html.ep b/templates/doc/api/match.html.ep
deleted file mode 100644
index 5cd21b4..0000000
--- a/templates/doc/api/match.html.ep
+++ /dev/null
@@ -1,5 +0,0 @@
-% layout 'main', title => 'KorAP: Match API';
-
-<h2 id="tutorial-top">Match API</h2>
-
-%= doc_uc
diff --git a/templates/doc/api/search.html.ep b/templates/doc/api/search.html.ep
deleted file mode 100644
index 6a83ce6..0000000
--- a/templates/doc/api/search.html.ep
+++ /dev/null
@@ -1,5 +0,0 @@
-% layout 'main', title => 'KorAP: Search API';
-
-<h2 id="tutorial-top">Search API</h2>
-
-%= doc_uc
diff --git a/templates/doc/api/user.html.ep b/templates/doc/api/user.html.ep
deleted file mode 100644
index 0967a6d..0000000
--- a/templates/doc/api/user.html.ep
+++ /dev/null
@@ -1,5 +0,0 @@
-% layout 'main', title => 'KorAP: User API';
-
-<h2 id="tutorial-top">User API</h2>
-
-%= doc_uc
diff --git a/templates/doc/korap/kustvakt.html.ep b/templates/doc/korap/kustvakt.html.ep
index e3873c0..b2803ca 100644
--- a/templates/doc/korap/kustvakt.html.ep
+++ b/templates/doc/korap/kustvakt.html.ep
@@ -4,7 +4,7 @@
%= korap_overview 'kustvakt'
-<p><strong>Main developer:</strong> Michael Hanl, Eliza Margaretha, Franck Bodmer</p>
+<p><strong>Main developer:</strong> Eliza Margaretha, Michael Hanl, Franck Bodmer</p>
<p>Kustvakt is a user and policy management software, that is capable of rewriting queries for policy based document restrictions.</p>
diff --git a/templates/doc/navigation.json b/templates/doc/navigation.json
index 22d0a00..6f4fc0b 100644
--- a/templates/doc/navigation.json
+++ b/templates/doc/navigation.json
@@ -171,25 +171,7 @@
},
{
"title" : "API",
- "id" : "api",
- "items" : [
- {
- "title" : "KoralQuery",
- "id" : "koralquery"
- },
- {
- "title" : "Search API",
- "id" : "search"
- },
- {
- "title" : "Match API",
- "id" : "match"
- },
- {
- "title" : "User API",
- "id" : "user"
- }
- ]
+ "id" : "api"
},
{
"title" : "F.A.Q.",