documentation update

This commit is contained in:
2023-01-14 01:25:37 -08:00
parent 56d24a9ff9
commit d477fd31c9
2 changed files with 15 additions and 8 deletions
+14 -7
View File
@@ -16,11 +16,11 @@ html{
<h3>Usage</h3>
<p>URL Root: <a href="https://api.1611.social/">https://api.1611.social/<a> (you are here)</p>
<ul>
<li><a href="https://api.1611.social/random">/random</a> - A random verse from the KJV</li>
<li><a href="https://api.1611.social/votd">/votd</a> - A random verse that changes from day-to-day.</li>
<li><a href="https://api.1611.social/search">/search</a> - Search keywords</li>
<li><a href="https://api.1611.social/show?kw=John3:16">/show</a> - Show a set of verses</li>
<li><a href="https://api.1611.social/define">/define</a> - Search the Dictionary</li>
<li><a href="/random">/random</a> - A random verse from the KJV</li>
<li><a href="/votd">/votd</a> - A random verse that changes from day-to-day.</li>
<li><a href="/search">/search</a> - Search keywords</li>
<li><a href="/show?kw=John3:16">/show</a> - Show a set of verses</li>
<li><a href="/define">/define</a> - Search the Dictionary</li>
</ul>
<h3>Verse searching</h3>
@@ -46,9 +46,9 @@ API ENDPOINT SPECIFICATION v 0.2
/random - outputs a random verse
/votd - returns verse of the day
/search - returns a keyword search result set (no args is a landing page)
/search - returns a keyword search result set
/show - returns a verse or set of verses by name/location
/define - 1828 Noah Webster dictionary (no args is a landing page)
/define - 1828 Noah Webster dictionary
URL PARAMETERS
==============
@@ -61,6 +61,12 @@ default: json
?kw=
- comma-delimited keyword search for /search
INTERACTIVE ENDPOINTS
=====================
/search and /define will show you a landing page where you can
use HTML forms to complete your search. Both of these will
offer you spelling suggestions if it can't find the right word.
This will only offer words that are actually in the Bible.
EXAMPLES
========
@@ -69,6 +75,7 @@ api.tld/votd?view=rich
api.tld/show?kw=john3:16,1john5:7&view=plain
api.tld/search?kw=faith
api.tld/search?kw=nimrod&view=rich
api.tld/define?kw=faith&view=rich
</code>
</pre>