diff options
| author | Colin Okay <okay@toyful.space> | 2022-02-17 09:27:40 -0600 |
|---|---|---|
| committer | Colin Okay <okay@toyful.space> | 2022-02-17 09:27:40 -0600 |
| commit | c48ecda020797fe3fe65d55d02a8b72f6e7f19cb (patch) | |
| tree | e642534d2f6b755244ed475036ee4f69734aa1e3 /example/lazybones-example-docs.md | |
| parent | 65963eeef5afea104d5a94a99851e6eb79acd101 (diff) | |
add whole classes to documentation
Diffstat (limited to 'example/lazybones-example-docs.md')
| -rw-r--r-- | example/lazybones-example-docs.md | 23 |
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 + + + |