Permalink
Fetching contributors…
Cannot retrieve contributors at this time
126 lines (72 sloc) 1.64 KB

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
  • Example: application/json

"HELLO, HASKELLER"

Response:

  • Status code 201

  • Headers: [("X-Example","1729")]

  • Supported content types are:

    • application/json
  • 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

  • Headers: []

  • Supported content types are:

    • application/json
  • Response body as below.

[]

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
    • text/plain;charset=utf-8
  • If you use ?capital=true

"HELLO, HASKELLER"
  • If you use ?capital=true
"HELLO, HASKELLER"
  • If you use ?capital=false
"Hello, haskeller"
  • If you use ?capital=false
"Hello, haskeller"