fix: message api doc

This commit is contained in:
2021-09-13 18:03:57 +08:00
parent 465a3a67a5
commit 8ad087820e
2 changed files with 41 additions and 7 deletions

View File

@@ -921,7 +921,7 @@ Success — a happy kitten is an authenticated kitten!
<!--
* @Date: 2021-03-01 10:35:21
* @LastEditors: viletyy
* @LastEditTime: 2021-09-10 16:07:14
* @LastEditTime: 2021-09-13 17:54:51
* @FilePath: /forgeplus/app/docs/slate/source/includes/_users.md
-->
<h1 id='users'>Users</h1><h2 id='1ae74893b1'>获取当前登陆用户信息</h2>
@@ -1076,6 +1076,11 @@ Success — a happy kitten is an authenticated kitten!
<td>消息来源</td>
</tr>
<tr>
<td>messages.timeago</td>
<td>string</td>
<td>消息时间</td>
</tr>
<tr>
<td>messages.type</td>
<td>string</td>
<td>消息类型notification为系统消息atme为@我消息</td>
@@ -1290,7 +1295,7 @@ Success — a happy kitten is an authenticated kitten!
Success Data.
</aside>
<h2 id='94306b2fc3'>发送消息</h2>
<p>发送消息</p>
<p>发送消息, 目前只支持atme</p>
<blockquote>
<p>示例:</p>
@@ -1318,12 +1323,27 @@ Success — a happy kitten is an authenticated kitten!
<td>需要发送消息的用户名数组</td>
</tr>
<tr>
<td>content</td>
<td>atmeable_type</td>
<td>string</td>
<td>消息内容</td>
<td>atme消息对象是从哪里@我的比如评论Journal</td>
</tr>
<tr>
<td>atmeable_id</td>
<td>integer</td>
<td>atme消息对象id</td>
</tr>
</tbody></table>
<blockquote>
<p>请求的JSON示例:</p>
</blockquote>
<div class="highlight"><pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"atme"</span><span class="p">,</span><span class="w">
</span><span class="nl">"receivers_login"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"yystopf"</span><span class="p">,</span><span class="w"> </span><span class="s2">"testforge1"</span><span class="p">],</span><span class="w">
</span><span class="nl">"atmeable_type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Journal"</span><span class="p">,</span><span class="w">
</span><span class="nl">"atmeable_id"</span><span class="p">:</span><span class="w"> </span><span class="mi">67</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div>
<blockquote>
<p>返回的JSON示例:</p>
</blockquote>