From 101e0f20a83aadbddf338aef2394727eb5460f36 Mon Sep 17 00:00:00 2001 From: nikkel Date: Thu, 19 Mar 2020 16:50:02 +0700 Subject: [PATCH] Add 'message.md' --- message.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 message.md diff --git a/message.md b/message.md new file mode 100644 index 0000000..2590915 --- /dev/null +++ b/message.md @@ -0,0 +1,39 @@ +Return message details +====================== + +Returns all details about a message + +URL +--- + +`/api/v1/messages/message` + +Access +------ + +Must be authenticated as a server. If not authorised, a `AccessDenied` error will be returned. + +Parameters +---------- + +| Parameter | Type | Default | +| --- | --- | --- | +|`id` | Integer | null | + +|_The ID of the message_| | | + + +Errors +------ + +| Error | Attributes | +| --- | --- | +|`MessageNotFound`| `id` | | +|No message found matching provided ID | The ID of the message | + +Response Data +------------- + +This action will return a [message structure](../../structures/message.html). + +You will only receive basic data for this structure, no extended data is available. By default, you'll receive no expansions for the structure. You can add them by providing an array of new expansion names in the `_expansions` parameter on the request. You can send `true` rather than array to receive all expansions. \ No newline at end of file