b9d8fbcdc1
* Fix typos and grammar * Remove redundant words, fix articles * More language fixes * More typo fixes and resolve TODO about missing links
2.1 KiB
2.1 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:
-
Supported content types are:
application/json;charset=utf-8application/json
-
If you use ?capital=true (
application/json;charset=utf-8,application/json):
"HELLO, HASKELLER"
- If you use ?capital=false (
application/json;charset=utf-8,application/json):
"Hello, haskeller"
Response:
-
Status code 200
-
Headers: [("X-Example","1729")]
-
Supported content types are:
application/json;charset=utf-8application/json
-
If you use ?capital=true (
application/json;charset=utf-8,application/json):
"HELLO, HASKELLER"
- If you use ?capital=false (
application/json;charset=utf-8,application/json):
"Hello, haskeller"
DELETE /greet/:greetid
Title
This is some text
Second section
And some more
Captures:
- greetid: identifier of the greet msg to remove
Headers:
- This endpoint is sensitive to the value of the unicorns HTTP header.
Response:
-
Status code 200
-
Headers: []
-
Supported content types are:
application/json;charset=utf-8application/json
-
Example (
application/json;charset=utf-8,application/json):
GET /hello/:name
Captures:
- name: name of the person to greet
GET Parameters:
- capital
- Values: true, false
- Description: Get the greeting message in uppercase (true) or not (false).Default is false.
Response:
-
Status code 200
-
Headers: []
-
Supported content types are:
application/json;charset=utf-8application/jsontext/plain;charset=utf-8
-
If you use ?capital=true (
application/json;charset=utf-8,application/json,text/plain;charset=utf-8):
"HELLO, HASKELLER"
- If you use ?capital=false (
application/json;charset=utf-8,application/json):
"Hello, haskeller"