Skip to content

Commit cc43d68

Browse files
committed
small update to katapi doc
1 parent cc81d27 commit cc43d68

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

APP/templates/pages/KatAPI.html

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,15 @@
55
<div class="container">
66
<h1>KatAPI</h1>
77

8-
<p>KatAPI is an API that allows the automated retrieval of data from the project
9-
in <code>json</code> or <code>xml-tei</code>.</p>
8+
<p>
9+
KatAPI is an API that allows the automated retrieval of data from the project
10+
in <code>json</code> or <code>xml-tei</code>. It functions as a complete search
11+
engine that parses the user's query parameters, retrieves the proper data from
12+
the project's databases and sends it back to the user. The API allows, for example,
13+
to retrieve the description of all manuscripts of the Marquise de Sévigné written
14+
between 1650 and 1690 and sold between 1880 and 1900 in a complete and valid TEI
15+
format.
16+
</p>
1017

1118
<hr/>
1219

@@ -265,4 +272,4 @@ <h2>Examples</h2>
265272
</ul>
266273

267274
</div>
268-
{% endblock %}
275+
{% endblock %}

0 commit comments

Comments
 (0)