Andreas/wekan
1
0
Fork 0
mirror of https://github.com/wekan/wekan.git synced 2026-02-15 20:48:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

-conflits resolve

Browse source
This commit is contained in:
Emile NDAGIJIMANA 2021-06-14 15:11:21 +02:00
parent 688ef08cd5
commit 080fcb9c62
141 changed files with 4856 additions and 931 deletions
Download patch file Download diff file Expand all files Collapse all files

176
public/api/wekan.html
View file

@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<title>Wekan REST API v5.32</title>
<title>Wekan REST API v5.34</title>
<style>
</style>
@ -1488,6 +1488,8 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
</head>
@ -1551,7 +1553,7 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
<ul class="toc-list-h1">
<li>
<a href="#wekan-rest-api" class="toc-h1 toc-link" data-title="Wekan REST API v5.32">Wekan REST API v5.32</a>
<a href="#wekan-rest-api" class="toc-h1 toc-link" data-title="Wekan REST API v5.34">Wekan REST API v5.34</a>
</li>
@ -2079,6 +2081,16 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
</li>
<li>
<a href="#tocs_usersorgs" class="toc-h2 toc-link" data-title="">UsersOrgs</a>
</li>
<li>
<a href="#tocs_usersteams" class="toc-h2 toc-link" data-title="">UsersTeams</a>
</li>
<li>
<a href="#tocs_usersemails" class="toc-h2 toc-link" data-title="">UsersEmails</a>
@ -2104,7 +2116,7 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
<div class="page-wrapper">
<div class="dark-box"></div>
<div class="content">
<h1 id="wekan-rest-api">Wekan REST API v5.32</h1>
<h1 id="wekan-rest-api">Wekan REST API v5.34</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>
@ -3522,6 +3534,7 @@ System.out.println(response.toString());
<span class="hljs-attr">&quot;allowsAssignee&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;allowsMembers&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;allowsRequestedBy&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;allowsCardSortingByNumber&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;allowsAssignedBy&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;allowsReceivedDate&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;allowsStartDate&quot;</span>: <span class="hljs-literal">true</span>,
@ -15959,6 +15972,18 @@ System.out.println(response.toString());
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;orgs&quot;</span>: [
{
<span class="hljs-attr">&quot;orgId&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;orgDisplayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
}
],
<span class="hljs-attr">&quot;teams&quot;</span>: [
{
<span class="hljs-attr">&quot;teamId&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;teamDisplayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
}
],
<span class="hljs-attr">&quot;emails&quot;</span>: [
{
<span class="hljs-attr">&quot;address&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
@ -16008,8 +16033,7 @@ System.out.println(response.toString());
<span class="hljs-attr">&quot;loginDisabled&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;authenticationMethod&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;sessionData&quot;</span>: {
<span class="hljs-attr">&quot;totalHits&quot;</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">&quot;lastHit&quot;</span>: <span class="hljs-number">0</span>
<span class="hljs-attr">&quot;totalHits&quot;</span>: <span class="hljs-number">0</span>
},
<span class="hljs-attr">&quot;importUsernames&quot;</span>: [
<span class="hljs-string">&quot;string&quot;</span>
@ -16700,6 +16724,18 @@ System.out.println(response.toString());
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;orgs&quot;</span>: [
{
<span class="hljs-attr">&quot;orgId&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;orgDisplayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
}
],
<span class="hljs-attr">&quot;teams&quot;</span>: [
{
<span class="hljs-attr">&quot;teamId&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;teamDisplayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
}
],
<span class="hljs-attr">&quot;emails&quot;</span>: [
{
<span class="hljs-attr">&quot;address&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
@ -16749,8 +16785,7 @@ System.out.println(response.toString());
<span class="hljs-attr">&quot;loginDisabled&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;authenticationMethod&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;sessionData&quot;</span>: {
<span class="hljs-attr">&quot;totalHits&quot;</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">&quot;lastHit&quot;</span>: <span class="hljs-number">0</span>
<span class="hljs-attr">&quot;totalHits&quot;</span>: <span class="hljs-number">0</span>
},
<span class="hljs-attr">&quot;importUsernames&quot;</span>: [
<span class="hljs-string">&quot;string&quot;</span>
@ -18275,6 +18310,7 @@ UserSecurity
<span class="hljs-attr">&quot;allowsAssignee&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;allowsMembers&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;allowsRequestedBy&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;allowsCardSortingByNumber&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;allowsAssignedBy&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;allowsReceivedDate&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;allowsStartDate&quot;</span>: <span class="hljs-literal">true</span>,
@ -18501,6 +18537,13 @@ UserSecurity
<td>Does the board allows requested by?</td>
</tr>
<tr>
<td>allowsCardSortingByNumber</td>
<td>boolean</td>
<td>true</td>
<td>none</td>
<td>Does the board allows card sorting by number?</td>
</tr>
<tr>
<td>allowsAssignedBy</td>
<td>boolean</td>
<td>true</td>
@ -20712,6 +20755,18 @@ UserSecurity
<a id="tocsusers"></a></p>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">&quot;username&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;orgs&quot;</span>: [
{
<span class="hljs-attr">&quot;orgId&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;orgDisplayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
}
],
<span class="hljs-attr">&quot;teams&quot;</span>: [
{
<span class="hljs-attr">&quot;teamId&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;teamDisplayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
}
],
<span class="hljs-attr">&quot;emails&quot;</span>: [
{
<span class="hljs-attr">&quot;address&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
@ -20761,8 +20816,7 @@ UserSecurity
<span class="hljs-attr">&quot;loginDisabled&quot;</span>: <span class="hljs-literal">true</span>,
<span class="hljs-attr">&quot;authenticationMethod&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;sessionData&quot;</span>: {
<span class="hljs-attr">&quot;totalHits&quot;</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">&quot;lastHit&quot;</span>: <span class="hljs-number">0</span>
<span class="hljs-attr">&quot;totalHits&quot;</span>: <span class="hljs-number">0</span>
},
<span class="hljs-attr">&quot;importUsernames&quot;</span>: [
<span class="hljs-string">&quot;string&quot;</span>
@ -20791,6 +20845,20 @@ UserSecurity
<td>the username of the user</td>
</tr>
<tr>
<td>orgs</td>
<td>[<a href="#schemausersorgs">UsersOrgs</a>]¦null</td>
<td>false</td>
<td>none</td>
<td>the list of organizations that a user belongs to</td>
</tr>
<tr>
<td>teams</td>
<td>[<a href="#schemausersteams">UsersTeams</a>]¦null</td>
<td>false</td>
<td>none</td>
<td>the list of teams that a user belongs to</td>
</tr>
<tr>
<td>emails</td>
<td>[<a href="#schemausersemails">UsersEmails</a>]¦null</td>
<td>false</td>
@ -21131,8 +21199,7 @@ UserSecurity
<a id="tocSuserssessiondata"></a>
<a id="tocsuserssessiondata"></a></p>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">&quot;totalHits&quot;</span>: <span class="hljs-number">0</span>,
<span class="hljs-attr">&quot;lastHit&quot;</span>: <span class="hljs-number">0</span>
<span class="hljs-attr">&quot;totalHits&quot;</span>: <span class="hljs-number">0</span>
}
</code></pre>
@ -21153,14 +21220,85 @@ UserSecurity
<td>number</td>
<td>false</td>
<td>none</td>
<td>Total hits from last search</td>
<td>Total hits from last searchquery['members.userId'] = Meteor.userId();<br />last hit that was returned</td>
</tr>
</tbody>
</table>
<h2 id="tocs_usersorgs">UsersOrgs</h2>
<p><a id="schemausersorgs"></a>
<a id="schema_UsersOrgs"></a>
<a id="tocSusersorgs"></a>
<a id="tocsusersorgs"></a></p>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">&quot;orgId&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;orgDisplayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
}
</code></pre>
<h3 id="properties-21">Properties</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required</th>
<th>Restrictions</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>orgId</td>
<td>string</td>
<td>true</td>
<td>none</td>
<td>The uniq ID of the organization</td>
</tr>
<tr>
<td>lastHit</td>
<td>number</td>
<td>false</td>
<td>orgDisplayName</td>
<td>string</td>
<td>true</td>
<td>none</td>
<td>last hit that was returned</td>
<td>The display name of the organization</td>
</tr>
</tbody>
</table>
<h2 id="tocs_usersteams">UsersTeams</h2>
<p><a id="schemausersteams"></a>
<a id="schema_UsersTeams"></a>
<a id="tocSusersteams"></a>
<a id="tocsusersteams"></a></p>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">&quot;teamId&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>,
<span class="hljs-attr">&quot;teamDisplayName&quot;</span>: <span class="hljs-string">&quot;string&quot;</span>
}
</code></pre>
<h3 id="properties-22">Properties</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required</th>
<th>Restrictions</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>teamId</td>
<td>string</td>
<td>true</td>
<td>none</td>
<td>The uniq ID of the team</td>
</tr>
<tr>
<td>teamDisplayName</td>
<td>string</td>
<td>true</td>
<td>none</td>
<td>The display name of the team</td>
</tr>
</tbody>
</table>
@ -21175,7 +21313,7 @@ UserSecurity
}
</code></pre>
<h3 id="properties-21">Properties</h3>
<h3 id="properties-23">Properties</h3>
<table>
<thead>
<tr>
@ -21214,7 +21352,7 @@ UserSecurity
}
</code></pre>
<h3 id="properties-22">Properties</h3>
<h3 id="properties-24">Properties</h3>
<table>
<thead>
<tr>
@ -21265,6 +21403,8 @@ UserSecurity
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
<!-- backwards compatibility -->
</div>
<div class="dark-box">

54
public/api/wekan.yml
View file

@ -1,7 +1,7 @@
swagger: '2.0'
info:
title: Wekan REST API
version: v5.32
version: v5.34
description: |
The REST API allows you to control and extend Wekan with ease.
@ -2780,6 +2780,10 @@ definitions:
description: |
Does the board allows requested by?
type: boolean
allowsCardSortingByNumber:
description: |
Does the board allows card sorting by number?
type: boolean
allowsAssignedBy:
description: |
Does the board allows requested by?
@ -2876,6 +2880,7 @@ definitions:
- allowsAssignee
- allowsMembers
- allowsRequestedBy
- allowsCardSortingByNumber
- allowsAssignedBy
- allowsReceivedDate
- allowsStartDate
@ -3738,6 +3743,20 @@ definitions:
the username of the user
type: string
x-nullable: true
orgs:
description: |
the list of organizations that a user belongs to
type: array
items:
$ref: "#/definitions/UsersOrgs"
x-nullable: true
teams:
description: |
the list of teams that a user belongs to
type: array
items:
$ref: "#/definitions/UsersTeams"
x-nullable: true
emails:
description: |
the list of emails attached to a user
@ -3921,12 +3940,37 @@ definitions:
properties:
totalHits:
description: |
Total hits from last search
type: number
lastHit:
description: |
Total hits from last searchquery['members.userId'] = Meteor.userId();
last hit that was returned
type: number
UsersOrgs:
type: object
properties:
orgId:
description: |
The uniq ID of the organization
type: string
orgDisplayName:
description: |
The display name of the organization
type: string
required:
- orgId
- orgDisplayName
UsersTeams:
type: object
properties:
teamId:
description: |
The uniq ID of the team
type: string
teamDisplayName:
description: |
The display name of the team
type: string
required:
- teamId
- teamDisplayName
UsersEmails:
type: object
properties: