diff options
Diffstat (limited to 'public/api')
-rw-r--r-- | public/api/wekan.html | 84 | ||||
-rw-r--r-- | public/api/wekan.yml | 30 |
2 files changed, 110 insertions, 4 deletions
diff --git a/public/api/wekan.html b/public/api/wekan.html index 1256c251..e370e9bc 100644 --- a/public/api/wekan.html +++ b/public/api/wekan.html @@ -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.90">Wekan REST API v3.90</a> + <a href="#wekan-rest-api" class="toc-h1 toc-link" data-title="Wekan REST API v3.91">Wekan REST API v3.91</a> </li> @@ -1938,6 +1938,11 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc </li> <li> + <a href="#tocscardsvote" class="toc-h2 toc-link" data-title="CardsVote">CardsVote</a> + + </li> + + <li> <a href="#tocscardscustomfields" class="toc-h2 toc-link" data-title="CardsCustomfields">CardsCustomfields</a> </li> @@ -2017,7 +2022,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.90</h1> + <h1 id="wekan-rest-api">Wekan REST API v3.91</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> @@ -14376,7 +14381,17 @@ UserSecurity <span class="hljs-attr">"sort"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"subtaskSort"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>, - <span class="hljs-attr">"linkedId"</span>: <span class="hljs-string">"string"</span> + <span class="hljs-attr">"linkedId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"vote"</span>: { + <span class="hljs-attr">"question"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"positive"</span>: [ + <span class="hljs-string">"string"</span> + ], + <span class="hljs-attr">"negative"</span>: [ + <span class="hljs-string">"string"</span> + ], + <span class="hljs-attr">"end"</span>: <span class="hljs-string">"string"</span> + } } </code></pre> @@ -14595,6 +14610,13 @@ UserSecurity <td>none</td> <td>ID of the linked card</td> </tr> +<tr> +<td>vote</td> +<td><a href="#schemacardsvote">CardsVote</a></td> +<td>false</td> +<td>none</td> +<td>vote object, see below</td> +</tr> </tbody> </table> <h4 id="enumerated-values">Enumerated Values</h4> @@ -14708,6 +14730,62 @@ UserSecurity </tr> </tbody> </table> +<h2 id="tocscardsvote">CardsVote</h2> +<p><a id="schemacardsvote"></a></p> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"question"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"positive"</span>: [ + <span class="hljs-string">"string"</span> + ], + <span class="hljs-attr">"negative"</span>: [ + <span class="hljs-string">"string"</span> + ], + <span class="hljs-attr">"end"</span>: <span class="hljs-string">"string"</span> +} + +</code></pre> +<h3 id="properties">Properties</h3> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>question</td> +<td>string</td> +<td>true</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>positive</td> +<td>[string]</td> +<td>false</td> +<td>none</td> +<td>list of members (user IDs)</td> +</tr> +<tr> +<td>negative</td> +<td>[string]</td> +<td>false</td> +<td>none</td> +<td>list of members (user IDs)</td> +</tr> +<tr> +<td>end</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +</tbody> +</table> <h2 id="tocscardscustomfields">CardsCustomfields</h2> <p><a id="schemacardscustomfields"></a></p> <pre class="highlight tab tab-json"><code>{} diff --git a/public/api/wekan.yml b/public/api/wekan.yml index 003c260f..739e3742 100644 --- a/public/api/wekan.yml +++ b/public/api/wekan.yml @@ -1,7 +1,7 @@ swagger: '2.0' info: title: Wekan REST API - version: v3.90 + version: v3.91 description: | The REST API allows you to control and extend Wekan with ease. @@ -2523,6 +2523,11 @@ definitions: ID of the linked card type: string x-nullable: true + vote: + description: | + vote object, see below + $ref: "#/definitions/CardsVote" + x-nullable: true required: - archived - swimlaneId @@ -2532,6 +2537,29 @@ definitions: - userId - sort - type + CardsVote: + type: object + properties: + question: + type: string + positive: + description: | + list of members (user IDs) + type: array + items: + type: string + x-nullable: true + negative: + description: | + list of members (user IDs) + type: array + items: + type: string + x-nullable: true + end: + type: string + required: + - question CardsCustomfields: type: object ChecklistItems: |