Skip to content

Commit 28bc273

Browse files
committed
Added /warn deactivate.
1 parent 3b5070e commit 28bc273

File tree

4 files changed

+40
-3
lines changed

4 files changed

+40
-3
lines changed
22.9 KB
Loading
24.1 KB
Loading

Writerside/topics/Dungeon-Hub-API.topic

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
33
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
44
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
5-
id="Dungeon-Hub-API" title="Dungeon Hub API">
5+
id="Dungeon-Hub-API" title="Dungeon Hub API ✏️">
66
<chapter title="What is the Dungeon Hub API" id="what-is-the-dungeon-hub-api">
77
<p>The Dungeon Hub API hosts all data that is used in the <a href="Dungeon-Hub-Bot.md"/>. <br/>The <a
88
href="Dungeon-Hub-Bot.md"/> itself only serves as a client to interact with the API - it does not have
99
any database access and only persists data through the API. A documentation with all endpoints and their
1010
usage can be found at <a href="https://api.dungeon-hub.net/"/>.</p>
1111
</chapter>
12+
1213
<chapter title="Authentication" id="authentication">
1314
<p>Most endpoints of the Dungeon Hub API require authentication. <br/>The API uses bearer tokens for
1415
authentication, meaning an Authorization header containing the JWT token must be attached
@@ -36,6 +37,7 @@
3637
client secret as password).</p>
3738
</chapter>
3839
</chapter>
40+
3941
<chapter title="Connecting to the API" id="connecting-to-the-api">
4042
<p>All API endpoints are reachable under <a href="https://api.dungeon-hub.net/"/>. A simple documentation of
4143
all endpoints is available there. <br/>To ease the connection to the API, a Kotlin/JVM library containing

Writerside/topics/warn-deactivate.topic

+37-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,42 @@
33
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
44
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
55
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
6-
title="/warn deactivate ✏️" id="warn-deactivate">
6+
title="/warn deactivate" id="warn-deactivate">
77

8-
<code>Coming soon</code>
8+
<tldr>
9+
<p>
10+
<format style="italic">Deactivate a given warning.</format>
11+
</p>
12+
</tldr>
13+
14+
<chapter title="Examples" id="examples" collapsible="true">
15+
<img alt="warn-deactivate-1.png" src="warn-deactivate-1.png" width="325" style="inline"
16+
border-effect="rounded"/>
17+
<img alt="warn-deactivate-not-found.png" src="warn-deactivate-not-found.png" width="325" style="inline"
18+
border-effect="rounded"/>
19+
</chapter>
20+
21+
<chapter title="Arguments" id="arguments" collapsible="true">
22+
<table style="header-row">
23+
<tr>
24+
<td>Name</td>
25+
<td>Type</td>
26+
<td>Description</td>
27+
<td>Optional?</td>
28+
<td>Additional</td>
29+
</tr>
30+
31+
<tr>
32+
<td><code>id</code></td>
33+
<td>Number (long)</td>
34+
<td>The id of the warning.</td>
35+
<td>:x: No</td>
36+
<td>
37+
<list>
38+
<li>Min value: 1</li>
39+
</list>
40+
</td>
41+
</tr>
42+
</table>
43+
</chapter>
944
</topic>

0 commit comments

Comments
 (0)