aboutsummaryrefslogtreecommitdiff
path: root/example/lazybones-example-docs.md
diff options
context:
space:
mode:
authorColin Okay <okay@toyful.space>2022-02-20 15:48:36 -0600
committerColin Okay <okay@toyful.space>2022-02-20 15:48:36 -0600
commit70def00400c88f4d872a58b2f76449077ece22ca (patch)
treeb918e7321145b1ced930cc9206c3a395af8dcd08 /example/lazybones-example-docs.md
parent0437c4a85af5a4fbb68174d7c1266887acc692c1 (diff)
parentc48ecda020797fe3fe65d55d02a8b72f6e7f19cb (diff)
Merge branch 'master' of github.com:cbeo/lazybones
Diffstat (limited to 'example/lazybones-example-docs.md')
-rw-r--r--example/lazybones-example-docs.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/example/lazybones-example-docs.md b/example/lazybones-example-docs.md
index a7dfca9..522d129 100644
--- a/example/lazybones-example-docs.md
+++ b/example/lazybones-example-docs.md
@@ -6,6 +6,17 @@ Just an API that defines some endpoints. These
## Endpoints
+### GET /animal/:genus:/:species:
+*text/plain*
+
+Route Variables:
+
+- GENUS
+- SPECIES
+
+
+Prints information about [Animal](#animal) specified by GENUS and SPECIES
+
### POST /crapshoot
*text/plain*
@@ -97,3 +108,15 @@ An instance of person. As JSON, it looks like:
+<h3 id='#animal'>animal</h3>
+
+An animal
+
+**Slots:**
+- GENUS: The genus
+- SPECIES: The species
+- POPULATION: Population on Earth
+- HABITAT: Where the animal lives
+
+
+