diff options
Diffstat (limited to 'example/lazybones-example-docs.md')
| -rw-r--r-- | example/lazybones-example-docs.md | 19 |
1 files changed, 17 insertions, 2 deletions
diff --git a/example/lazybones-example-docs.md b/example/lazybones-example-docs.md index 281b98c..a7dfca9 100644 --- a/example/lazybones-example-docs.md +++ b/example/lazybones-example-docs.md @@ -59,7 +59,7 @@ Route Variables: - PERSON: ID of a person -Returns a json representation of the person. +Returns a json representation of the [Person](#person). ### GET /random/:lo:/:hi: *text/plain* @@ -81,4 +81,19 @@ Documented Query Parameters: - age: An Integer -Echo the search parameters in a nice list.
\ No newline at end of file +Echo the search parameters in a nice list. + +## Definitions + +<h3 id='#person'>Person</h3> + +An instance of person. As JSON, it looks like: + + { + "NAME" : string , + "OCCUPATION" : string , + "ID" : integer + } + + + |