diff options
| -rw-r--r-- | CHANGELOG.md | 7 | ||||
| -rw-r--r-- | Stackerfile.yml | 2 | ||||
| -rw-r--r-- | package-lock.json | 2 | ||||
| -rw-r--r-- | package.json | 2 | ||||
| -rw-r--r-- | public/api/wekan.html | 1558 | ||||
| -rw-r--r-- | public/api/wekan.yml | 514 | ||||
| -rw-r--r-- | sandstorm-pkgdef.capnp | 4 |
7 files changed, 1704 insertions, 385 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 130ffeda..d7cc46fe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,15 @@ -# Upcoming Wekan release +# v4.16 2020-06-17 Wekan release This release adds the following features: - [Add find-replace.sh script for development](https://github.com/wekan/wekan/commit/bda49ed60947e0438206b2f55119f5c5c132c734). Thanks to xet7. +and adds the following updates: + +- [Upgrade to Node 12.18.1](https://github.com/wekan/wekan/commit/b11ae567c9b2d16a115ea4f3f7f88e67d076f326). + Thanks to Node developers and xet7. + and fixes the following bugs: - [OpenAPI: Fix jsdoc/operation matching](https://github.com/wekan/wekan/pull/3171). diff --git a/Stackerfile.yml b/Stackerfile.yml index 50325d47..b9bc688d 100644 --- a/Stackerfile.yml +++ b/Stackerfile.yml @@ -1,5 +1,5 @@ appId: wekan-public/apps/77b94f60-dec9-0136-304e-16ff53095928 -appVersion: "v4.15.0" +appVersion: "v4.16.0" files: userUploads: - README.md diff --git a/package-lock.json b/package-lock.json index c49fb5a4..d41a22db 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "wekan", - "version": "v4.15.0", + "version": "v4.16.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 5cb1e9f8..398bc04e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "wekan", - "version": "v4.15.0", + "version": "v4.16.0", "description": "Open-Source kanban", "private": true, "scripts": { diff --git a/public/api/wekan.html b/public/api/wekan.html index d315f3ca..92794307 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 v4.15">Wekan REST API v4.15</a> + <a href="#wekan-rest-api" class="toc-h1 toc-link" data-title="Wekan REST API v4.16">Wekan REST API v4.16</a> </li> @@ -1612,22 +1612,22 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc <ul class="toc-list-h2"> <li> - <a href="#get_board_card_checklists" class="toc-h2 toc-link" data-title="get_board_card_checklists">get_board_card_checklists</a> + <a href="#get_all_checklists" class="toc-h2 toc-link" data-title="get_all_checklists">get_all_checklists</a> </li> <li> - <a href="#post_board_card_checklists" class="toc-h2 toc-link" data-title="post_board_card_checklists">post_board_card_checklists</a> + <a href="#new_checklist" class="toc-h2 toc-link" data-title="new_checklist">new_checklist</a> </li> <li> - <a href="#get_board_card_checklist" class="toc-h2 toc-link" data-title="get_board_card_checklist">get_board_card_checklist</a> + <a href="#get_checklist" class="toc-h2 toc-link" data-title="get_checklist">get_checklist</a> </li> <li> - <a href="#delete_board_card_checklist" class="toc-h2 toc-link" data-title="delete_board_card_checklist">delete_board_card_checklist</a> + <a href="#delete_checklist" class="toc-h2 toc-link" data-title="delete_checklist">delete_checklist</a> </li> @@ -1641,17 +1641,17 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc <ul class="toc-list-h2"> <li> - <a href="#get_board_card_checklist_item" class="toc-h2 toc-link" data-title="get_board_card_checklist_item">get_board_card_checklist_item</a> + <a href="#get_checklist_item" class="toc-h2 toc-link" data-title="get_checklist_item">get_checklist_item</a> </li> <li> - <a href="#put_board_card_checklist_item" class="toc-h2 toc-link" data-title="put_board_card_checklist_item">put_board_card_checklist_item</a> + <a href="#edit_checklist_item" class="toc-h2 toc-link" data-title="edit_checklist_item">edit_checklist_item</a> </li> <li> - <a href="#delete_board_card_checklist_item" class="toc-h2 toc-link" data-title="delete_board_card_checklist_item">delete_board_card_checklist_item</a> + <a href="#delete_checklist_item" class="toc-h2 toc-link" data-title="delete_checklist_item">delete_checklist_item</a> </li> @@ -1670,17 +1670,17 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc </li> <li> - <a href="#post_board_card_comments" class="toc-h2 toc-link" data-title="post_board_card_comments">post_board_card_comments</a> + <a href="#new_comment" class="toc-h2 toc-link" data-title="new_comment">new_comment</a> </li> <li> - <a href="#get_board_card_comment" class="toc-h2 toc-link" data-title="get_board_card_comment">get_board_card_comment</a> + <a href="#get_comment" class="toc-h2 toc-link" data-title="get_comment">get_comment</a> </li> <li> - <a href="#delete_board_card_comment" class="toc-h2 toc-link" data-title="delete_board_card_comment">delete_board_card_comment</a> + <a href="#delete_comment" class="toc-h2 toc-link" data-title="delete_comment">delete_comment</a> </li> @@ -1694,7 +1694,7 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc <ul class="toc-list-h2"> <li> - <a href="#get_board_customfieldvalue" class="toc-h2 toc-link" data-title="get_board_customFieldValue">get_board_customFieldValue</a> + <a href="#get_cards_by_custom_field" class="toc-h2 toc-link" data-title="get_cards_by_custom_field">get_cards_by_custom_field</a> </li> @@ -1709,22 +1709,22 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc </li> <li> - <a href="#get_board_list_card" class="toc-h2 toc-link" data-title="get_board_list_card">get_board_list_card</a> + <a href="#get_card" class="toc-h2 toc-link" data-title="get_card">get_card</a> </li> <li> - <a href="#put_board_list_card" class="toc-h2 toc-link" data-title="put_board_list_card">put_board_list_card</a> + <a href="#edit_card" class="toc-h2 toc-link" data-title="edit_card">edit_card</a> </li> <li> - <a href="#delete_board_list_card" class="toc-h2 toc-link" data-title="delete_board_list_card">delete_board_list_card</a> + <a href="#delete_card" class="toc-h2 toc-link" data-title="delete_card">delete_card</a> </li> <li> - <a href="#get_board_swimlane_cards" class="toc-h2 toc-link" data-title="get_board_swimlane_cards">get_board_swimlane_cards</a> + <a href="#get_swimlane_cards" class="toc-h2 toc-link" data-title="get_swimlane_cards">get_swimlane_cards</a> </li> @@ -1748,12 +1748,12 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc </li> <li> - <a href="#get_board_customfield" class="toc-h2 toc-link" data-title="get_board_customField">get_board_customField</a> + <a href="#get_custom_field" class="toc-h2 toc-link" data-title="get_custom_field">get_custom_field</a> </li> <li> - <a href="#delete_board_customfield" class="toc-h2 toc-link" data-title="delete_board_customField">delete_board_customField</a> + <a href="#delete_custom_field" class="toc-h2 toc-link" data-title="delete_custom_field">delete_custom_field</a> </li> @@ -1792,12 +1792,12 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc </li> <li> - <a href="#delete_board_int_activities" class="toc-h2 toc-link" data-title="delete_board_int_activities">delete_board_int_activities</a> + <a href="#delete_integration_activities" class="toc-h2 toc-link" data-title="delete_integration_activities">delete_integration_activities</a> </li> <li> - <a href="#post_board_int_activities" class="toc-h2 toc-link" data-title="post_board_int_activities">post_board_int_activities</a> + <a href="#new_integration_activities" class="toc-h2 toc-link" data-title="new_integration_activities">new_integration_activities</a> </li> @@ -1845,7 +1845,7 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc </li> <li> - <a href="#post_board_user_remove" class="toc-h2 toc-link" data-title="post_board_user_remove">post_board_user_remove</a> + <a href="#remove_board_member" class="toc-h2 toc-link" data-title="remove_board_member">remove_board_member</a> </li> @@ -1904,7 +1904,7 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc </li> <li> - <a href="#delete_board_swimlane" class="toc-h2 toc-link" data-title="delete_board_swimlane">delete_board_swimlane</a> + <a href="#delete_swimlane" class="toc-h2 toc-link" data-title="delete_swimlane">delete_swimlane</a> </li> @@ -2027,7 +2027,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 v4.15</h1> + <h1 id="wekan-rest-api">Wekan REST API v4.16</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> @@ -4325,20 +4325,24 @@ To perform this operation, you must be authenticated by means of one of the foll UserSecurity </aside> <h1 id="wekan-rest-api-checklists">Checklists</h1> -<h2 id="get_board_card_checklists">get_board_card_checklists</h2> -<p><a id="opIdget_board_card_checklists"></a></p> +<h2 id="get_all_checklists">get_all_checklists</h2> +<p><a id="opIdget_all_checklists"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X GET /api/boards/{board}/cards/{card}/checklists \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/cards/{card}/checklists</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -4357,6 +4361,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -4378,6 +4383,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists'</s <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -4390,6 +4396,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -4425,6 +4432,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -4440,7 +4448,8 @@ System.out.println(response.toString()); </code></pre> <p><code>GET /api/boards/{board}/cards/{card}/checklists</code></p> -<h3 id="get_board_card_checklists-parameters">Parameters</h3> +<p><em>Get the list of checklists attached to a card</em></p> +<h3 id="get_all_checklists-parameters">Parameters</h3> <table> <thead> <tr> @@ -4457,18 +4466,34 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</td> </tr> <tr> <td>card</td> <td>path</td> <td>string</td> <td>true</td> -<td>the card value</td> +<td>the card ID</td> </tr> </tbody> </table> -<h3 id="get_board_card_checklists-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>card</strong>: the card ID</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>[ + { + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span> + } +] +</code></pre> +<h3 id="get_all_checklists-responses">Responses</h3> <table> <thead> <tr> @@ -4483,7 +4508,36 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="get_all_checklists-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» title</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> @@ -4491,24 +4545,27 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="post_board_card_checklists">post_board_card_checklists</h2> -<p><a id="opIdpost_board_card_checklists"></a></p> +<h2 id="new_checklist">new_checklist</h2> +<p><a id="opIdnew_checklist"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X POST /api/boards/{board}/cards/{card}/checklists \ -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/cards/{card}/checklists</span> HTTP/1.1 <span class="fortran">Content-<span class="hljs-keyword">Type</span>: multipart/<span class="hljs-keyword">form</span>-<span class="hljs-keyword">data</span> +Accept: application/json </span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -4531,6 +4588,7 @@ $.ajax({ }'</span>; <span class="hljs-keyword">const</span> headers = { <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -4553,6 +4611,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists'</s headers = { <span class="hljs-string">'Content-Type'</span> => <span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -4566,6 +4625,7 @@ p JSON.parse(result) <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -4602,6 +4662,7 @@ System.out.println(response.toString()); headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ <span class="hljs-string">"Content-Type"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"multipart/form-data"</span>}, + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -4617,6 +4678,7 @@ System.out.println(response.toString()); </code></pre> <p><code>POST /api/boards/{board}/cards/{card}/checklists</code></p> +<p><em>create a new checklist</em></p> <blockquote> <p>Body parameter</p> </blockquote> @@ -4624,7 +4686,7 @@ System.out.println(response.toString()); <span class="hljs-attr">items:</span> <span class="hljs-string">string</span> </code></pre> -<h3 id="post_board_card_checklists-parameters">Parameters</h3> +<h3 id="new_checklist-parameters">Parameters</h3> <table> <thead> <tr> @@ -4641,14 +4703,14 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</td> </tr> <tr> <td>card</td> <td>path</td> <td>string</td> <td>true</td> -<td>the card value</td> +<td>the card ID</td> </tr> <tr> <td>body</td> @@ -4662,18 +4724,31 @@ System.out.println(response.toString()); <td>body</td> <td>string</td> <td>true</td> -<td>the title value</td> +<td>the title of the new checklist</td> </tr> <tr> <td>» items</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the items value</td> +<td>false</td> +<td>the list of items on the new checklist</td> </tr> </tbody> </table> -<h3 id="post_board_card_checklists-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>card</strong>: the card ID</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="new_checklist-responses">Responses</h3> <table> <thead> <tr> @@ -4688,7 +4763,29 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="new_checklist-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> @@ -4696,20 +4793,24 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="get_board_card_checklist">get_board_card_checklist</h2> -<p><a id="opIdget_board_card_checklist"></a></p> +<h2 id="get_checklist">get_checklist</h2> +<p><a id="opIdget_checklist"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X GET /api/boards/{board}/cards/{card}/checklists/{checklist} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/cards/{card}/checklists/{checklist}</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -4728,6 +4829,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -4749,6 +4851,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{ch <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -4761,6 +4864,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -4796,6 +4900,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -4811,7 +4916,8 @@ System.out.println(response.toString()); </code></pre> <p><code>GET /api/boards/{board}/cards/{card}/checklists/{checklist}</code></p> -<h3 id="get_board_card_checklist-parameters">Parameters</h3> +<p><em>Get a checklist</em></p> +<h3 id="get_checklist-parameters">Parameters</h3> <table> <thead> <tr> @@ -4828,25 +4934,50 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</td> </tr> <tr> <td>card</td> <td>path</td> <td>string</td> <td>true</td> -<td>the card value</td> +<td>the card ID</td> </tr> <tr> <td>checklist</td> <td>path</td> <td>string</td> <td>true</td> -<td>the checklist value</td> +<td>the ID of the checklist</td> </tr> </tbody> </table> -<h3 id="get_board_card_checklist-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>card</strong>: the card ID</p> +<p><strong>checklist</strong>: the ID of the checklist</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"cardId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"finishedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"sort"</span>: <span class="hljs-number">0</span>, + <span class="hljs-attr">"items"</span>: [ + { + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"isFinished"</span>: <span class="hljs-literal">true</span> + } + ] +} +</code></pre> +<h3 id="get_checklist-responses">Responses</h3> <table> <thead> <tr> @@ -4861,7 +4992,85 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="get_checklist-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» cardId</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» title</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» finishedAt</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» createdAt</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» sort</td> +<td>number</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» items</td> +<td>[object]</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>»» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>»» title</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>»» isFinished</td> +<td>boolean</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> @@ -4869,20 +5078,24 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="delete_board_card_checklist">delete_board_card_checklist</h2> -<p><a id="opIddelete_board_card_checklist"></a></p> +<h2 id="delete_checklist">delete_checklist</h2> +<p><a id="opIddelete_checklist"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X DELETE /api/boards/{board}/cards/{card}/checklists/{checklist} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/cards/{card}/checklists/{checklist}</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -4901,6 +5114,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -4922,6 +5136,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{ch <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -4934,6 +5149,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -4969,6 +5185,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -4984,7 +5201,9 @@ System.out.println(response.toString()); </code></pre> <p><code>DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}</code></p> -<h3 id="delete_board_card_checklist-parameters">Parameters</h3> +<p><em>Delete a checklist</em></p> +<p>The checklist will be removed, not put in the recycle bin.</p> +<h3 id="delete_checklist-parameters">Parameters</h3> <table> <thead> <tr> @@ -5001,25 +5220,39 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</td> </tr> <tr> <td>card</td> <td>path</td> <td>string</td> <td>true</td> -<td>the card value</td> +<td>the card ID</td> </tr> <tr> <td>checklist</td> <td>path</td> <td>string</td> <td>true</td> -<td>the checklist value</td> +<td>the ID of the checklist to remove</td> </tr> </tbody> </table> -<h3 id="delete_board_card_checklist-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>card</strong>: the card ID</p> +<p><strong>checklist</strong>: the ID of the checklist to remove</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="delete_checklist-responses">Responses</h3> <table> <thead> <tr> @@ -5034,7 +5267,29 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="delete_checklist-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> @@ -5043,20 +5298,24 @@ To perform this operation, you must be authenticated by means of one of the foll UserSecurity </aside> <h1 id="wekan-rest-api-checklistitems">ChecklistItems</h1> -<h2 id="get_board_card_checklist_item">get_board_card_checklist_item</h2> -<p><a id="opIdget_board_card_checklist_item"></a></p> +<h2 id="get_checklist_item">get_checklist_item</h2> +<p><a id="opIdget_checklist_item"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X GET /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -5075,6 +5334,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -5096,6 +5356,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{ch <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -5108,6 +5369,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -5143,6 +5405,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -5158,7 +5421,8 @@ System.out.println(response.toString()); </code></pre> <p><code>GET /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}</code></p> -<h3 id="get_board_card_checklist_item-parameters">Parameters</h3> +<p><em>Get a checklist item</em></p> +<h3 id="get_checklist_item-parameters">Parameters</h3> <table> <thead> <tr> @@ -5175,32 +5439,53 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</td> </tr> <tr> <td>card</td> <td>path</td> <td>string</td> <td>true</td> -<td>the card value</td> +<td>the card ID</td> </tr> <tr> <td>checklist</td> <td>path</td> <td>string</td> <td>true</td> -<td>the checklist value</td> +<td>the checklist ID</td> </tr> <tr> <td>item</td> <td>path</td> <td>string</td> <td>true</td> -<td>the item value</td> +<td>the ID of the item</td> </tr> </tbody> </table> -<h3 id="get_board_card_checklist_item-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>card</strong>: the card ID</p> +<p><strong>checklist</strong>: the checklist ID</p> +<p><strong>item</strong>: the ID of the item</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"sort"</span>: <span class="hljs-number">0</span>, + <span class="hljs-attr">"isFinished"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"checklistId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"cardId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"modifiedAt"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="get_checklist_item-responses">Responses</h3> <table> <thead> <tr> @@ -5215,7 +5500,7 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td><a href="#schemachecklistitems">ChecklistItems</a></td> </tr> </tbody> </table> @@ -5223,24 +5508,27 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="put_board_card_checklist_item">put_board_card_checklist_item</h2> -<p><a id="opIdput_board_card_checklist_item"></a></p> +<h2 id="edit_checklist_item">edit_checklist_item</h2> +<p><a id="opIdedit_checklist_item"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X PUT /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} \ -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">PUT</span> <span class="hljs-string">/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}</span> HTTP/1.1 <span class="fortran">Content-<span class="hljs-keyword">Type</span>: multipart/<span class="hljs-keyword">form</span>-<span class="hljs-keyword">data</span> +Accept: application/json </span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -5263,6 +5551,7 @@ $.ajax({ }'</span>; <span class="hljs-keyword">const</span> headers = { <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -5285,6 +5574,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{ch headers = { <span class="hljs-string">'Content-Type'</span> => <span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -5298,6 +5588,7 @@ p JSON.parse(result) <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -5334,6 +5625,7 @@ System.out.println(response.toString()); headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ <span class="hljs-string">"Content-Type"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"multipart/form-data"</span>}, + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -5349,6 +5641,7 @@ System.out.println(response.toString()); </code></pre> <p><code>PUT /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}</code></p> +<p><em>Edit a checklist item</em></p> <blockquote> <p>Body parameter</p> </blockquote> @@ -5356,7 +5649,7 @@ System.out.println(response.toString()); <span class="hljs-attr">title:</span> <span class="hljs-string">string</span> </code></pre> -<h3 id="put_board_card_checklist_item-parameters">Parameters</h3> +<h3 id="edit_checklist_item-parameters">Parameters</h3> <table> <thead> <tr> @@ -5373,28 +5666,28 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</td> </tr> <tr> <td>card</td> <td>path</td> <td>string</td> <td>true</td> -<td>the card value</td> +<td>the card ID</td> </tr> <tr> <td>checklist</td> <td>path</td> <td>string</td> <td>true</td> -<td>the checklist value</td> +<td>the checklist ID</td> </tr> <tr> <td>item</td> <td>path</td> <td>string</td> <td>true</td> -<td>the item value</td> +<td>the ID of the item</td> </tr> <tr> <td>body</td> @@ -5407,19 +5700,34 @@ System.out.println(response.toString()); <td>» isFinished</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the isFinished value</td> +<td>false</td> +<td>is the item checked?</td> </tr> <tr> <td>» title</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the title value</td> +<td>false</td> +<td>the new text of the item</td> </tr> </tbody> </table> -<h3 id="put_board_card_checklist_item-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>card</strong>: the card ID</p> +<p><strong>checklist</strong>: the checklist ID</p> +<p><strong>item</strong>: the ID of the item</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="edit_checklist_item-responses">Responses</h3> <table> <thead> <tr> @@ -5434,7 +5742,29 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="edit_checklist_item-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> @@ -5442,20 +5772,24 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="delete_board_card_checklist_item">delete_board_card_checklist_item</h2> -<p><a id="opIddelete_board_card_checklist_item"></a></p> +<h2 id="delete_checklist_item">delete_checklist_item</h2> +<p><a id="opIddelete_checklist_item"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -5474,6 +5808,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -5495,6 +5830,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/checklists/{ch <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -5507,6 +5843,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -5542,6 +5879,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -5557,7 +5895,9 @@ System.out.println(response.toString()); </code></pre> <p><code>DELETE /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}</code></p> -<h3 id="delete_board_card_checklist_item-parameters">Parameters</h3> +<p><em>Delete a checklist item</em></p> +<p>Note: this operation can't be reverted.</p> +<h3 id="delete_checklist_item-parameters">Parameters</h3> <table> <thead> <tr> @@ -5574,32 +5914,47 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</td> </tr> <tr> <td>card</td> <td>path</td> <td>string</td> <td>true</td> -<td>the card value</td> +<td>the card ID</td> </tr> <tr> <td>checklist</td> <td>path</td> <td>string</td> <td>true</td> -<td>the checklist value</td> +<td>the checklist ID</td> </tr> <tr> <td>item</td> <td>path</td> <td>string</td> <td>true</td> -<td>the item value</td> +<td>the ID of the item to be removed</td> </tr> </tbody> </table> -<h3 id="delete_board_card_checklist_item-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>card</strong>: the card ID</p> +<p><strong>checklist</strong>: the checklist ID</p> +<p><strong>item</strong>: the ID of the item to be removed</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="delete_checklist_item-responses">Responses</h3> <table> <thead> <tr> @@ -5614,7 +5969,29 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="delete_checklist_item-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> @@ -5851,24 +6228,27 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="post_board_card_comments">post_board_card_comments</h2> -<p><a id="opIdpost_board_card_comments"></a></p> +<h2 id="new_comment">new_comment</h2> +<p><a id="opIdnew_comment"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X POST /api/boards/{board}/cards/{card}/comments \ -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/cards/{card}/comments</span> HTTP/1.1 <span class="fortran">Content-<span class="hljs-keyword">Type</span>: multipart/<span class="hljs-keyword">form</span>-<span class="hljs-keyword">data</span> +Accept: application/json </span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -5891,6 +6271,7 @@ $.ajax({ }'</span>; <span class="hljs-keyword">const</span> headers = { <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -5913,6 +6294,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/comments'</spa headers = { <span class="hljs-string">'Content-Type'</span> => <span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -5926,6 +6308,7 @@ p JSON.parse(result) <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -5962,6 +6345,7 @@ System.out.println(response.toString()); headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ <span class="hljs-string">"Content-Type"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"multipart/form-data"</span>}, + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -5977,6 +6361,7 @@ System.out.println(response.toString()); </code></pre> <p><code>POST /api/boards/{board}/cards/{card}/comments</code></p> +<p><em>Add a comment on a card</em></p> <blockquote> <p>Body parameter</p> </blockquote> @@ -5984,7 +6369,7 @@ System.out.println(response.toString()); <span class="hljs-attr">comment:</span> <span class="hljs-string">string</span> </code></pre> -<h3 id="post_board_card_comments-parameters">Parameters</h3> +<h3 id="new_comment-parameters">Parameters</h3> <table> <thead> <tr> @@ -6001,14 +6386,14 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID of the card</td> </tr> <tr> <td>card</td> <td>path</td> <td>string</td> <td>true</td> -<td>the card value</td> +<td>the ID of the card</td> </tr> <tr> <td>body</td> @@ -6022,7 +6407,7 @@ System.out.println(response.toString()); <td>body</td> <td>string</td> <td>true</td> -<td>the authorId value</td> +<td>the user who 'posted' the comment</td> </tr> <tr> <td>» comment</td> @@ -6033,7 +6418,20 @@ System.out.println(response.toString()); </tr> </tbody> </table> -<h3 id="post_board_card_comments-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID of the card</p> +<p><strong>card</strong>: the ID of the card</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="new_comment-responses">Responses</h3> <table> <thead> <tr> @@ -6048,7 +6446,29 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="new_comment-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> @@ -6056,20 +6476,24 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="get_board_card_comment">get_board_card_comment</h2> -<p><a id="opIdget_board_card_comment"></a></p> +<h2 id="get_comment">get_comment</h2> +<p><a id="opIdget_comment"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X GET /api/boards/{board}/cards/{card}/comments/{comment} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/cards/{card}/comments/{comment}</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -6088,6 +6512,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -6109,6 +6534,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/comments/{comm <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -6121,6 +6547,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -6156,6 +6583,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -6171,7 +6599,8 @@ System.out.println(response.toString()); </code></pre> <p><code>GET /api/boards/{board}/cards/{card}/comments/{comment}</code></p> -<h3 id="get_board_card_comment-parameters">Parameters</h3> +<p><em>Get a comment on a card</em></p> +<h3 id="get_comment-parameters">Parameters</h3> <table> <thead> <tr> @@ -6188,25 +6617,44 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID of the card</td> </tr> <tr> <td>card</td> <td>path</td> <td>string</td> <td>true</td> -<td>the card value</td> +<td>the ID of the card</td> </tr> <tr> <td>comment</td> <td>path</td> <td>string</td> <td>true</td> -<td>the comment value</td> +<td>the ID of the comment to retrieve</td> </tr> </tbody> </table> -<h3 id="get_board_card_comment-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID of the card</p> +<p><strong>card</strong>: the ID of the card</p> +<p><strong>comment</strong>: the ID of the comment to retrieve</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"boardId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"cardId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"text"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"modifiedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"userId"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="get_comment-responses">Responses</h3> <table> <thead> <tr> @@ -6221,7 +6669,7 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td><a href="#schemacardcomments">CardComments</a></td> </tr> </tbody> </table> @@ -6229,20 +6677,24 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="delete_board_card_comment">delete_board_card_comment</h2> -<p><a id="opIddelete_board_card_comment"></a></p> +<h2 id="delete_comment">delete_comment</h2> +<p><a id="opIddelete_comment"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X DELETE /api/boards/{board}/cards/{card}/comments/{comment} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/cards/{card}/comments/{comment}</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -6261,6 +6713,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -6282,6 +6735,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/cards/{card}/comments/{comm <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -6294,6 +6748,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -6329,6 +6784,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -6344,7 +6800,8 @@ System.out.println(response.toString()); </code></pre> <p><code>DELETE /api/boards/{board}/cards/{card}/comments/{comment}</code></p> -<h3 id="delete_board_card_comment-parameters">Parameters</h3> +<p><em>Delete a comment on a card</em></p> +<h3 id="delete_comment-parameters">Parameters</h3> <table> <thead> <tr> @@ -6361,25 +6818,39 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID of the card</td> </tr> <tr> <td>card</td> <td>path</td> <td>string</td> <td>true</td> -<td>the card value</td> +<td>the ID of the card</td> </tr> <tr> <td>comment</td> <td>path</td> <td>string</td> <td>true</td> -<td>the comment value</td> +<td>the ID of the comment to delete</td> </tr> </tbody> </table> -<h3 id="delete_board_card_comment-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID of the card</p> +<p><strong>card</strong>: the ID of the card</p> +<p><strong>comment</strong>: the ID of the comment to delete</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="delete_comment-responses">Responses</h3> <table> <thead> <tr> @@ -6394,7 +6865,29 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="delete_comment-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> @@ -6403,20 +6896,24 @@ To perform this operation, you must be authenticated by means of one of the foll UserSecurity </aside> <h1 id="wekan-rest-api-cards">Cards</h1> -<h2 id="get_board_customfieldvalue">get_board_customFieldValue</h2> -<p><a id="opIdget_board_customFieldValue"></a></p> +<h2 id="get_cards_by_custom_field">get_cards_by_custom_field</h2> +<p><a id="opIdget_cards_by_custom_field"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X GET /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -6435,6 +6932,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -6456,6 +6954,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/cardsByCustomField/{customF <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -6468,6 +6967,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -6503,6 +7003,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -6518,7 +7019,8 @@ System.out.println(response.toString()); </code></pre> <p><code>GET /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}</code></p> -<h3 id="get_board_customfieldvalue-parameters">Parameters</h3> +<p><em>Get all Cards that matchs a value of a specific custom field</em></p> +<h3 id="get_cards_by_custom_field-parameters">Parameters</h3> <table> <thead> <tr> @@ -6535,25 +7037,45 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</td> </tr> <tr> <td>customField</td> <td>path</td> <td>string</td> <td>true</td> -<td>the customField value</td> +<td>the list ID</td> </tr> <tr> <td>customFieldValue</td> <td>path</td> <td>string</td> <td>true</td> -<td>the customFieldValue value</td> +<td>the value to look for</td> </tr> </tbody> </table> -<h3 id="get_board_customfieldvalue-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>customField</strong>: the list ID</p> +<p><strong>customFieldValue</strong>: the value to look for</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>[ + { + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"listId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"swinlaneId"</span>: <span class="hljs-string">"string"</span> + } +] +</code></pre> +<h3 id="get_cards_by_custom_field-responses">Responses</h3> <table> <thead> <tr> @@ -6568,7 +7090,57 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="get_cards_by_custom_field-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» title</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» description</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» listId</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» swinlaneId</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> @@ -7088,20 +7660,24 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="get_board_list_card">get_board_list_card</h2> -<p><a id="opIdget_board_list_card"></a></p> +<h2 id="get_card">get_card</h2> +<p><a id="opIdget_card"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X GET /api/boards/{board}/lists/{list}/cards/{card} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/lists/{list}/cards/{card}</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -7120,6 +7696,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -7141,6 +7718,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'< <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -7153,6 +7731,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -7188,6 +7767,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -7203,7 +7783,8 @@ System.out.println(response.toString()); </code></pre> <p><code>GET /api/boards/{board}/lists/{list}/cards/{card}</code></p> -<h3 id="get_board_list_card-parameters">Parameters</h3> +<p><em>Get a Card</em></p> +<h3 id="get_card-parameters">Parameters</h3> <table> <thead> <tr> @@ -7220,25 +7801,87 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</td> </tr> <tr> <td>list</td> <td>path</td> <td>string</td> <td>true</td> -<td>the list value</td> +<td>the list ID of the card</td> </tr> <tr> <td>card</td> <td>path</td> <td>string</td> <td>true</td> -<td>the card value</td> +<td>the card ID</td> </tr> </tbody> </table> -<h3 id="get_board_list_card-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>list</strong>: the list ID of the card</p> +<p><strong>card</strong>: the card ID</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"archived"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"parentId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"listId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"swimlaneId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"boardId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"coverId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"color"</span>: <span class="hljs-string">"white"</span>, + <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"modifiedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"customFields"</span>: [ + {} + ], + <span class="hljs-attr">"dateLastActivity"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"requestedBy"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"assignedBy"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"labelIds"</span>: [ + <span class="hljs-string">"string"</span> + ], + <span class="hljs-attr">"members"</span>: [ + <span class="hljs-string">"string"</span> + ], + <span class="hljs-attr">"assignees"</span>: [ + <span class="hljs-string">"string"</span> + ], + <span class="hljs-attr">"receivedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"startAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"dueAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"endAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"spentTime"</span>: <span class="hljs-number">0</span>, + <span class="hljs-attr">"isOvertime"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"userId"</span>: <span class="hljs-string">"string"</span>, + <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">"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>, + <span class="hljs-attr">"public"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"allowNonBoardMembers"</span>: <span class="hljs-literal">true</span> + } +} +</code></pre> +<h3 id="get_card-responses">Responses</h3> <table> <thead> <tr> @@ -7253,7 +7896,7 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td><a href="#schemacards">Cards</a></td> </tr> </tbody> </table> @@ -7261,24 +7904,27 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="put_board_list_card">put_board_list_card</h2> -<p><a id="opIdput_board_list_card"></a></p> +<h2 id="edit_card">edit_card</h2> +<p><a id="opIdedit_card"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X PUT /api/boards/{board}/lists/{list}/cards/{card} \ -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">PUT</span> <span class="hljs-string">/api/boards/{board}/lists/{list}/cards/{card}</span> HTTP/1.1 <span class="fortran">Content-<span class="hljs-keyword">Type</span>: multipart/<span class="hljs-keyword">form</span>-<span class="hljs-keyword">data</span> +Accept: application/json </span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -7302,7 +7948,7 @@ $.ajax({ "parentId": "string", "description": "string", "color": "string", - "vote": "string", + "vote": {}, "labelIds": "string", "requestedBy": "string", "assignedBy": "string", @@ -7311,7 +7957,7 @@ $.ajax({ "dueAt": "string", "endAt": "string", "spentTime": "string", - "isOverTime": "string", + "isOverTime": true, "customFields": "string", "members": "string", "assignees": "string", @@ -7319,6 +7965,7 @@ $.ajax({ }'</span>; <span class="hljs-keyword">const</span> headers = { <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -7341,6 +7988,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'< headers = { <span class="hljs-string">'Content-Type'</span> => <span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -7354,6 +8002,7 @@ p JSON.parse(result) <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -7390,6 +8039,7 @@ System.out.println(response.toString()); headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ <span class="hljs-string">"Content-Type"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"multipart/form-data"</span>}, + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -7405,6 +8055,15 @@ System.out.println(response.toString()); </code></pre> <p><code>PUT /api/boards/{board}/lists/{list}/cards/{card}</code></p> +<p><em>Edit Fields in a Card</em></p> +<p>Edit a card</p> +<p>The color has to be chosen between <code>white</code>, <code>green</code>, <code>yellow</code>, <code>orange</code>, +<code>red</code>, <code>purple</code>, <code>blue</code>, <code>sky</code>, <code>lime</code>, <code>pink</code>, <code>black</code>, <code>silver</code>, +<code>peachpuff</code>, <code>crimson</code>, <code>plum</code>, <code>darkgreen</code>, <code>slateblue</code>, <code>magenta</code>, +<code>gold</code>, <code>navy</code>, <code>gray</code>, <code>saddlebrown</code>, <code>paleturquoise</code>, <code>mistyrose</code>, +<code>indigo</code>:</p> + <img src="/card-colors.png" alt="Wekan card colors" /> +<p>Note: setting the color to white has the same effect than removing it.</p> <blockquote> <p>Body parameter</p> </blockquote> @@ -7414,7 +8073,7 @@ System.out.println(response.toString()); <span class="hljs-attr">parentId:</span> <span class="hljs-string">string</span> <span class="hljs-attr">description:</span> <span class="hljs-string">string</span> <span class="hljs-attr">color:</span> <span class="hljs-string">string</span> -<span class="hljs-attr">vote:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">vote:</span> <span class="hljs-string">{}</span> <span class="hljs-attr">labelIds:</span> <span class="hljs-string">string</span> <span class="hljs-attr">requestedBy:</span> <span class="hljs-string">string</span> <span class="hljs-attr">assignedBy:</span> <span class="hljs-string">string</span> @@ -7423,14 +8082,14 @@ System.out.println(response.toString()); <span class="hljs-attr">dueAt:</span> <span class="hljs-string">string</span> <span class="hljs-attr">endAt:</span> <span class="hljs-string">string</span> <span class="hljs-attr">spentTime:</span> <span class="hljs-string">string</span> -<span class="hljs-attr">isOverTime:</span> <span class="hljs-string">string</span> +<span class="hljs-attr">isOverTime:</span> <span class="hljs-literal">true</span> <span class="hljs-attr">customFields:</span> <span class="hljs-string">string</span> <span class="hljs-attr">members:</span> <span class="hljs-string">string</span> <span class="hljs-attr">assignees:</span> <span class="hljs-string">string</span> <span class="hljs-attr">swimlaneId:</span> <span class="hljs-string">string</span> </code></pre> -<h3 id="put_board_list_card-parameters">Parameters</h3> +<h3 id="edit_card-parameters">Parameters</h3> <table> <thead> <tr> @@ -7447,21 +8106,21 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID of the card</td> </tr> <tr> <td>list</td> <td>path</td> <td>string</td> <td>true</td> -<td>the list value</td> +<td>the list ID of the card</td> </tr> <tr> <td>card</td> <td>path</td> <td>string</td> <td>true</td> -<td>the card value</td> +<td>the ID of the card</td> </tr> <tr> <td>body</td> @@ -7474,145 +8133,159 @@ System.out.println(response.toString()); <td>» title</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the title value</td> +<td>false</td> +<td>the new title of the card</td> </tr> <tr> <td>» listId</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the listId value</td> +<td>false</td> +<td>the new list ID of the card (move operation)</td> </tr> <tr> <td>» authorId</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the authorId value</td> +<td>false</td> +<td>change the owner of the card</td> </tr> <tr> <td>» parentId</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the parentId value</td> +<td>false</td> +<td>change the parent of the card</td> </tr> <tr> <td>» description</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the description value</td> +<td>false</td> +<td>the new description of the card</td> </tr> <tr> <td>» color</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the color value</td> +<td>false</td> +<td>the new color of the card</td> </tr> <tr> <td>» vote</td> <td>body</td> -<td>string</td> -<td>true</td> -<td>the vote value</td> +<td>object</td> +<td>false</td> +<td>the vote object</td> </tr> <tr> <td>» labelIds</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the labelIds value</td> +<td>false</td> +<td>the new list of label IDs attached to the card</td> </tr> <tr> <td>» requestedBy</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the requestedBy value</td> +<td>false</td> +<td>the new requestedBy field of the card</td> </tr> <tr> <td>» assignedBy</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the assignedBy value</td> +<td>false</td> +<td>the new assignedBy field of the card</td> </tr> <tr> <td>» receivedAt</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the receivedAt value</td> +<td>false</td> +<td>the new receivedAt field of the card</td> </tr> <tr> <td>» startAt</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the startAt value</td> +<td>false</td> +<td>the new startAt field of the card</td> </tr> <tr> <td>» dueAt</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the dueAt value</td> +<td>false</td> +<td>the new dueAt field of the card</td> </tr> <tr> <td>» endAt</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the endAt value</td> +<td>false</td> +<td>the new endAt field of the card</td> </tr> <tr> <td>» spentTime</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the spentTime value</td> +<td>false</td> +<td>the new spentTime field of the card</td> </tr> <tr> <td>» isOverTime</td> <td>body</td> -<td>string</td> -<td>true</td> -<td>the isOverTime value</td> +<td>boolean</td> +<td>false</td> +<td>the new isOverTime field of the card</td> </tr> <tr> <td>» customFields</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the customFields value</td> +<td>false</td> +<td>the new customFields value of the card</td> </tr> <tr> <td>» members</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the members value</td> +<td>false</td> +<td>the new list of member IDs attached to the card</td> </tr> <tr> <td>» assignees</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the assignees value</td> +<td>false</td> +<td>the array of maximum one ID of assignee attached to the card</td> </tr> <tr> <td>» swimlaneId</td> <td>body</td> <td>string</td> -<td>true</td> -<td>the swimlaneId value</td> +<td>false</td> +<td>the new swimlane ID of the card</td> </tr> </tbody> </table> -<h3 id="put_board_list_card-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID of the card</p> +<p><strong>list</strong>: the list ID of the card</p> +<p><strong>card</strong>: the ID of the card</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="edit_card-responses">Responses</h3> <table> <thead> <tr> @@ -7627,7 +8300,29 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="edit_card-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> @@ -7635,20 +8330,24 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="delete_board_list_card">delete_board_list_card</h2> -<p><a id="opIddelete_board_list_card"></a></p> +<h2 id="delete_card">delete_card</h2> +<p><a id="opIddelete_card"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X DELETE /api/boards/{board}/lists/{list}/cards/{card} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/lists/{list}/cards/{card}</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -7667,6 +8366,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -7688,6 +8388,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/lists/{list}/cards/{card}'< <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -7700,6 +8401,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -7735,6 +8437,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -7750,7 +8453,10 @@ System.out.println(response.toString()); </code></pre> <p><code>DELETE /api/boards/{board}/lists/{list}/cards/{card}</code></p> -<h3 id="delete_board_list_card-parameters">Parameters</h3> +<p><em>Delete a card from a board</em></p> +<p>This operation <strong>deletes</strong> a card, and therefore the card +is not put in the recycle bin.</p> +<h3 id="delete_card-parameters">Parameters</h3> <table> <thead> <tr> @@ -7767,25 +8473,39 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID of the card</td> </tr> <tr> <td>list</td> <td>path</td> <td>string</td> <td>true</td> -<td>the list value</td> +<td>the list ID of the card</td> </tr> <tr> <td>card</td> <td>path</td> <td>string</td> <td>true</td> -<td>the card value</td> +<td>the ID of the card</td> </tr> </tbody> </table> -<h3 id="delete_board_list_card-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID of the card</p> +<p><strong>list</strong>: the list ID of the card</p> +<p><strong>card</strong>: the ID of the card</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="delete_card-responses">Responses</h3> <table> <thead> <tr> @@ -7800,7 +8520,29 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="delete_card-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> @@ -7808,20 +8550,24 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="get_board_swimlane_cards">get_board_swimlane_cards</h2> -<p><a id="opIdget_board_swimlane_cards"></a></p> +<h2 id="get_swimlane_cards">get_swimlane_cards</h2> +<p><a id="opIdget_swimlane_cards"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X GET /api/boards/{board}/swimlanes/{swimlane}/cards \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/swimlanes/{swimlane}/cards</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -7840,6 +8586,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -7861,6 +8608,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/swimlanes/{swimlane}/cards' <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -7873,6 +8621,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -7908,6 +8657,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -7923,7 +8673,8 @@ System.out.println(response.toString()); </code></pre> <p><code>GET /api/boards/{board}/swimlanes/{swimlane}/cards</code></p> -<h3 id="get_board_swimlane_cards-parameters">Parameters</h3> +<p><em>get all cards attached to a swimlane</em></p> +<h3 id="get_swimlane_cards-parameters">Parameters</h3> <table> <thead> <tr> @@ -7940,18 +8691,36 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</td> </tr> <tr> <td>swimlane</td> <td>path</td> <td>string</td> <td>true</td> -<td>the swimlane value</td> +<td>the swimlane ID</td> </tr> </tbody> </table> -<h3 id="get_board_swimlane_cards-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>swimlane</strong>: the swimlane ID</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>[ + { + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"description"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"listId"</span>: <span class="hljs-string">"string"</span> + } +] +</code></pre> +<h3 id="get_swimlane_cards-responses">Responses</h3> <table> <thead> <tr> @@ -7966,7 +8735,50 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="get_swimlane_cards-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» title</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» description</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» listId</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> @@ -8476,20 +9288,24 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="get_board_customfield">get_board_customField</h2> -<p><a id="opIdget_board_customField"></a></p> +<h2 id="get_custom_field">get_custom_field</h2> +<p><a id="opIdget_custom_field"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X GET /api/boards/{board}/custom-fields/{customField} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">GET</span> <span class="hljs-string">/api/boards/{board}/custom-fields/{customField}</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -8508,6 +9324,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -8529,6 +9346,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/custom-fields/{customField} <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -8541,6 +9359,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -8576,6 +9395,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -8591,7 +9411,8 @@ System.out.println(response.toString()); </code></pre> <p><code>GET /api/boards/{board}/custom-fields/{customField}</code></p> -<h3 id="get_board_customfield-parameters">Parameters</h3> +<p><em>Get a Custom Fields attached to a board</em></p> +<h3 id="get_custom_field-parameters">Parameters</h3> <table> <thead> <tr> @@ -8615,11 +9436,38 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the customField value</td> +<td>the ID of the custom field</td> </tr> </tbody> </table> -<h3 id="get_board_customfield-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>customField</strong>: the ID of the custom field</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"boardIds"</span>: [ + <span class="hljs-string">"string"</span> + ], + <span class="hljs-attr">"name"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"type"</span>: <span class="hljs-string">"text"</span>, + <span class="hljs-attr">"settings"</span>: { + <span class="hljs-attr">"currencyCode"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"dropdownItems"</span>: [ + {} + ] + }, + <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">"createdAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"modifiedAt"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="get_custom_field-responses">Responses</h3> <table> <thead> <tr> @@ -8634,7 +9482,7 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td><a href="#schemacustomfields">CustomFields</a></td> </tr> </tbody> </table> @@ -8642,20 +9490,24 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="delete_board_customfield">delete_board_customField</h2> -<p><a id="opIddelete_board_customField"></a></p> +<h2 id="delete_custom_field">delete_custom_field</h2> +<p><a id="opIddelete_custom_field"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X DELETE /api/boards/{board}/custom-fields/{customField} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/custom-fields/{customField}</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -8674,6 +9526,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -8695,6 +9548,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/custom-fields/{customField} <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -8707,6 +9561,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -8742,6 +9597,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -8757,7 +9613,9 @@ System.out.println(response.toString()); </code></pre> <p><code>DELETE /api/boards/{board}/custom-fields/{customField}</code></p> -<h3 id="delete_board_customfield-parameters">Parameters</h3> +<p><em>Delete a Custom Fields attached to a board</em></p> +<p>The Custom Field can't be retrieved after this operation</p> +<h3 id="delete_custom_field-parameters">Parameters</h3> <table> <thead> <tr> @@ -8781,11 +9639,23 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the customField value</td> +<td>the ID of the custom field</td> </tr> </tbody> </table> -<h3 id="delete_board_customfield-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>customField</strong>: the ID of the custom field</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="delete_custom_field-responses">Responses</h3> <table> <thead> <tr> @@ -8800,7 +9670,29 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="delete_custom_field-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> @@ -10009,20 +10901,24 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="delete_board_int_activities">delete_board_int_activities</h2> -<p><a id="opIddelete_board_int_activities"></a></p> +<h2 id="delete_integration_activities">delete_integration_activities</h2> +<p><a id="opIddelete_integration_activities"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X DELETE /api/boards/{board}/integrations/{int}/activities \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/integrations/{int}/activities</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -10041,6 +10937,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -10062,6 +10959,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/integrations/{int}/activiti <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -10074,6 +10972,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -10109,6 +11008,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -10124,7 +11024,8 @@ System.out.println(response.toString()); </code></pre> <p><code>DELETE /api/boards/{board}/integrations/{int}/activities</code></p> -<h3 id="delete_board_int_activities-parameters">Parameters</h3> +<p><em>Delete subscribed activities</em></p> +<h3 id="delete_integration_activities-parameters">Parameters</h3> <table> <thead> <tr> @@ -10141,18 +11042,42 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</td> </tr> <tr> <td>int</td> <td>path</td> <td>string</td> <td>true</td> -<td>the int value</td> +<td>the integration ID</td> </tr> </tbody> </table> -<h3 id="delete_board_int_activities-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>int</strong>: the integration ID</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"activities"</span>: [ + <span class="hljs-string">"string"</span> + ], + <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"token"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"boardId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"modifiedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"userId"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="delete_integration_activities-responses">Responses</h3> <table> <thead> <tr> @@ -10167,7 +11092,7 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td><a href="#schemaintegrations">Integrations</a></td> </tr> </tbody> </table> @@ -10175,24 +11100,27 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="post_board_int_activities">post_board_int_activities</h2> -<p><a id="opIdpost_board_int_activities"></a></p> +<h2 id="new_integration_activities">new_integration_activities</h2> +<p><a id="opIdnew_integration_activities"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X POST /api/boards/{board}/integrations/{int}/activities \ -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/integrations/{int}/activities</span> HTTP/1.1 <span class="fortran">Content-<span class="hljs-keyword">Type</span>: multipart/<span class="hljs-keyword">form</span>-<span class="hljs-keyword">data</span> +Accept: application/json </span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -10214,6 +11142,7 @@ $.ajax({ }'</span>; <span class="hljs-keyword">const</span> headers = { <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -10236,6 +11165,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/integrations/{int}/activiti headers = { <span class="hljs-string">'Content-Type'</span> => <span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -10249,6 +11179,7 @@ p JSON.parse(result) <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -10285,6 +11216,7 @@ System.out.println(response.toString()); headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ <span class="hljs-string">"Content-Type"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"multipart/form-data"</span>}, + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -10300,13 +11232,14 @@ System.out.println(response.toString()); </code></pre> <p><code>POST /api/boards/{board}/integrations/{int}/activities</code></p> +<p><em>Add subscribed activities</em></p> <blockquote> <p>Body parameter</p> </blockquote> <pre class="highlight tab tab-yaml"><code><span class="hljs-attr">activities:</span> <span class="hljs-string">string</span> </code></pre> -<h3 id="post_board_int_activities-parameters">Parameters</h3> +<h3 id="new_integration_activities-parameters">Parameters</h3> <table> <thead> <tr> @@ -10323,14 +11256,14 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</td> </tr> <tr> <td>int</td> <td>path</td> <td>string</td> <td>true</td> -<td>the int value</td> +<td>the integration ID</td> </tr> <tr> <td>body</td> @@ -10348,7 +11281,31 @@ System.out.println(response.toString()); </tr> </tbody> </table> -<h3 id="post_board_int_activities-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>int</strong>: the integration ID</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"enabled"</span>: <span class="hljs-literal">true</span>, + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"type"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"activities"</span>: [ + <span class="hljs-string">"string"</span> + ], + <span class="hljs-attr">"url"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"token"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"boardId"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"createdAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"modifiedAt"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"userId"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="new_integration_activities-responses">Responses</h3> <table> <thead> <tr> @@ -10363,7 +11320,7 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td><a href="#schemaintegrations">Integrations</a></td> </tr> </tbody> </table> @@ -11508,24 +12465,27 @@ to later change the permissions.</p> To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="post_board_user_remove">post_board_user_remove</h2> -<p><a id="opIdpost_board_user_remove"></a></p> +<h2 id="remove_board_member">remove_board_member</h2> +<p><a id="opIdremove_board_member"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X POST /api/boards/{board}/members/{user}/remove \ -H <span class="hljs-string">'Content-Type: multipart/form-data'</span> \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">POST</span> <span class="hljs-string">/api/boards/{board}/members/{user}/remove</span> HTTP/1.1 <span class="fortran">Content-<span class="hljs-keyword">Type</span>: multipart/<span class="hljs-keyword">form</span>-<span class="hljs-keyword">data</span> +Accept: application/json </span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -11547,6 +12507,7 @@ $.ajax({ }'</span>; <span class="hljs-keyword">const</span> headers = { <span class="hljs-string">'Content-Type'</span>:<span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -11569,6 +12530,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/members/{user}/remove'</spa headers = { <span class="hljs-string">'Content-Type'</span> => <span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -11582,6 +12544,7 @@ p JSON.parse(result) <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { <span class="hljs-string">'Content-Type'</span>: <span class="hljs-string">'multipart/form-data'</span>, + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -11618,6 +12581,7 @@ System.out.println(response.toString()); headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ <span class="hljs-string">"Content-Type"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"multipart/form-data"</span>}, + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -11633,13 +12597,15 @@ System.out.println(response.toString()); </code></pre> <p><code>POST /api/boards/{board}/members/{user}/remove</code></p> +<p><em>Remove Member from Board</em></p> +<p>Only the admin user (the first user) can call the REST API.</p> <blockquote> <p>Body parameter</p> </blockquote> <pre class="highlight tab tab-yaml"><code><span class="hljs-attr">action:</span> <span class="hljs-string">string</span> </code></pre> -<h3 id="post_board_user_remove-parameters">Parameters</h3> +<h3 id="remove_board_member-parameters">Parameters</h3> <table> <thead> <tr> @@ -11656,14 +12622,14 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the board ID</td> </tr> <tr> <td>user</td> <td>path</td> <td>string</td> <td>true</td> -<td>the user value</td> +<td>the user ID</td> </tr> <tr> <td>body</td> @@ -11677,11 +12643,25 @@ System.out.println(response.toString()); <td>body</td> <td>string</td> <td>true</td> -<td>the action value</td> +<td>the action (needs to be <code>remove</code>)</td> </tr> </tbody> </table> -<h3 id="post_board_user_remove-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the board ID</p> +<p><strong>user</strong>: the user ID</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span>, + <span class="hljs-attr">"title"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="remove_board_member-responses">Responses</h3> <table> <thead> <tr> @@ -11696,7 +12676,36 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="remove_board_member-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> +</tr> +<tr> +<td>» title</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> @@ -13652,20 +14661,24 @@ System.out.println(response.toString()); To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity </aside> -<h2 id="delete_board_swimlane">delete_board_swimlane</h2> -<p><a id="opIddelete_board_swimlane"></a></p> +<h2 id="delete_swimlane">delete_swimlane</h2> +<p><a id="opIddelete_swimlane"></a></p> <blockquote> <p>Code samples</p> </blockquote> <pre class="highlight tab tab-shell"><code><span class="hljs-comment"># You can also use wget</span> curl -X DELETE /api/boards/{board}/swimlanes/{swimlane} \ + -H <span class="hljs-string">'Accept: application/json'</span> \ -H <span class="hljs-string">'Authorization: API_KEY'</span> </code></pre> <pre class="highlight tab tab-http"><code><span class="hljs-keyword">DELETE</span> <span class="hljs-string">/api/boards/{board}/swimlanes/{swimlane}</span> HTTP/1.1 -<span class="undefined"></span></code></pre> +<span class="http"><span class="hljs-attribute">Accept</span>: application/json + +<span class="undefined"></span></span></code></pre> <pre class="highlight tab tab-javascript"><code><span class="hljs-keyword">var</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -13684,6 +14697,7 @@ $.ajax({ <pre class="highlight tab tab-javascript--nodejs"><code><span class="hljs-keyword">const</span> fetch = <span class="hljs-built_in">require</span>(<span class="hljs-string">'node-fetch'</span>); <span class="hljs-keyword">const</span> headers = { + <span class="hljs-string">'Accept'</span>:<span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>:<span class="hljs-string">'API_KEY'</span> }; @@ -13705,6 +14719,7 @@ fetch(<span class="hljs-string">'/api/boards/{board}/swimlanes/{swimlane}'</span <span class="hljs-keyword">require</span> <span class="hljs-string">'json'</span> headers = { + <span class="hljs-string">'Accept'</span> => <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span> => <span class="hljs-string">'API_KEY'</span> } @@ -13717,6 +14732,7 @@ p JSON.parse(result) </code></pre> <pre class="highlight tab tab-python"><code><span class="hljs-keyword">import</span> requests headers = { + <span class="hljs-string">'Accept'</span>: <span class="hljs-string">'application/json'</span>, <span class="hljs-string">'Authorization'</span>: <span class="hljs-string">'API_KEY'</span> } @@ -13752,6 +14768,7 @@ System.out.println(response.toString()); <span class="hljs-function"><span class="hljs-keyword">func</span> <span class="hljs-title">main</span><span class="hljs-params">()</span></span> { headers := <span class="hljs-keyword">map</span>[<span class="hljs-keyword">string</span>][]<span class="hljs-keyword">string</span>{ + <span class="hljs-string">"Accept"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"application/json"</span>}, <span class="hljs-string">"Authorization"</span>: []<span class="hljs-keyword">string</span>{<span class="hljs-string">"API_KEY"</span>}, } @@ -13767,7 +14784,9 @@ System.out.println(response.toString()); </code></pre> <p><code>DELETE /api/boards/{board}/swimlanes/{swimlane}</code></p> -<h3 id="delete_board_swimlane-parameters">Parameters</h3> +<p><em>Delete a swimlane</em></p> +<p>The swimlane will be deleted, not moved to the recycle bin</p> +<h3 id="delete_swimlane-parameters">Parameters</h3> <table> <thead> <tr> @@ -13784,18 +14803,31 @@ System.out.println(response.toString()); <td>path</td> <td>string</td> <td>true</td> -<td>the board value</td> +<td>the ID of the board</td> </tr> <tr> <td>swimlane</td> <td>path</td> <td>string</td> <td>true</td> -<td>the swimlane value</td> +<td>the ID of the swimlane</td> </tr> </tbody> </table> -<h3 id="delete_board_swimlane-responses">Responses</h3> +<h4 id="detailed-descriptions">Detailed descriptions</h4> +<p><strong>board</strong>: the ID of the board</p> +<p><strong>swimlane</strong>: the ID of the swimlane</p> +<blockquote> +<p>Example responses</p> +</blockquote> +<blockquote> +<p>200 Response</p> +</blockquote> +<pre class="highlight tab tab-json"><code>{ + <span class="hljs-attr">"_id"</span>: <span class="hljs-string">"string"</span> +} +</code></pre> +<h3 id="delete_swimlane-responses">Responses</h3> <table> <thead> <tr> @@ -13810,7 +14842,29 @@ System.out.println(response.toString()); <td>200</td> <td><a href="https://tools.ietf.org/html/rfc7231#section-6.3.1">OK</a></td> <td>200 response</td> -<td>None</td> +<td>Inline</td> +</tr> +</tbody> +</table> +<h3 id="delete_swimlane-responseschema">Response Schema</h3> +<p>Status Code <strong>200</strong></p> +<table> +<thead> +<tr> +<th>Name</th> +<th>Type</th> +<th>Required</th> +<th>Restrictions</th> +<th>Description</th> +</tr> +</thead> +<tbody> +<tr> +<td>» _id</td> +<td>string</td> +<td>false</td> +<td>none</td> +<td>none</td> </tr> </tbody> </table> diff --git a/public/api/wekan.yml b/public/api/wekan.yml index 7e804120..bfbe913d 100644 --- a/public/api/wekan.yml +++ b/public/api/wekan.yml @@ -1,7 +1,7 @@ swagger: '2.0' info: title: Wekan REST API - version: v4.15 + version: v4.16 description: | The REST API allows you to control and extend Wekan with ease. @@ -290,18 +290,21 @@ paths: 200 response /api/boards/{board}/cards/{card}/checklists: get: - operationId: get_board_card_checklists + operationId: get_all_checklists + summary: Get the list of checklists attached to a card tags: - Checklists parameters: - name: board in: path - description: the board value + description: | + the board ID type: string required: true - name: card in: path - description: the card value + description: | + the card ID type: string required: true produces: @@ -312,8 +315,18 @@ paths: '200': description: |- 200 response + schema: + type: array + items: + type: object + properties: + _id: + type: string + title: + type: string post: - operationId: post_board_card_checklists + operationId: new_checklist + summary: create a new checklist tags: - Checklists consumes: @@ -322,22 +335,26 @@ paths: parameters: - name: title in: formData - description: the title value + description: | + the title of the new checklist type: string required: true - name: items in: formData - description: the items value + description: | + the list of items on the new checklist type: string - required: true + required: false - name: board in: path - description: the board value + description: | + the board ID type: string required: true - name: card in: path - description: the card value + description: | + the card ID type: string required: true produces: @@ -348,25 +365,34 @@ paths: '200': description: |- 200 response + schema: + type: object + properties: + _id: + type: string /api/boards/{board}/cards/{card}/checklists/{checklist}: get: - operationId: get_board_card_checklist + operationId: get_checklist + summary: Get a checklist tags: - Checklists parameters: - name: board in: path - description: the board value + description: | + the board ID type: string required: true - name: card in: path - description: the card value + description: | + the card ID type: string required: true - name: checklist in: path - description: the checklist value + description: | + the ID of the checklist type: string required: true produces: @@ -377,24 +403,54 @@ paths: '200': description: |- 200 response + schema: + type: object + properties: + cardId: + type: string + title: + type: string + finishedAt: + type: string + createdAt: + type: string + sort: + type: number + items: + type: array + items: + type: object + properties: + _id: + type: string + title: + type: string + isFinished: + type: boolean delete: - operationId: delete_board_card_checklist + operationId: delete_checklist + summary: Delete a checklist + description: | + The checklist will be removed, not put in the recycle bin. tags: - Checklists parameters: - name: board in: path - description: the board value + description: | + the board ID type: string required: true - name: card in: path - description: the card value + description: | + the card ID type: string required: true - name: checklist in: path - description: the checklist value + description: | + the ID of the checklist to remove type: string required: true produces: @@ -405,30 +461,41 @@ paths: '200': description: |- 200 response + schema: + type: object + properties: + _id: + type: string /api/boards/{board}/cards/{card}/checklists/{checklist}/items/{item}: get: - operationId: get_board_card_checklist_item + operationId: get_checklist_item + summary: Get a checklist item tags: - ChecklistItems + - Checklists parameters: - name: board in: path - description: the board value + description: | + the board ID type: string required: true - name: card in: path - description: the card value + description: | + the card ID type: string required: true - name: checklist in: path - description: the checklist value + description: | + the checklist ID type: string required: true - name: item in: path - description: the item value + description: | + the ID of the item type: string required: true produces: @@ -439,42 +506,52 @@ paths: '200': description: |- 200 response + schema: + $ref: "#/definitions/ChecklistItems" put: - operationId: put_board_card_checklist_item + operationId: edit_checklist_item + summary: Edit a checklist item tags: - ChecklistItems + - Checklists consumes: - multipart/form-data - application/json parameters: - name: isFinished in: formData - description: the isFinished value + description: | + is the item checked? type: string - required: true + required: false - name: title in: formData - description: the title value + description: | + the new text of the item type: string - required: true + required: false - name: board in: path - description: the board value + description: | + the board ID type: string required: true - name: card in: path - description: the card value + description: | + the card ID type: string required: true - name: checklist in: path - description: the checklist value + description: | + the checklist ID type: string required: true - name: item in: path - description: the item value + description: | + the ID of the item type: string required: true produces: @@ -485,29 +562,42 @@ paths: '200': description: |- 200 response + schema: + type: object + properties: + _id: + type: string delete: - operationId: delete_board_card_checklist_item + operationId: delete_checklist_item + summary: Delete a checklist item + description: | + Note: this operation can't be reverted. tags: - ChecklistItems + - Checklists parameters: - name: board in: path - description: the board value + description: | + the board ID type: string required: true - name: card in: path - description: the card value + description: | + the card ID type: string required: true - name: checklist in: path - description: the checklist value + description: | + the checklist ID type: string required: true - name: item in: path - description: the item value + description: | + the ID of the item to be removed type: string required: true produces: @@ -518,6 +608,11 @@ paths: '200': description: |- 200 response + schema: + type: object + properties: + _id: + type: string /api/boards/{board}/cards/{card}/comments: get: operationId: get_all_comments @@ -557,7 +652,8 @@ paths: authorId: type: string post: - operationId: post_board_card_comments + operationId: new_comment + summary: Add a comment on a card tags: - CardComments consumes: @@ -566,7 +662,8 @@ paths: parameters: - name: authorId in: formData - description: the authorId value + description: | + the user who 'posted' the comment type: string required: true - name: comment @@ -576,12 +673,14 @@ paths: required: true - name: board in: path - description: the board value + description: | + the board ID of the card type: string required: true - name: card in: path - description: the card value + description: | + the ID of the card type: string required: true produces: @@ -592,25 +691,34 @@ paths: '200': description: |- 200 response + schema: + type: object + properties: + _id: + type: string /api/boards/{board}/cards/{card}/comments/{comment}: get: - operationId: get_board_card_comment + operationId: get_comment + summary: Get a comment on a card tags: - CardComments parameters: - name: board in: path - description: the board value + description: | + the board ID of the card type: string required: true - name: card in: path - description: the card value + description: | + the ID of the card type: string required: true - name: comment in: path - description: the comment value + description: | + the ID of the comment to retrieve type: string required: true produces: @@ -621,24 +729,30 @@ paths: '200': description: |- 200 response + schema: + $ref: "#/definitions/CardComments" delete: - operationId: delete_board_card_comment + operationId: delete_comment + summary: Delete a comment on a card tags: - CardComments parameters: - name: board in: path - description: the board value + description: | + the board ID of the card type: string required: true - name: card in: path - description: the card value + description: | + the ID of the card type: string required: true - name: comment in: path - description: the comment value + description: | + the ID of the comment to delete type: string required: true produces: @@ -649,25 +763,34 @@ paths: '200': description: |- 200 response + schema: + type: object + properties: + _id: + type: string /api/boards/{board}/cardsByCustomField/{customField}/{customFieldValue}: get: - operationId: get_board_customFieldValue + operationId: get_cards_by_custom_field + summary: Get all Cards that matchs a value of a specific custom field tags: - Cards parameters: - name: board in: path - description: the board value + description: | + the board ID type: string required: true - name: customField in: path - description: the customField value + description: | + the list ID type: string required: true - name: customFieldValue in: path - description: the customFieldValue value + description: | + the value to look for type: string required: true produces: @@ -678,6 +801,21 @@ paths: '200': description: |- 200 response + schema: + type: array + items: + type: object + properties: + _id: + type: string + title: + type: string + description: + type: string + listId: + type: string + swinlaneId: + type: string /api/boards/{board}/custom-fields: get: operationId: get_all_custom_fields @@ -779,7 +917,8 @@ paths: type: string /api/boards/{board}/custom-fields/{customField}: get: - operationId: get_board_customField + operationId: get_custom_field + summary: Get a Custom Fields attached to a board tags: - CustomFields parameters: @@ -790,7 +929,8 @@ paths: required: true - name: customField in: path - description: the customField value + description: | + the ID of the custom field type: string required: true produces: @@ -801,8 +941,13 @@ paths: '200': description: |- 200 response + schema: + $ref: "#/definitions/CustomFields" delete: - operationId: delete_board_customField + operationId: delete_custom_field + summary: Delete a Custom Fields attached to a board + description: | + The Custom Field can't be retrieved after this operation tags: - CustomFields parameters: @@ -813,7 +958,8 @@ paths: required: true - name: customField in: path - description: the customField value + description: | + the ID of the custom field type: string required: true produces: @@ -824,6 +970,11 @@ paths: '200': description: |- 200 response + schema: + type: object + properties: + _id: + type: string /api/boards/{board}/export: get: operationId: exportJson @@ -1036,18 +1187,21 @@ paths: type: string /api/boards/{board}/integrations/{int}/activities: delete: - operationId: delete_board_int_activities + operationId: delete_integration_activities + summary: Delete subscribed activities tags: - Integrations parameters: - name: board in: path - description: the board value + description: | + the board ID type: string required: true - name: int in: path - description: the int value + description: | + the integration ID type: string required: true produces: @@ -1058,8 +1212,11 @@ paths: '200': description: |- 200 response + schema: + $ref: "#/definitions/Integrations" post: - operationId: post_board_int_activities + operationId: new_integration_activities + summary: Add subscribed activities tags: - Integrations consumes: @@ -1073,12 +1230,14 @@ paths: required: true - name: board in: path - description: the board value + description: | + the board ID type: string required: true - name: int in: path - description: the int value + description: | + the integration ID type: string required: true produces: @@ -1089,6 +1248,8 @@ paths: '200': description: |- 200 response + schema: + $ref: "#/definitions/Integrations" /api/boards/{board}/labels: put: operationId: add_board_label @@ -1359,23 +1520,27 @@ paths: type: string /api/boards/{board}/lists/{list}/cards/{card}: get: - operationId: get_board_list_card + operationId: get_card + summary: Get a Card tags: - Cards parameters: - name: board in: path - description: the board value + description: | + the board ID type: string required: true - name: list in: path - description: the list value + description: | + the list ID of the card type: string required: true - name: card in: path - description: the card value + description: | + the card ID type: string required: true produces: @@ -1386,8 +1551,23 @@ paths: '200': description: |- 200 response + schema: + $ref: "#/definitions/Cards" put: - operationId: put_board_list_card + operationId: edit_card + summary: Edit Fields in a Card + description: | + Edit a card + + The color has to be chosen between `white`, `green`, `yellow`, `orange`, + `red`, `purple`, `blue`, `sky`, `lime`, `pink`, `black`, `silver`, + `peachpuff`, `crimson`, `plum`, `darkgreen`, `slateblue`, `magenta`, + `gold`, `navy`, `gray`, `saddlebrown`, `paleturquoise`, `mistyrose`, + `indigo`: + + <img src="/card-colors.png" width="40%" alt="Wekan card colors" /> + + Note: setting the color to white has the same effect than removing it. tags: - Cards consumes: @@ -1396,117 +1576,140 @@ paths: parameters: - name: title in: formData - description: the title value + description: | + the new title of the card type: string - required: true + required: false - name: listId in: formData - description: the listId value + description: | + the new list ID of the card (move operation) type: string - required: true + required: false - name: authorId in: formData - description: the authorId value + description: | + change the owner of the card type: string - required: true + required: false - name: parentId in: formData - description: the parentId value + description: | + change the parent of the card type: string - required: true + required: false - name: description in: formData - description: the description value + description: | + the new description of the card type: string - required: true + required: false - name: color in: formData - description: the color value + description: | + the new color of the card type: string - required: true + required: false - name: vote in: formData - description: the vote value - type: string - required: true + description: | + the vote object + type: object + required: false - name: labelIds in: formData - description: the labelIds value + description: | + the new list of label IDs attached to the card type: string - required: true + required: false - name: requestedBy in: formData - description: the requestedBy value + description: | + the new requestedBy field of the card type: string - required: true + required: false - name: assignedBy in: formData - description: the assignedBy value + description: | + the new assignedBy field of the card type: string - required: true + required: false - name: receivedAt in: formData - description: the receivedAt value + description: | + the new receivedAt field of the card type: string - required: true + required: false - name: startAt in: formData - description: the startAt value + description: | + the new startAt field of the card type: string - required: true + required: false - name: dueAt in: formData - description: the dueAt value + description: | + the new dueAt field of the card type: string - required: true + required: false - name: endAt in: formData - description: the endAt value + description: | + the new endAt field of the card type: string - required: true + required: false - name: spentTime in: formData - description: the spentTime value + description: | + the new spentTime field of the card type: string - required: true + required: false - name: isOverTime in: formData - description: the isOverTime value - type: string - required: true + description: | + the new isOverTime field of the card + type: boolean + required: false - name: customFields in: formData - description: the customFields value + description: | + the new customFields value of the card type: string - required: true + required: false - name: members in: formData - description: the members value + description: | + the new list of member IDs attached to the card type: string - required: true + required: false - name: assignees in: formData - description: the assignees value + description: | + the array of maximum one ID of assignee attached to the card type: string - required: true + required: false - name: swimlaneId in: formData - description: the swimlaneId value + description: | + the new swimlane ID of the card type: string - required: true + required: false - name: board in: path - description: the board value + description: | + the board ID of the card type: string required: true - name: list in: path - description: the list value + description: | + the list ID of the card type: string required: true - name: card in: path - description: the card value + description: | + the ID of the card type: string required: true produces: @@ -1517,24 +1720,36 @@ paths: '200': description: |- 200 response + schema: + type: object + properties: + _id: + type: string delete: - operationId: delete_board_list_card + operationId: delete_card + summary: Delete a card from a board + description: | + This operation **deletes** a card, and therefore the card + is not put in the recycle bin. tags: - Cards parameters: - name: board in: path - description: the board value + description: | + the board ID of the card type: string required: true - name: list in: path - description: the list value + description: | + the list ID of the card type: string required: true - name: card in: path - description: the card value + description: | + the ID of the card type: string required: true produces: @@ -1545,6 +1760,11 @@ paths: '200': description: |- 200 response + schema: + type: object + properties: + _id: + type: string /api/boards/{board}/members/{member}: post: operationId: set_board_member_permission @@ -1668,26 +1888,33 @@ paths: type: string /api/boards/{board}/members/{user}/remove: post: - operationId: post_board_user_remove + operationId: remove_board_member + summary: Remove Member from Board + description: | + Only the admin user (the first user) can call the REST API. tags: - Users + - Boards consumes: - multipart/form-data - application/json parameters: - name: action in: formData - description: the action value + description: | + the action (needs to be `remove`) type: string required: true - name: board in: path - description: the board value + description: | + the board ID type: string required: true - name: user in: path - description: the user value + description: | + the user ID type: string required: true produces: @@ -1698,6 +1925,13 @@ paths: '200': description: |- 200 response + schema: + type: object + properties: + _id: + type: string + title: + type: string /api/boards/{board}/swimlanes: get: operationId: get_all_swimlanes @@ -1792,18 +2026,23 @@ paths: schema: $ref: "#/definitions/Swimlanes" delete: - operationId: delete_board_swimlane + operationId: delete_swimlane + summary: Delete a swimlane + description: | + The swimlane will be deleted, not moved to the recycle bin tags: - Swimlanes parameters: - name: board in: path - description: the board value + description: | + the ID of the board type: string required: true - name: swimlane in: path - description: the swimlane value + description: | + the ID of the swimlane type: string required: true produces: @@ -1814,20 +2053,28 @@ paths: '200': description: |- 200 response + schema: + type: object + properties: + _id: + type: string /api/boards/{board}/swimlanes/{swimlane}/cards: get: - operationId: get_board_swimlane_cards + operationId: get_swimlane_cards + summary: get all cards attached to a swimlane tags: - Cards parameters: - name: board in: path - description: the board value + description: | + the board ID type: string required: true - name: swimlane in: path - description: the swimlane value + description: | + the swimlane ID type: string required: true produces: @@ -1838,6 +2085,19 @@ paths: '200': description: |- 200 response + schema: + type: array + items: + type: object + properties: + _id: + type: string + title: + type: string + description: + type: string + listId: + type: string /api/user: get: operationId: get_current_user diff --git a/sandstorm-pkgdef.capnp b/sandstorm-pkgdef.capnp index 27dc1be5..fab8f1d6 100644 --- a/sandstorm-pkgdef.capnp +++ b/sandstorm-pkgdef.capnp @@ -22,10 +22,10 @@ const pkgdef :Spk.PackageDefinition = ( appTitle = (defaultText = "Wekan"), # The name of the app as it is displayed to the user. - appVersion = 415, + appVersion = 416, # Increment this for every release. - appMarketingVersion = (defaultText = "4.15.0~2020-06-16"), + appMarketingVersion = (defaultText = "4.16.0~2020-06-17"), # Human-readable presentation of the app version. minUpgradableAppVersion = 0, |