Andreas/wekan
1
0
Fork 0
mirror of https://github.com/wekan/wekan.git synced 2026-03-13 08:56:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

v5.59

Browse source
This commit is contained in:
Lauri Ojansivu 2021-09-17 20:39:25 +03:00
parent 6a42f738c9
commit a573083291
10 changed files with 75 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

47
public/api/wekan.html
View file

@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<title>Wekan REST API v5.58</title>
<title>Wekan REST API v5.59</title>
<style>
</style>
@ -1555,7 +1555,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 v5.58">Wekan REST API v5.58</a>
<a href="#wekan-rest-api" class="toc-h1 toc-link" data-title="Wekan REST API v5.59">Wekan REST API v5.59</a>
</li>
@ -2128,7 +2128,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 v5.58</h1>
<h1 id="wekan-rest-api">Wekan REST API v5.59</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>
@ -3568,6 +3568,7 @@ System.out.println(response.toString());
<span class="hljs-attr">&quot;allowsEndDate&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;allowsDueDate&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;presentParentTask&quot;</span>: <span class="hljs-string">&quot;prefix-with-full-path&quot;</span>,
<span class="hljs-attr">&quot;receivedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;startAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;dueAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;endAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
@ -10426,6 +10427,7 @@ Accept: application/json
&quot;showOnCard&quot;: true,
&quot;automaticallyOnCard&quot;: true,
&quot;showLabelOnMiniCard&quot;: true,
&quot;showSumAtTopOfList&quot;: true,
&quot;authorId&quot;: &quot;string&quot;
}&#x27;</span>;
<span class="hljs-keyword">const</span> headers = {
@ -10455,6 +10457,7 @@ fetch(<span class="hljs-string">&#x27;/api/boards/{board}/custom-fields&#x27;</s
<span class="hljs-string">&quot;showOnCard&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-string">&quot;automaticallyOnCard&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-string">&quot;showLabelOnMiniCard&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-string">&quot;showSumAtTopOfList&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-string">&quot;authorId&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
};
<span class="hljs-keyword">const</span> headers = {
@ -10581,6 +10584,7 @@ System.out.println(response.toString());
<span class="hljs-attr">showOnCard:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">automaticallyOnCard:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">showLabelOnMiniCard:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">showSumAtTopOfList:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">authorId:</span> <span class="hljs-string">string</span>
</code></pre>
@ -10653,6 +10657,13 @@ System.out.println(response.toString());
<td>should the label of the custom field be shown on minicards?</td>
</tr>
<tr>
<td>» showSumAtTopOfList</td>
<td>body</td>
<td>boolean</td>
<td>true</td>
<td>should the sum of the custom fields be shown at top of list?</td>
</tr>
<tr>
<td>» authorId</td>
<td>body</td>
<td>string</td>
@ -10983,7 +10994,8 @@ Accept: application/json
&quot;showOnCard&quot;: true,
&quot;automaticallyOnCard&quot;: true,
&quot;alwaysOnCard&quot;: &quot;string&quot;,
&quot;showLabelOnMiniCard&quot;: true
&quot;showLabelOnMiniCard&quot;: true,
&quot;showSumAtTopOfList&quot;: true
}&#x27;</span>;
<span class="hljs-keyword">const</span> headers = {
<span class="hljs-string">&#x27;Content-Type&#x27;</span>:<span class="hljs-string">&#x27;multipart/form-data&#x27;</span>,
@ -11012,7 +11024,8 @@ fetch(<span class="hljs-string">&#x27;/api/boards/{board}/custom-fields/{customF
<span class="hljs-string">&quot;showOnCard&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-string">&quot;automaticallyOnCard&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-string">&quot;alwaysOnCard&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-string">&quot;showLabelOnMiniCard&quot;</span>: <span class="hljs-literal">true</span>
<span class="hljs-string">&quot;showLabelOnMiniCard&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-string">&quot;showSumAtTopOfList&quot;</span>: <span class="hljs-literal">true</span>
};
<span class="hljs-keyword">const</span> headers = {
<span class="hljs-string">&#x27;Content-Type&#x27;</span>:<span class="hljs-string">&#x27;multipart/form-data&#x27;</span>,
@ -11139,6 +11152,7 @@ System.out.println(response.toString());
<span class="hljs-attr">automaticallyOnCard:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">alwaysOnCard:</span> <span class="hljs-string">string</span>
<span class="hljs-attr">showLabelOnMiniCard:</span> <span class="hljs-literal">true</span>
<span class="hljs-attr">showSumAtTopOfList:</span> <span class="hljs-literal">true</span>
</code></pre>
<h3 id="edit_custom_field-parameters">Parameters</h3>
@ -11223,6 +11237,13 @@ System.out.println(response.toString());
<td>true</td>
<td>should the label of the custom field be shown on minicards</td>
</tr>
<tr>
<td>» showSumAtTopOfList</td>
<td>body</td>
<td>boolean</td>
<td>true</td>
<td>should the sum of the custom fields be shown at top of list</td>
</tr>
</tbody>
</table>
<blockquote>
@ -18362,6 +18383,7 @@ UserSecurity
<span class="hljs-attr">&quot;allowsEndDate&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;allowsDueDate&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;presentParentTask&quot;</span>: <span class="hljs-string">&quot;prefix-with-full-path&quot;</span>,
<span class="hljs-attr">&quot;receivedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;startAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;dueAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;endAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
@ -18652,6 +18674,13 @@ UserSecurity
<td>Controls how to present the parent task:<br /><br />- <code>prefix-with-full-path</code>: add a prefix with the full path<br />- <code>prefix-with-parent</code>: add a prefisx with the parent name<br />- <code>subtext-with-full-path</code>: add a subtext with the full path<br />- <code>subtext-with-parent</code>: add a subtext with the parent name<br />- <code>no-parent</code>: does not show the parent at all</td>
</tr>
<tr>
<td>receivedAt</td>
<td>string¦null</td>
<td>false</td>
<td>none</td>
<td>Date the card was received</td>
</tr>
<tr>
<td>startAt</td>
<td>string¦null</td>
<td>false</td>
@ -20109,6 +20138,7 @@ UserSecurity
<span class="hljs-attr">&quot;automaticallyOnCard&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;alwaysOnCard&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;showLabelOnMiniCard&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;showSumAtTopOfList&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;createdAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;modifiedAt&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
}
@ -20184,6 +20214,13 @@ UserSecurity
<td>should the label of the custom field be shown on minicards?</td>
</tr>
<tr>
<td>showSumAtTopOfList</td>
<td>boolean</td>
<td>true</td>
<td>none</td>
<td>should the sum of the custom fields be shown at top of list?</td>
</tr>
<tr>
<td>createdAt</td>
<td>string¦null</td>
<td>false</td>

24
public/api/wekan.yml
View file

@ -1,7 +1,7 @@
swagger: '2.0'
info:
title: Wekan REST API
version: v5.58
version: v5.59
description: |
The REST API allows you to control and extend Wekan with ease.
@ -960,6 +960,12 @@ paths:
should the label of the custom field be shown on minicards?
type: boolean
required: true
- name: showSumAtTopOfList
in: formData
description: |
should the sum of the custom fields be shown at top of list?
type: boolean
required: true
- name: authorId
in: formData
description: the authorId value
@ -1068,6 +1074,12 @@ paths:
should the label of the custom field be shown on minicards
type: boolean
required: true
- name: showSumAtTopOfList
in: formData
description: |
should the sum of the custom fields be shown at top of list
type: boolean
required: true
- name: board
in: path
description: the board value
@ -2839,6 +2851,11 @@ definitions:
- subtext-with-parent
- no-parent
x-nullable: true
receivedAt:
description: |
Date the card was received
type: string
x-nullable: true
startAt:
description: |
Starting date of the board.
@ -3519,6 +3536,10 @@ definitions:
description: |
should the label of the custom field be shown on minicards?
type: boolean
showSumAtTopOfList:
description: |
should the sum of the custom fields be shown at top of list?
type: boolean
createdAt:
type: string
x-nullable: true
@ -3533,6 +3554,7 @@ definitions:
- automaticallyOnCard
- alwaysOnCard
- showLabelOnMiniCard
- showSumAtTopOfList
- modifiedAt
CustomFieldsSettings:
type: object