example.md

Index

• MyResource

MyResource

This is MyResource description.

POST /api/v1/my_resource

Description:

This optional property exists to add a description to the endpoint.

Request headers:

{
  "AUTHORIZATION" : "user_token",
  "Content-Type" : "application/json",
  "Accept" : "application/json"
}

Path parameters:

{ "id": 1, "page": 1 }

Body parameters:

{ "some": "parameter" }

Response headers:

{ "some_header": "some_header_value" }

Response status:

200

Response body:

"no_content"