b935f28185
I also slipped a change into the Matrix Paramters section markdown generation, there is one less (superfluous) newline there now.
1.3 KiB
1.3 KiB
On proper introductions.
Hello there.
As documentation is usually written for humans, it's often useful to introduce concepts with a few words.
This title is below the last
You'll also note that multiple intros are possible.
POST /greet
Request Body:
"Hello, haskeller!"
Response:
- Status code 201
- If you use ?capital=true
"HELLO, HASKELLER"
- If you use ?capital=false
"Hello, haskeller"
GET /hello;lang=/:name
Captures:
- name: name of the person to greet
Matrix Parameters:
hello:
- lang
- Values: en, sv, fr
- Description: Get the greeting message selected language. Default is en.
GET Parameters:
- capital
- Values: true, false
- Description: Get the greeting message in uppercase (true) or not (false).Default is false.
Response:
- Status code 200
- If you use ?capital=true
"HELLO, HASKELLER"
- If you use ?capital=false
"Hello, haskeller"
DELETE /greet/:greetid
Title
This is some text
Second secton
And some more
Captures:
-
greetid: identifier of the greet msg to remove
-
This endpoint is sensitive to the value of the unicorns HTTP header.
Response:
- Status code 200
- No response body