Skip to content

Commit

Permalink
docs: document usage of the search verse range feature
Browse files Browse the repository at this point in the history
  • Loading branch information
Whiskydog committed Aug 22, 2023
1 parent 422a2f6 commit f5971de
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,57 @@
```
</details>

<details>
<summary>
<b>Get Verse Range</b> - <i>returns a range of verses from a chapter</i>
</summary>
<br/>

<b>Endpoint:</b> `GET https://www.abibliadigital.com.br/api/verses/:version/:abbrev/:chapter/:from-:to`
<br /><br />
<b>Authenticated:</b>
<ul>
<li>No - Limit rate of 20 requests per hour</li>
<li>Yes - Unlimited</li>
</ul>

```
{
"book": {
"abbrev": {
"pt": "tg",
"en": "jm"
},
"name": "Tiago",
"version": "nvi"
},
"chapter": "1",
"verses": [
{
"number": 1,
"text": "Tiago, servo de Deus e do Senhor Jesus Cristo, às doze tribos dispersas entre as nações: Saudações."
},
{
"number": 2,
"text": "Meus irmãos, considerem motivo de grande alegria o fato de passarem por diversas provações,"
},
{
"number": 3,
"text": "pois vocês sabem que a prova da sua fé produz perseverança."
},
{
"number": 4,
"text": "E a perseverança deve ter ação completa, a fim de que vocês sejam maduros e íntegros, sem lhes faltar coisa alguma."
},
{
"number": 5,
"text": "Se algum de vocês tem falta de sabedoria, peça-a a Deus, que a todos dá livremente, de boa vontade; e lhe será concedida."
}
]
}
```
</details>

<details>
<summary>
<b>Get Random Verse</b> - <i>returns a random verse from a chapter</i>
Expand Down

0 comments on commit f5971de

Please sign in to comment.