This commit is contained in:
Lauri Ojansivu 2020-01-03 07:07:12 +02:00
parent be3e4af643
commit 19d42c675b
7 changed files with 57 additions and 13 deletions

View file

@ -1524,7 +1524,7 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
<ul class="toc-list-h1">
<li>
<a href="#wekan-rest-api" class="toc-h1 toc-link" data-title="Wekan REST API v3.57">Wekan REST API v3.57</a>
<a href="#wekan-rest-api" class="toc-h1 toc-link" data-title="Wekan REST API v3.58">Wekan REST API v3.58</a>
</li>
@ -2017,7 +2017,7 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
<div class="page-wrapper">
<div class="dark-box"></div>
<div class="content">
<h1 id="wekan-rest-api">Wekan REST API v3.57</h1>
<h1 id="wekan-rest-api">Wekan REST API v3.58</h1>
<blockquote>
<p>Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.</p>
</blockquote>
@ -2837,6 +2837,7 @@ $.ajax({
"isActive": true,
"isNoComments": true,
"isCommentOnly": true,
"isWorker": true,
"permission": "string",
"color": "string"
}'</span>;
@ -2947,6 +2948,7 @@ System.out.println(response.toString());
<span class="hljs-attr">isActive:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">isNoComments:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">isCommentOnly:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">isWorker:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">permission:</span> <span class="hljs-string">string</span>
<span class="hljs-attr">color:</span> <span class="hljs-string">string</span>
@ -3013,6 +3015,13 @@ System.out.println(response.toString());
<td>only enable comments (default false)</td>
</tr>
<tr>
<td>» isWorker</td>
<td>body</td>
<td>boolean</td>
<td>false</td>
<td>only move cards, assign himself to card and comment (default false)</td>
</tr>
<tr>
<td>» permission</td>
<td>body</td>
<td>string</td>
@ -3269,7 +3278,8 @@ System.out.println(response.toString());
<span class="hljs-attr">"isAdmin"</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">"isActive"</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">"isNoComments"</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">"isCommentOnly"</span>: <span class="hljs-literal">true</span>
<span class="hljs-attr">"isCommentOnly"</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">"isWorker"</span>: <span class="hljs-literal">true</span>
}
],
<span class="hljs-attr">"permission"</span>: <span class="hljs-string">"public"</span>,
@ -3884,7 +3894,8 @@ $.ajax({
<span class="hljs-keyword">const</span> inputBody = <span class="hljs-string">'{
"isAdmin": true,
"isNoComments": true,
"isCommentOnly": true
"isCommentOnly": true,
"isWorker": true
}'</span>;
<span class="hljs-keyword">const</span> headers = {
<span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>,
@ -3981,6 +3992,7 @@ System.out.println(response.toString());
<pre class="highlight tab tab-yaml"><code><span class="hljs-attr">isAdmin:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">isNoComments:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">isCommentOnly:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">isWorker:</span> <span class="hljs-literal">true</span>
</code></pre>
<h3 id="set_board_member_permission-parameters">Parameters</h3>
@ -4037,6 +4049,13 @@ System.out.println(response.toString());
<td>true</td>
<td>CommentsOnly capability</td>
</tr>
<tr>
<td>» isWorker</td>
<td>body</td>
<td>boolean</td>
<td>true</td>
<td>Worker capability</td>
</tr>
</tbody>
</table>
<h4 id="detailed-descriptions">Detailed descriptions</h4>
@ -13608,7 +13627,8 @@ UserSecurity
<span class="hljs-attr">"isAdmin"</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">"isActive"</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">"isNoComments"</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">"isCommentOnly"</span>: <span class="hljs-literal">true</span>
<span class="hljs-attr">"isCommentOnly"</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">"isWorker"</span>: <span class="hljs-literal">true</span>
}
],
<span class="hljs-attr">"permission"</span>: <span class="hljs-string">"public"</span>,
@ -14034,7 +14054,8 @@ UserSecurity
<span class="hljs-attr">"isAdmin"</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">"isActive"</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">"isNoComments"</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">"isCommentOnly"</span>: <span class="hljs-literal">true</span>
<span class="hljs-attr">"isCommentOnly"</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">"isWorker"</span>: <span class="hljs-literal">true</span>
}
</code></pre>
@ -14085,6 +14106,13 @@ UserSecurity
<td>none</td>
<td>Is the member only allowed to comment on the board</td>
</tr>
<tr>
<td>isWorker</td>
<td>boolean</td>
<td>false</td>
<td>none</td>
<td>Is the member only allowed to move card, assign himself to card and comment</td>
</tr>
</tbody>
</table>
<h2 id="tocscardcomments">CardComments</h2>

View file

@ -1,7 +1,7 @@
swagger: '2.0'
info:
title: Wekan REST API
version: v3.57
version: v3.58
description: |
The REST API allows you to control and extend Wekan with ease.
@ -211,6 +211,12 @@ paths:
only enable comments (default false)
type: boolean
required: false
- name: isWorker
in: formData
description: |
only move cards, assign himself to card and comment (default false)
type: boolean
required: false
- name: permission
in: formData
description: |
@ -1534,6 +1540,12 @@ paths:
CommentsOnly capability
type: boolean
required: true
- name: isWorker
in: formData
description: |
Worker capability
type: boolean
required: true
- name: board
in: path
description: |
@ -2215,6 +2227,10 @@ definitions:
description: |
Is the member only allowed to comment on the board
type: boolean
isWorker:
description: |
Is the member only allowed to move card, assign himself to card and comment
type: boolean
required:
- userId
- isAdmin