~sirn/fanboi2

126358a74ce5bb5e5f02f8d52dbd08d1a45c3d8b — Kridsada Thanabulpong 4 years ago 71001b6
Add bumped to API documentation.
2 files changed, 11 insertions(+), 1 deletions(-)

M fanboi2/templates/api/_posts.mako
M fanboi2/templates/api/_topics.mako
M fanboi2/templates/api/_posts.mako => fanboi2/templates/api/_posts.mako +8 -1
@@ 10,14 10,21 @@
                    <thead class="api-table-header">
                        <tr class="api-table-row">
                            <th class="api-table-item title">Parameters</th>
                            <th class="api-table-item title">Type</th>
                            <th class="api-table-item title">Description</th>
                        </tr>
                    </thead>
                    <tbody class="api-table-body">
                        <tr class="api-table-row">
                            <th class="api-table-item title">body</th>
                            <td class="api-table-item type">String</td>
                            <td class="api-table-item">Content of the topic. From 2 to 4,000 characters.</td>
                        </tr>
                        <tr class="api-table-row">
                            <th class="api-table-item title">bumped</th>
                            <td class="api-table-item type">Boolean</td>
                            <td class="api-table-item">A flag whether the post should bump the topic to top of the board.</td>
                        </tr>
                    </tbody>
                </table>
            </div>


@@ 92,7 99,7 @@
                            <th class="api-table-item title">bumped</th>
                            <td class="api-table-item type">Boolean</td>
                            <td class="api-table-item">
                                <p>Boolean flag whether the post bumped the topic to top of the board.</p>
                                <p>A flag whether the post bumped the topic to top of the board.</p>
                                <pre class="codeblock">"bumped":true</pre>
                            </td>
                        </tr>

M fanboi2/templates/api/_topics.mako => fanboi2/templates/api/_topics.mako +3 -0
@@ 10,16 10,19 @@
                    <thead class="api-table-header">
                        <tr class="api-table-row">
                            <th class="api-table-item title">Parameters</th>
                            <th class="api-table-item title">Type</th>
                            <th class="api-table-item title">Description</th>
                        </tr>
                    </thead>
                    <tbody class="api-table-body">
                        <tr class="api-table-row">
                            <th class="api-table-item title">title</th>
                            <th class="api-table-item type">String</th>
                            <td class="api-table-item">Title of the topic. From 5 to 200 characters.</td>
                        </tr>
                        <tr class="api-table-row">
                            <th class="api-table-item title">body</th>
                            <th class="api-table-item type">String</th>
                            <td class="api-table-item">Content of the topic. From 2 to 4,000 characters.</td>
                        </tr>
                    </tbody>