Wekan REST API v3.93
+Wekan REST API v3.94
@@ -9652,32 +9598,35 @@ The list is not put in the recycle bin. To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity -Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Cards
-get_all_cards
- +Users
+add_board_member
+Code samples
# You can also use wget
-curl -X GET /api/boards/{board}/lists/{list}/cards \
+curl -X POST /api/boards/{board}/members/{user}/add \
+ -H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'Authorization: API_KEY'
-GET /api/boards/{board}/lists/{list}/cards HTTP/1.1
+POST /api/boards/{board}/members/{user}/add HTTP/1.1
-Accept: application/json
+Content-Type: multipart/form-data
+Accept: application/json
-
+
var headers = {
+ 'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'API_KEY'
};
$.ajax({
- url: '/api/boards/{board}/lists/{list}/cards',
- method: 'get',
+ url: '/api/boards/{board}/members/{user}/add',
+ method: 'post',
headers: headers,
success: function(data) {
@@ -9687,17 +9636,23 @@ $.ajax({
const fetch = require('node-fetch');
-
+const inputBody = '{
+ "action": "string",
+ "isAdmin": true,
+ "isNoComments": true,
+ "isCommentOnly": true
+}';
const headers = {
+ 'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards',
+fetch('/api/boards/{board}/members/{user}/add',
{
- method: 'GET',
-
+ method: 'POST',
+ body: inputBody,
headers: headers
})
.then(function(res) {
@@ -9711,11 +9666,12 @@ fetch('/api/boards/{board}/lists/{list}/cards',
require 'json'
headers = {
+ 'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/lists/{list}/cards',
+result = RestClient.post '/api/boards/{board}/members/{user}/add',
params: {
}, headers: headers
@@ -9724,20 +9680,21 @@ p JSON.parse(result)
import requests
headers = {
+ 'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/lists/{list}/cards', params={
+r = requests.post('/api/boards/{board}/members/{user}/add', params={
}, headers = headers)
print r.json()
-URL obj = new URL("/api/boards/{board}/lists/{list}/cards");
+URL obj = new URL("/api/boards/{board}/members/{user}/add");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -9760,13 +9717,14 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/lists/{list}/cards", data)
+ req, err := http.NewRequest("POST", "/api/boards/{board}/members/{user}/add", data)
req.Header = headers
client := &http.Client{}
@@ -9775,9 +9733,21 @@ System.out.println(response.toString());
}
-GET /api/boards/{board}/lists/{list}/cards
-Get all Cards attached to a List
-Parameters
+POST /api/boards/{board}/members/{user}/add
+Add New Board Member with Role
+Only the admin user (the first user) can call the REST API.
+Note: see Boards.set_board_member_permission
+to later change the permissions.
+
+Body parameter
+
+action: string
+isAdmin: true
+isNoComments: true
+isCommentOnly: true
+
+
+Parameters
@@ -9797,32 +9767,64 @@ System.out.println(response.toString());
the board ID
-list
+user
path
string
true
-the list ID
+the user ID
+
+
+body
+body
+object
+false
+none
+
+
+» action
+body
+string
+true
+the action value
+
+
+» isAdmin
+body
+boolean
+true
+is the user an admin of the board
+
+
+» isNoComments
+body
+boolean
+true
+disable comments
+
+
+» isCommentOnly
+body
+boolean
+true
+only enable comments
Detailed descriptions
board: the board ID
-list: the list ID
+user: the user ID
Example responses
200 Response
-[
- {
- "_id": "string",
- "title": "string",
- "description": "string"
- }
-]
+{
+ "_id": "string",
+ "title": "string"
+}
-Responses
+Responses
@@ -9841,7 +9843,7 @@ System.out.println(response.toString());
-Response Schema
+Response Schema
Status Code 200
@@ -9868,46 +9870,36 @@ System.out.println(response.toString());
none
none
-
-» description
-string
-false
-none
-none
-
-new_card
-
+post_board_user_remove
+
Code samples
# You can also use wget
-curl -X POST /api/boards/{board}/lists/{list}/cards \
+curl -X POST /api/boards/{board}/members/{user}/remove \
-H 'Content-Type: multipart/form-data' \
- -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
-POST /api/boards/{board}/lists/{list}/cards HTTP/1.1
+POST /api/boards/{board}/members/{user}/remove HTTP/1.1
Content-Type: multipart/form-data
-Accept: application/json
var headers = {
'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
'Authorization':'API_KEY'
};
$.ajax({
- url: '/api/boards/{board}/lists/{list}/cards',
+ url: '/api/boards/{board}/members/{user}/remove',
method: 'post',
headers: headers,
@@ -9919,21 +9911,15 @@ $.ajax({
const fetch = require('node-fetch');
const inputBody = '{
- "authorId": "string",
- "members": "string",
- "assignees": "string",
- "title": "string",
- "description": "string",
- "swimlaneId": "string"
+ "action": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards',
+fetch('/api/boards/{board}/members/{user}/remove',
{
method: 'POST',
body: inputBody,
@@ -9951,11 +9937,10 @@ fetch('/api/boards/{board}/lists/{list}/cards',
headers = {
'Content-Type' => 'multipart/form-data',
- 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
-result = RestClient.post '/api/boards/{board}/lists/{list}/cards',
+result = RestClient.post '/api/boards/{board}/members/{user}/remove',
params: {
}, headers: headers
@@ -9965,18 +9950,17 @@ p JSON.parse(result)
import requests
headers = {
'Content-Type': 'multipart/form-data',
- 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
-r = requests.post('/api/boards/{board}/lists/{list}/cards', params={
+r = requests.post('/api/boards/{board}/members/{user}/remove', params={
}, headers = headers)
print r.json()
-URL obj = new URL("/api/boards/{board}/lists/{list}/cards");
+URL obj = new URL("/api/boards/{board}/members/{user}/remove");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
@@ -10002,13 +9986,12 @@ System.out.println(response.toString());
headers := map[string][]string{
"Content-Type": []string{"multipart/form-data"},
- "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("POST", "/api/boards/{board}/lists/{list}/cards", data)
+ req, err := http.NewRequest("POST", "/api/boards/{board}/members/{user}/remove", data)
req.Header = headers
client := &http.Client{}
@@ -10017,20 +10000,14 @@ System.out.println(response.toString());
}
-POST /api/boards/{board}/lists/{list}/cards
-Create a new Card
+POST /api/boards/{board}/members/{user}/remove
Body parameter
-authorId: string
-members: string
-assignees: string
-title: string
-description: string
-swimlaneId: string
+action: string
-Parameters
+Parameters
@@ -10047,14 +10024,14 @@ System.out.println(response.toString());
path
string
true
-the board ID of the new card
+the board value
-list
+user
path
string
true
-the list ID of the new card
+the user value
body
@@ -10064,63 +10041,15 @@ System.out.println(response.toString());
none
-» authorId
-body
-string
-true
-the authorId value
-
-
-» members
-body
-string
-false
-the member IDs list of the new card
-
-
-» assignees
-body
-string
-false
-the array of maximum one ID of assignee of the new card
-
-
-» title
-body
-string
-true
-the title of the new card
-
-
-» description
-body
-string
-true
-the description of the new card
-
-
-» swimlaneId
+» action
body
string
true
-the swimlane ID of the new card
+the action value
-Detailed descriptions
-board: the board ID of the new card
-list: the list ID of the new card
-
-Example responses
-
-
-200 Response
-
-{
- "_id": "string"
-}
-
-Responses
+Responses
@@ -10135,29 +10064,7 @@ System.out.println(response.toString());
200
OK
200 response
-Inline
-
-
-
-Response Schema
-Status Code 200
-
-
-
-Name
-Type
-Required
-Restrictions
-Description
-
-
-
-
-» _id
-string
-false
-none
-none
+None
@@ -10165,26 +10072,30 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-get_board_list_card
-
+get_current_user
+
Code samples
# You can also use wget
-curl -X GET /api/boards/{board}/lists/{list}/cards/{card} \
+curl -X GET /api/user \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
-GET /api/boards/{board}/lists/{list}/cards/{card} HTTP/1.1
+GET /api/user HTTP/1.1
-
-var headers = {
- 'Authorization':'API_KEY'
+Accept: application/json
+
+
+var headers = {
+ 'Accept':'application/json',
+ 'Authorization':'API_KEY'
};
$.ajax({
- url: '/api/boards/{board}/lists/{list}/cards/{card}',
+ url: '/api/user',
method: 'get',
headers: headers,
@@ -10197,11 +10108,12 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards/{card}',
+fetch('/api/user',
{
method: 'GET',
@@ -10218,10 +10130,11 @@ fetch('/api/boards/{board}/lists/{list}/cards/{card}'<
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/lists/{list}/cards/{card}',
+result = RestClient.get '/api/user',
params: {
}, headers: headers
@@ -10230,17 +10143,18 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/lists/{list}/cards/{card}', params={
+r = requests.get('/api/user', params={
}, headers = headers)
print r.json()
-URL obj = new URL("/api/boards/{board}/lists/{list}/cards/{card}");
+URL obj = new URL("/api/user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -10265,12 +10179,13 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/lists/{list}/cards/{card}", data)
+ req, err := http.NewRequest("GET", "/api/user", data)
req.Header = headers
client := &http.Client{}
@@ -10279,43 +10194,62 @@ System.out.println(response.toString());
}
-GET /api/boards/{board}/lists/{list}/cards/{card}
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-
-board
-path
-string
-true
-the board value
-
-
-list
-path
-string
-true
-the list value
-
-
-card
-path
-string
-true
-the card value
-
-
-
-Responses
+GET /api/user
+returns the current user
+
+Example responses
+
+
+200 Response
+
+{
+ "username": "string",
+ "emails": [
+ {
+ "address": "string",
+ "verified": true
+ }
+ ],
+ "createdAt": "string",
+ "modifiedAt": "string",
+ "profile": {
+ "avatarUrl": "string",
+ "emailBuffer": [
+ "string"
+ ],
+ "fullname": "string",
+ "showDesktopDragHandles": true,
+ "hiddenSystemMessages": true,
+ "hiddenMinicardLabelText": true,
+ "initials": "string",
+ "invitedBoards": [
+ "string"
+ ],
+ "language": "string",
+ "notifications": [],
+ "activity": "string",
+ "read": "string",
+ "showCardsCountAt": 0,
+ "starredBoards": [
+ "string"
+ ],
+ "icode": "string",
+ "boardView": "board-view-lists",
+ "listSortBy": "-modifiedat",
+ "templatesBoardId": "string",
+ "cardTemplatesSwimlaneId": "string",
+ "listTemplatesSwimlaneId": "string",
+ "boardTemplatesSwimlaneId": "string"
+ },
+ "services": {},
+ "heartbeat": "string",
+ "isAdmin": true,
+ "createdThroughApi": true,
+ "loginDisabled": true,
+ "authenticationMethod": "string"
+}
+
+Responses
@@ -10330,7 +10264,7 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Users
@@ -10338,31 +10272,31 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-put_board_list_card
-
+get_all_users
+
Code samples
# You can also use wget
-curl -X PUT /api/boards/{board}/lists/{list}/cards/{card} \
- -H 'Content-Type: multipart/form-data' \
+curl -X GET /api/users \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
-PUT /api/boards/{board}/lists/{list}/cards/{card} HTTP/1.1
+GET /api/users HTTP/1.1
-Content-Type: multipart/form-data
+Accept: application/json
-
+
var headers = {
- 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
$.ajax({
- url: '/api/boards/{board}/lists/{list}/cards/{card}',
- method: 'put',
+ url: '/api/users',
+ method: 'get',
headers: headers,
success: function(data) {
@@ -10372,37 +10306,17 @@ $.ajax({
const fetch = require('node-fetch');
-const inputBody = '{
- "title": "string",
- "listId": "string",
- "authorId": "string",
- "parentId": "string",
- "description": "string",
- "color": "string",
- "labelIds": "string",
- "requestedBy": "string",
- "assignedBy": "string",
- "receivedAt": "string",
- "startAt": "string",
- "dueAt": "string",
- "endAt": "string",
- "spentTime": "string",
- "isOverTime": "string",
- "customFields": "string",
- "members": "string",
- "assignees": "string",
- "swimlaneId": "string"
-}';
+
const headers = {
- 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards/{card}',
+fetch('/api/users',
{
- method: 'PUT',
- body: inputBody,
+ method: 'GET',
+
headers: headers
})
.then(function(res) {
@@ -10416,11 +10330,11 @@ fetch('/api/boards/{board}/lists/{list}/cards/{card}'<
require 'json'
headers = {
- 'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
-result = RestClient.put '/api/boards/{board}/lists/{list}/cards/{card}',
+result = RestClient.get '/api/users',
params: {
}, headers: headers
@@ -10429,20 +10343,20 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
-r = requests.put('/api/boards/{board}/lists/{list}/cards/{card}', params={
+r = requests.get('/api/users', params={
}, headers = headers)
print r.json()
-URL obj = new URL("/api/boards/{board}/lists/{list}/cards/{card}");
+URL obj = new URL("/api/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("PUT");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -10465,13 +10379,13 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("PUT", "/api/boards/{board}/lists/{list}/cards/{card}", data)
+ req, err := http.NewRequest("GET", "/api/users", data)
req.Header = headers
client := &http.Client{}
@@ -10480,222 +10394,67 @@ System.out.println(response.toString());
}
-PUT /api/boards/{board}/lists/{list}/cards/{card}
+GET /api/users
+return all the users
+Only the admin user (the first user) can call the REST API.
-Body parameter
+Example responses
-title: string
-listId: string
-authorId: string
-parentId: string
-description: string
-color: string
-labelIds: string
-requestedBy: string
-assignedBy: string
-receivedAt: string
-startAt: string
-dueAt: string
-endAt: string
-spentTime: string
-isOverTime: string
-customFields: string
-members: string
-assignees: string
-swimlaneId: string
-
+
+200 Response
+
+[
+ {
+ "_id": "string",
+ "username": "string"
+ }
+]
-Parameters
+Responses
-Name
-In
-Type
-Required
+Status
+Meaning
Description
+Schema
-board
-path
-string
-true
-the board value
+200
+OK
+200 response
+Inline
+
+
+Response Schema
+Status Code 200
+
+
-list
-path
-string
-true
-the list value
+Name
+Type
+Required
+Restrictions
+Description
+
+
-card
-path
+» _id
string
-true
-the card value
-
-
-body
-body
-object
false
none
+none
-» title
-body
-string
-true
-the title value
-
-
-» listId
-body
-string
-true
-the listId value
-
-
-» authorId
-body
-string
-true
-the authorId value
-
-
-» parentId
-body
-string
-true
-the parentId value
-
-
-» description
-body
-string
-true
-the description value
-
-
-» color
-body
-string
-true
-the color value
-
-
-» labelIds
-body
-string
-true
-the labelIds value
-
-
-» requestedBy
-body
+» username
string
-true
-the requestedBy value
-
-
-» assignedBy
-body
-string
-true
-the assignedBy value
-
-
-» receivedAt
-body
-string
-true
-the receivedAt value
-
-
-» startAt
-body
-string
-true
-the startAt value
-
-
-» dueAt
-body
-string
-true
-the dueAt value
-
-
-» endAt
-body
-string
-true
-the endAt value
-
-
-» spentTime
-body
-string
-true
-the spentTime value
-
-
-» isOverTime
-body
-string
-true
-the isOverTime value
-
-
-» customFields
-body
-string
-true
-the customFields value
-
-
-» members
-body
-string
-true
-the members value
-
-
-» assignees
-body
-string
-true
-the assignees value
-
-
-» swimlaneId
-body
-string
-true
-the swimlaneId value
-
-
-
-Responses
-
-
-
-Status
-Meaning
-Description
-Schema
-
-
-
-
-200
-OK
-200 response
-None
+false
+none
+none
@@ -10703,27 +10462,34 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-delete_board_list_card
-
+new_user
+
Code samples
# You can also use wget
-curl -X DELETE /api/boards/{board}/lists/{list}/cards/{card} \
+curl -X POST /api/users \
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
-DELETE /api/boards/{board}/lists/{list}/cards/{card} HTTP/1.1
+POST /api/users HTTP/1.1
-
+Content-Type: multipart/form-data
+Accept: application/json
+
+
var headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
$.ajax({
- url: '/api/boards/{board}/lists/{list}/cards/{card}',
- method: 'delete',
+ url: '/api/users',
+ method: 'post',
headers: headers,
success: function(data) {
@@ -10733,16 +10499,22 @@ $.ajax({
const fetch = require('node-fetch');
-
+const inputBody = '{
+ "username": "string",
+ "email": "string",
+ "password": "string"
+}';
const headers = {
+ 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/lists/{list}/cards/{card}',
+fetch('/api/users',
{
- method: 'DELETE',
-
+ method: 'POST',
+ body: inputBody,
headers: headers
})
.then(function(res) {
@@ -10756,10 +10528,12 @@ fetch('/api/boards/{board}/lists/{list}/cards/{card}'<
require 'json'
headers = {
+ 'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
-result = RestClient.delete '/api/boards/{board}/lists/{list}/cards/{card}',
+result = RestClient.post '/api/users',
params: {
}, headers: headers
@@ -10768,19 +10542,21 @@ p JSON.parse(result)
import requests
headers = {
+ 'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
-r = requests.delete('/api/boards/{board}/lists/{list}/cards/{card}', params={
+r = requests.post('/api/users', params={
}, headers = headers)
print r.json()
-URL obj = new URL("/api/boards/{board}/lists/{list}/cards/{card}");
+URL obj = new URL("/api/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("DELETE");
+con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -10803,12 +10579,14 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Content-Type": []string{"multipart/form-data"},
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("DELETE", "/api/boards/{board}/lists/{list}/cards/{card}", data)
+ req, err := http.NewRequest("POST", "/api/users", data)
req.Header = headers
client := &http.Client{}
@@ -10817,8 +10595,18 @@ System.out.println(response.toString());
}
-DELETE /api/boards/{board}/lists/{list}/cards/{card}
-Parameters
+POST /api/users
+Create a new user
+Only the admin user (the first user) can call the REST API.
+
+Body parameter
+
+username: string
+email: string
+password: string
+
+
+Parameters
@@ -10831,29 +10619,46 @@ System.out.println(response.toString());
-board
-path
+body
+body
+object
+false
+none
+
+
+» username
+body
string
true
-the board value
+the new username
-list
-path
+» email
+body
string
true
-the list value
+the email of the new user
-card
-path
+» password
+body
string
true
-the card value
+the password of the new user
-Responses
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string"
+}
+
+Responses
@@ -10868,7 +10673,29 @@ System.out.println(response.toString());
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
@@ -10876,26 +10703,30 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-get_board_swimlane_cards
-
+get_user
+
Code samples
# You can also use wget
-curl -X GET /api/boards/{board}/swimlanes/{swimlane}/cards \
+curl -X GET /api/users/{user} \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
-GET /api/boards/{board}/swimlanes/{swimlane}/cards HTTP/1.1
+GET /api/users/{user} HTTP/1.1
-
+Accept: application/json
+
+
var headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
$.ajax({
- url: '/api/boards/{board}/swimlanes/{swimlane}/cards',
+ url: '/api/users/{user}',
method: 'get',
headers: headers,
@@ -10908,11 +10739,12 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/swimlanes/{swimlane}/cards',
+fetch('/api/users/{user}',
{
method: 'GET',
@@ -10929,10 +10761,11 @@ fetch('/api/boards/{board}/swimlanes/{swimlane}/cards'
require 'json'
headers = {
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/boards/{board}/swimlanes/{swimlane}/cards',
+result = RestClient.get '/api/users/{user}',
params: {
}, headers: headers
@@ -10941,17 +10774,18 @@ p JSON.parse(result)
import requests
headers = {
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
-r = requests.get('/api/boards/{board}/swimlanes/{swimlane}/cards', params={
+r = requests.get('/api/users/{user}', params={
}, headers = headers)
print r.json()
-URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}/cards");
+URL obj = new URL("/api/users/{user}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -10976,12 +10810,13 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes/{swimlane}/cards", data)
+ req, err := http.NewRequest("GET", "/api/users/{user}", data)
req.Header = headers
client := &http.Client{}
@@ -10990,8 +10825,10 @@ System.out.println(response.toString());
}
-GET /api/boards/{board}/swimlanes/{swimlane}/cards
-Parameters
+GET /api/users/{user}
+get a given user
+Only the admin user (the first user) can call the REST API.
+Parameters
@@ -11004,59 +10841,106 @@ System.out.println(response.toString());
-board
-path
-string
-true
-the board value
-
-
-swimlane
+user
path
string
true
-the swimlane value
-
-
-
-Responses
-
-
-
-Status
-Meaning
-Description
-Schema
-
-
-
-
-200
-OK
-200 response
-None
+the user ID
-
-Users
-add_board_member
-
+Detailed descriptions
+user: the user ID
-Code samples
+Example responses
-# You can also use wget
-curl -X POST /api/boards/{board}/members/{user}/add \
- -H 'Content-Type: multipart/form-data' \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
-
-
-POST /api/boards/{board}/members/{user}/add HTTP/1.1
-
+
+200 Response
+
+{
+ "username": "string",
+ "emails": [
+ {
+ "address": "string",
+ "verified": true
+ }
+ ],
+ "createdAt": "string",
+ "modifiedAt": "string",
+ "profile": {
+ "avatarUrl": "string",
+ "emailBuffer": [
+ "string"
+ ],
+ "fullname": "string",
+ "showDesktopDragHandles": true,
+ "hiddenSystemMessages": true,
+ "hiddenMinicardLabelText": true,
+ "initials": "string",
+ "invitedBoards": [
+ "string"
+ ],
+ "language": "string",
+ "notifications": [],
+ "activity": "string",
+ "read": "string",
+ "showCardsCountAt": 0,
+ "starredBoards": [
+ "string"
+ ],
+ "icode": "string",
+ "boardView": "board-view-lists",
+ "listSortBy": "-modifiedat",
+ "templatesBoardId": "string",
+ "cardTemplatesSwimlaneId": "string",
+ "listTemplatesSwimlaneId": "string",
+ "boardTemplatesSwimlaneId": "string"
+ },
+ "services": {},
+ "heartbeat": "string",
+ "isAdmin": true,
+ "createdThroughApi": true,
+ "loginDisabled": true,
+ "authenticationMethod": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+
+200
+OK
+200 response
+Users
+
+
+
+
+edit_user
+
+
+Code samples
+
+# You can also use wget
+curl -X PUT /api/users/{user} \
+ -H 'Content-Type: multipart/form-data' \
+ -H 'Accept: application/json' \
+ -H 'Authorization: API_KEY'
+
+
+PUT /api/users/{user} HTTP/1.1
+
Content-Type: multipart/form-data
Accept: application/json
@@ -11069,8 +10953,8 @@ Accept: application/json
};
$.ajax({
- url: '/api/boards/{board}/members/{user}/add',
- method: 'post',
+ url: '/api/users/{user}',
+ method: 'put',
headers: headers,
success: function(data) {
@@ -11081,10 +10965,7 @@ $.ajax({
const fetch = require('node-fetch');
const inputBody = '{
- "action": "string",
- "isAdmin": true,
- "isNoComments": true,
- "isCommentOnly": true
+ "action": "string"
}';
const headers = {
'Content-Type':'multipart/form-data',
@@ -11093,9 +10974,9 @@ $.ajax({
};
-fetch('/api/boards/{board}/members/{user}/add',
+fetch('/api/users/{user}',
{
- method: 'POST',
+ method: 'PUT',
body: inputBody,
headers: headers
})
@@ -11115,7 +10996,7 @@ headers = {
'Authorization' => 'API_KEY'
}
-result = RestClient.post '/api/boards/{board}/members/{user}/add',
+result = RestClient.put '/api/users/{user}',
params: {
}, headers: headers
@@ -11129,16 +11010,16 @@ headers = {
'Authorization': 'API_KEY'
}
-r = requests.post('/api/boards/{board}/members/{user}/add', params={
+r = requests.put('/api/users/{user}', params={
}, headers = headers)
print r.json()
-URL obj = new URL("/api/boards/{board}/members/{user}/add");
+URL obj = new URL("/api/users/{user}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
+con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -11168,7 +11049,7 @@ System.out.println(response.toString());
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("POST", "/api/boards/{board}/members/{user}/add", data)
+ req, err := http.NewRequest("PUT", "/api/users/{user}", data)
req.Header = headers
client := &http.Client{}
@@ -11177,21 +11058,22 @@ System.out.println(response.toString());
}
-POST /api/boards/{board}/members/{user}/add
-Add New Board Member with Role
+PUT /api/users/{user}
+edit a given user
Only the admin user (the first user) can call the REST API.
-Note: see Boards.set_board_member_permission
-to later change the permissions.
+Possible values for action:
+
+takeOwnership
: The admin takes the ownership of ALL boards of the user (archived and not archived) where the user is admin on.
+disableLogin
: Disable a user (the user is not allowed to login and his login tokens are purged)
+enableLogin
: Enable a user
+
Body parameter
action: string
-isAdmin: true
-isNoComments: true
-isCommentOnly: true
-Parameters
+Parameters
@@ -11204,13 +11086,6 @@ to later change the permissions.
-board
-path
-string
-true
-the board ID
-
-
user
path
string
@@ -11229,33 +11104,11 @@ to later change the permissions.
body
string
true
-the action value
-
-
-» isAdmin
-body
-boolean
-true
-is the user an admin of the board
-
-
-» isNoComments
-body
-boolean
-true
-disable comments
-
-
-» isCommentOnly
-body
-boolean
-true
-only enable comments
+the action
Detailed descriptions
-board: the board ID
user: the user ID
Example responses
@@ -11268,7 +11121,7 @@ to later change the permissions.
"title": "string"
}
-Responses
+Responses
@@ -11287,7 +11140,7 @@ to later change the permissions.
-Response Schema
+Response Schema
Status Code 200
@@ -11320,31 +11173,31 @@ to later change the permissions.
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-post_board_user_remove
-
+delete_user
+
Code samples
# You can also use wget
-curl -X POST /api/boards/{board}/members/{user}/remove \
- -H 'Content-Type: multipart/form-data' \
+curl -X DELETE /api/users/{user} \
+ -H 'Accept: application/json' \
-H 'Authorization: API_KEY'
-POST /api/boards/{board}/members/{user}/remove HTTP/1.1
+DELETE /api/users/{user} HTTP/1.1
-Content-Type: multipart/form-data
+Accept: application/json
-
+
var headers = {
- 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
$.ajax({
- url: '/api/boards/{board}/members/{user}/remove',
- method: 'post',
+ url: '/api/users/{user}',
+ method: 'delete',
headers: headers,
success: function(data) {
@@ -11354,19 +11207,17 @@ $.ajax({
const fetch = require('node-fetch');
-const inputBody = '{
- "action": "string"
-}';
+
const headers = {
- 'Content-Type':'multipart/form-data',
+ 'Accept':'application/json',
'Authorization':'API_KEY'
};
-fetch('/api/boards/{board}/members/{user}/remove',
+fetch('/api/users/{user}',
{
- method: 'POST',
- body: inputBody,
+ method: 'DELETE',
+
headers: headers
})
.then(function(res) {
@@ -11380,11 +11231,11 @@ fetch('/api/boards/{board}/members/{user}/remove'require 'json'
headers = {
- 'Content-Type' => 'multipart/form-data',
+ 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
-result = RestClient.post '/api/boards/{board}/members/{user}/remove',
+result = RestClient.delete '/api/users/{user}',
params: {
}, headers: headers
@@ -11393,20 +11244,20 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'multipart/form-data',
+ 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
-r = requests.post('/api/boards/{board}/members/{user}/remove', params={
+r = requests.delete('/api/users/{user}', params={
}, headers = headers)
print r.json()
-URL obj = new URL("/api/boards/{board}/members/{user}/remove");
+URL obj = new URL("/api/users/{user}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
+con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -11429,13 +11280,13 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
+ "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("POST", "/api/boards/{board}/members/{user}/remove", data)
+ req, err := http.NewRequest("DELETE", "/api/users/{user}", data)
req.Header = headers
client := &http.Client{}
@@ -11444,14 +11295,10 @@ System.out.println(response.toString());
}
-POST /api/boards/{board}/members/{user}/remove
-
-Body parameter
-
-action: string
-
-
-Parameters
+DELETE /api/users/{user}
+Delete a user
+Only the admin user (the first user) can call the REST API.
+Parameters
@@ -11464,51 +11311,64 @@ System.out.println(response.toString());
-board
-path
-string
-true
-the board value
-
-
user
path
string
true
-the user value
-
-
-body
-body
-object
-false
-none
-
-
-» action
-body
-string
-true
-the action value
+the ID of the user to delete
-Responses
-
-
-
-Status
-Meaning
-Description
-Schema
-
-
-
+Detailed descriptions
+user: the ID of the user to delete
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
200
OK
200 response
-None
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
@@ -11516,18 +11376,19 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-get_current_user
-
+Swimlanes
+get_all_swimlanes
+
Code samples
# You can also use wget
-curl -X GET /api/user \
+curl -X GET /api/boards/{board}/swimlanes \
-H 'Accept: application/json' \
-H 'Authorization: API_KEY'
-GET /api/user HTTP/1.1
+GET /api/boards/{board}/swimlanes HTTP/1.1
Accept: application/json
@@ -11539,7 +11400,7 @@ curl -X GET /api/user \
};
$.ajax({
- url: '/api/user',
+ url: '/api/boards/{board}/swimlanes',
method: 'get',
headers: headers,
@@ -11557,7 +11418,7 @@ $.ajax({
};
-fetch('/api/user',
+fetch('/api/boards/{board}/swimlanes',
{
method: 'GET',
@@ -11578,7 +11439,7 @@ headers = {
'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/user',
+result = RestClient.get '/api/boards/{board}/swimlanes',
params: {
}, headers: headers
@@ -11591,14 +11452,14 @@ headers = {
'Authorization': 'API_KEY'
}
-r = requests.get('/api/user', params={
+r = requests.get('/api/boards/{board}/swimlanes', params={
}, headers = headers)
print r.json()
-URL obj = new URL("/api/user");
+URL obj = new URL("/api/boards/{board}/swimlanes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
@@ -11629,7 +11490,7 @@ System.out.println(response.toString());
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/user", data)
+ req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes", data)
req.Header = headers
client := &http.Client{}
@@ -11638,62 +11499,45 @@ System.out.println(response.toString());
}
-GET /api/user
-returns the current user
+GET /api/boards/{board}/swimlanes
+Get the list of swimlanes attached to a board
+Parameters
+
+
+
+Name
+In
+Type
+Required
+Description
+
+
+
+
+board
+path
+string
+true
+the ID of the board
+
+
+
+Detailed descriptions
+board: the ID of the board
Example responses
200 Response
-{
- "username": "string",
- "emails": [
- {
- "address": "string",
- "verified": true
- }
- ],
- "createdAt": "string",
- "modifiedAt": "string",
- "profile": {
- "avatarUrl": "string",
- "emailBuffer": [
- "string"
- ],
- "fullname": "string",
- "showDesktopDragHandles": true,
- "hiddenSystemMessages": true,
- "hiddenMinicardLabelText": true,
- "initials": "string",
- "invitedBoards": [
- "string"
- ],
- "language": "string",
- "notifications": [],
- "activity": "string",
- "read": "string",
- "showCardsCountAt": 0,
- "starredBoards": [
- "string"
- ],
- "icode": "string",
- "boardView": "board-view-lists",
- "listSortBy": "-modifiedat",
- "templatesBoardId": "string",
- "cardTemplatesSwimlaneId": "string",
- "listTemplatesSwimlaneId": "string",
- "boardTemplatesSwimlaneId": "string"
- },
- "services": {},
- "heartbeat": "string",
- "isAdmin": true,
- "createdThroughApi": true,
- "loginDisabled": true,
- "authenticationMethod": "string"
-}
+[
+ {
+ "_id": "string",
+ "title": "string"
+ }
+]
-Responses
+Responses
@@ -11708,7 +11552,36 @@ System.out.println(response.toString());
200
OK
200 response
-Users
+Inline
+
+
+
+Response Schema
+Status Code 200
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+» _id
+string
+false
+none
+none
+
+
+» title
+string
+false
+none
+none
@@ -11716,31 +11589,34 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-get_all_users
-
+new_swimlane
+
Code samples
# You can also use wget
-curl -X GET /api/users \
+curl -X POST /api/boards/{board}/swimlanes \
+ -H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'Authorization: API_KEY'
-GET /api/users HTTP/1.1
+POST /api/boards/{board}/swimlanes HTTP/1.1
-Accept: application/json
+Content-Type: multipart/form-data
+Accept: application/json
-
+
var headers = {
+ 'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'API_KEY'
};
$.ajax({
- url: '/api/users',
- method: 'get',
+ url: '/api/boards/{board}/swimlanes',
+ method: 'post',
headers: headers,
success: function(data) {
@@ -11750,17 +11626,20 @@ $.ajax({
const fetch = require('node-fetch');
-
+const inputBody = '{
+ "title": "string"
+}';
const headers = {
+ 'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'API_KEY'
};
-fetch('/api/users',
+fetch('/api/boards/{board}/swimlanes',
{
- method: 'GET',
-
+ method: 'POST',
+ body: inputBody,
headers: headers
})
.then(function(res) {
@@ -11774,11 +11653,12 @@ fetch('/api/users',
require 'json'
headers = {
+ 'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/users',
+result = RestClient.post '/api/boards/{board}/swimlanes',
params: {
}, headers: headers
@@ -11787,20 +11667,21 @@ p JSON.parse(result)
import requests
headers = {
+ 'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
-r = requests.get('/api/users', params={
+r = requests.post('/api/boards/{board}/swimlanes', params={
}, headers = headers)
print r.json()
-URL obj = new URL("/api/users");
+URL obj = new URL("/api/boards/{board}/swimlanes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -11823,13 +11704,14 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
+ "Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/users", data)
+ req, err := http.NewRequest("POST", "/api/boards/{board}/swimlanes", data)
req.Header = headers
client := &http.Client{}
@@ -11838,42 +11720,81 @@ System.out.println(response.toString());
}
-GET /api/users
-return all the users
-Only the admin user (the first user) can call the REST API.
-
-Example responses
-
+POST /api/boards/{board}/swimlanes
+Add a swimlane to a board
-200 Response
+Body parameter
-[
- {
- "_id": "string",
- "username": "string"
- }
-]
+title: string
+
-Responses
+Parameters
-Status
-Meaning
+Name
+In
+Type
+Required
Description
-Schema
-200
-OK
-200 response
-Inline
-
-
+board
+path
+string
+true
+the ID of the board
+
+
+body
+body
+object
+false
+none
+
+
+» title
+body
+string
+true
+the new title of the swimlane
+
+
-Response Schema
+Detailed descriptions
+board: the ID of the board
+
+Example responses
+
+
+200 Response
+
+{
+ "_id": "string"
+}
+
+Responses
+
+
+
+Status
+Meaning
+Description
+Schema
+
+
+
+
+200
+OK
+200 response
+Inline
+
+
+
+Response Schema
Status Code 200
@@ -11893,47 +11814,37 @@ System.out.println(response.toString());
none
none
-
-» username
-string
-false
-none
-none
-
-new_user
-
+get_swimlane
+
Code samples
# You can also use wget
-curl -X POST /api/users \
- -H 'Content-Type: multipart/form-data' \
+curl -X GET /api/boards/{board}/swimlanes/{swimlane} \
-H 'Accept: application/json' \
-H 'Authorization: API_KEY'
-POST /api/users HTTP/1.1
+GET /api/boards/{board}/swimlanes/{swimlane} HTTP/1.1
-Content-Type: multipart/form-data
-Accept: application/json
+Accept: application/json
-
+
var headers = {
- 'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'API_KEY'
};
$.ajax({
- url: '/api/users',
- method: 'post',
+ url: '/api/boards/{board}/swimlanes/{swimlane}',
+ method: 'get',
headers: headers,
success: function(data) {
@@ -11943,22 +11854,17 @@ $.ajax({
const fetch = require('node-fetch');
-const inputBody = '{
- "username": "string",
- "email": "string",
- "password": "string"
-}';
+
const headers = {
- 'Content-Type':'multipart/form-data',
'Accept':'application/json',
'Authorization':'API_KEY'
};
-fetch('/api/users',
+fetch('/api/boards/{board}/swimlanes/{swimlane}',
{
- method: 'POST',
- body: inputBody,
+ method: 'GET',
+
headers: headers
})
.then(function(res) {
@@ -11972,12 +11878,11 @@ fetch('/api/users',
require 'json'
headers = {
- 'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
-result = RestClient.post '/api/users',
+result = RestClient.get '/api/boards/{board}/swimlanes/{swimlane}',
params: {
}, headers: headers
@@ -11986,21 +11891,20 @@ p JSON.parse(result)
import requests
headers = {
- 'Content-Type': 'multipart/form-data',
'Accept': 'application/json',
'Authorization': 'API_KEY'
}
-r = requests.post('/api/users', params={
+r = requests.get('/api/boards/{board}/swimlanes/{swimlane}', params={
}, headers = headers)
print r.json()
-URL obj = new URL("/api/users");
+URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
+con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -12023,14 +11927,13 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
"Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("POST", "/api/users", data)
+ req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes/{swimlane}", data)
req.Header = headers
client := &http.Client{}
@@ -12039,18 +11942,9 @@ System.out.println(response.toString());
}
-POST /api/users
-Create a new user
-Only the admin user (the first user) can call the REST API.
-
-Body parameter
-
-username: string
-email: string
-password: string
-
-
-Parameters
+GET /api/boards/{board}/swimlanes/{swimlane}
+Get a swimlane
+Parameters
@@ -12063,35 +11957,24 @@ System.out.println(response.toString());
-body
-body
-object
-false
-none
-
-
-» username
-body
-string
-true
-the new username
-
-
-» email
-body
+board
+path
string
true
-the email of the new user
+the ID of the board
-» password
-body
+swimlane
+path
string
true
-the password of the new user
+the ID of the swimlane
+Detailed descriptions
+board: the ID of the board
+swimlane: the ID of the swimlane
Example responses
@@ -12099,10 +11982,18 @@ System.out.println(response.toString());
200 Response
{
- "_id": "string"
+ "title": "string",
+ "archived": true,
+ "boardId": "string",
+ "createdAt": "string",
+ "sort": 0,
+ "color": "white",
+ "updatedAt": "string",
+ "modifiedAt": "string",
+ "type": "string"
}
-Responses
+Responses
@@ -12117,29 +12008,7 @@ System.out.println(response.toString());
200
OK
200 response
-Inline
-
-
-
-Response Schema
-Status Code 200
-
-
-
-Name
-Type
-Required
-Restrictions
-Description
-
-
-
-
-» _id
-string
-false
-none
-none
+Swimlanes
@@ -12147,31 +12016,27 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-get_user
-
+delete_board_swimlane
+
Code samples
# You can also use wget
-curl -X GET /api/users/{user} \
- -H 'Accept: application/json' \
+curl -X DELETE /api/boards/{board}/swimlanes/{swimlane} \
-H 'Authorization: API_KEY'
-GET /api/users/{user} HTTP/1.1
-
-Accept: application/json
+DELETE /api/boards/{board}/swimlanes/{swimlane} HTTP/1.1
-
+
var headers = {
- 'Accept':'application/json',
'Authorization':'API_KEY'
};
$.ajax({
- url: '/api/users/{user}',
- method: 'get',
+ url: '/api/boards/{board}/swimlanes/{swimlane}',
+ method: 'delete',
headers: headers,
success: function(data) {
@@ -12183,14 +12048,13 @@ $.ajax({
const fetch = require('node-fetch');
const headers = {
- 'Accept':'application/json',
'Authorization':'API_KEY'
};
-fetch('/api/users/{user}',
+fetch('/api/boards/{board}/swimlanes/{swimlane}',
{
- method: 'GET',
+ method: 'DELETE',
headers: headers
})
@@ -12205,11 +12069,10 @@ fetch('/api/users/{user}',
require 'json'
headers = {
- 'Accept' => 'application/json',
'Authorization' => 'API_KEY'
}
-result = RestClient.get '/api/users/{user}',
+result = RestClient.delete '/api/boards/{board}/swimlanes/{swimlane}',
params: {
}, headers: headers
@@ -12218,20 +12081,19 @@ p JSON.parse(result)
import requests
headers = {
- 'Accept': 'application/json',
'Authorization': 'API_KEY'
}
-r = requests.get('/api/users/{user}', params={
+r = requests.delete('/api/boards/{board}/swimlanes/{swimlane}', params={
}, headers = headers)
print r.json()
-URL obj = new URL("/api/users/{user}");
+URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
+con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
@@ -12254,13 +12116,12 @@ System.out.println(response.toString());
func main() {
headers := map[string][]string{
- "Accept": []string{"application/json"},
"Authorization": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/users/{user}", data)
+ req, err := http.NewRequest("DELETE", "/api/boards/{board}/swimlanes/{swimlane}", data)
req.Header = headers
client := &http.Client{}
@@ -12269,10 +12130,8 @@ System.out.println(response.toString());
}
-GET /api/users/{user}
-get a given user
-Only the admin user (the first user) can call the REST API.
-Parameters
+DELETE /api/boards/{board}/swimlanes/{swimlane}
+Parameters
@@ -12285,70 +12144,22 @@ System.out.println(response.toString());
-user
+board
path
string
true
-the user ID
+the board value
+
+
+swimlane
+path
+string
+true
+the swimlane value
-Detailed descriptions
-user: the user ID
-
-Example responses
-
-
-200 Response
-
-{
- "username": "string",
- "emails": [
- {
- "address": "string",
- "verified": true
- }
- ],
- "createdAt": "string",
- "modifiedAt": "string",
- "profile": {
- "avatarUrl": "string",
- "emailBuffer": [
- "string"
- ],
- "fullname": "string",
- "showDesktopDragHandles": true,
- "hiddenSystemMessages": true,
- "hiddenMinicardLabelText": true,
- "initials": "string",
- "invitedBoards": [
- "string"
- ],
- "language": "string",
- "notifications": [],
- "activity": "string",
- "read": "string",
- "showCardsCountAt": 0,
- "starredBoards": [
- "string"
- ],
- "icode": "string",
- "boardView": "board-view-lists",
- "listSortBy": "-modifiedat",
- "templatesBoardId": "string",
- "cardTemplatesSwimlaneId": "string",
- "listTemplatesSwimlaneId": "string",
- "boardTemplatesSwimlaneId": "string"
- },
- "services": {},
- "heartbeat": "string",
- "isAdmin": true,
- "createdThroughApi": true,
- "loginDisabled": true,
- "authenticationMethod": "string"
-}
-
-Responses
+Responses
@@ -12363,7 +12174,7 @@ System.out.println(response.toString());
200
OK
200 response
-Users
+None
@@ -12371,1852 +12182,67 @@ System.out.println(response.toString());
To perform this operation, you must be authenticated by means of one of the following methods:
UserSecurity
-edit_user
-
-
-Code samples
-
-# You can also use wget
-curl -X PUT /api/users/{user} \
- -H 'Content-Type: multipart/form-data' \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
-
-
-PUT /api/users/{user} HTTP/1.1
-
-Content-Type: multipart/form-data
-Accept: application/json
-
-
-var headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/users/{user}',
- method: 'put',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-const inputBody = '{
- "action": "string"
-}';
-const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-fetch('/api/users/{user}',
-{
- method: 'PUT',
- body: inputBody,
- headers: headers
-})
-.then(function(res) {
- return res.json();
-}).then(function(body) {
- console.log(body);
-});
-
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Content-Type' => 'multipart/form-data',
- 'Accept' => 'application/json',
- 'Authorization' => 'API_KEY'
-}
-
-result = RestClient.put '/api/users/{user}',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
-
-
-import requests
-headers = {
- 'Content-Type': 'multipart/form-data',
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
-}
-
-r = requests.put('/api/users/{user}', params={
-
-}, headers = headers)
-
-print r.json()
-
-
-URL obj = new URL("/api/users/{user}");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("PUT");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
- new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-
-package main
-
-import (
- "bytes"
- "net/http"
-)
-
-func main() {
-
- headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
- }
-
- data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("PUT", "/api/users/{user}", data)
- req.Header = headers
-
- client := &http.Client{}
- resp, err := client.Do(req)
- // ...
-}
-
-
-PUT /api/users/{user}
-edit a given user
-Only the admin user (the first user) can call the REST API.
-Possible values for action:
-
-takeOwnership
: The admin takes the ownership of ALL boards of the user (archived and not archived) where the user is admin on.
-disableLogin
: Disable a user (the user is not allowed to login and his login tokens are purged)
-enableLogin
: Enable a user
-
-
-Body parameter
-
-action: string
-
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-
-user
-path
-string
-true
-the user ID
-
-
-body
-body
-object
-false
-none
-
-
-» action
-body
-string
-true
-the action
-
-
-
-Detailed descriptions
-user: the user ID
-
-Example responses
-
-
-200 Response
-
+Schemas
+Boards
+
{
- "_id": "string",
- "title": "string"
-}
-
-Responses
-
-
-
-Status
-Meaning
-Description
-Schema
-
-
-
-
-200
-OK
-200 response
-Inline
-
-
-
-Response Schema
-Status Code 200
-
-
-
-Name
-Type
-Required
-Restrictions
-Description
-
-
-
-
-» _id
-string
-false
-none
-none
-
-
-» title
-string
-false
-none
-none
-
-
-
-
-delete_user
-
-
-Code samples
-
-# You can also use wget
-curl -X DELETE /api/users/{user} \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
-
-
-DELETE /api/users/{user} HTTP/1.1
-
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/users/{user}',
- method: 'delete',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-fetch('/api/users/{user}',
-{
- method: 'DELETE',
-
- headers: headers
-})
-.then(function(res) {
- return res.json();
-}).then(function(body) {
- console.log(body);
-});
-
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'Authorization' => 'API_KEY'
-}
-
-result = RestClient.delete '/api/users/{user}',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
-
-
-import requests
-headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
-}
-
-r = requests.delete('/api/users/{user}', params={
-
-}, headers = headers)
-
-print r.json()
-
-
-URL obj = new URL("/api/users/{user}");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("DELETE");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
- new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-
-package main
-
-import (
- "bytes"
- "net/http"
-)
-
-func main() {
-
- headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ "title": "string",
+ "slug": "string",
+ "archived": true,
+ "createdAt": "string",
+ "modifiedAt": "string",
+ "stars": 0,
+ "labels": [
+ {
+ "_id": "string",
+ "name": "string",
+ "color": "green"
}
-
- data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("DELETE", "/api/users/{user}", data)
- req.Header = headers
-
- client := &http.Client{}
- resp, err := client.Do(req)
- // ...
-}
-
-
-DELETE /api/users/{user}
-Delete a user
-Only the admin user (the first user) can call the REST API.
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-
-user
-path
-string
-true
-the ID of the user to delete
-
-
-
-Detailed descriptions
-user: the ID of the user to delete
-
-Example responses
-
-
-200 Response
-
-{
- "_id": "string"
-}
-
-Responses
-
-
-
-Status
-Meaning
-Description
-Schema
-
-
-
-
-200
-OK
-200 response
-Inline
-
-
-
-Response Schema
-Status Code 200
-
-
-
-Name
-Type
-Required
-Restrictions
-Description
-
-
-
-
-» _id
-string
-false
-none
-none
-
-
-
-
-Swimlanes
-get_all_swimlanes
-
-
-Code samples
-
-# You can also use wget
-curl -X GET /api/boards/{board}/swimlanes \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
-
-
-GET /api/boards/{board}/swimlanes HTTP/1.1
-
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/swimlanes',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-fetch('/api/boards/{board}/swimlanes',
-{
- method: 'GET',
-
- headers: headers
-})
-.then(function(res) {
- return res.json();
-}).then(function(body) {
- console.log(body);
-});
-
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'Authorization' => 'API_KEY'
-}
-
-result = RestClient.get '/api/boards/{board}/swimlanes',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
-
-
-import requests
-headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
-}
-
-r = requests.get('/api/boards/{board}/swimlanes', params={
-
-}, headers = headers)
-
-print r.json()
-
-
-URL obj = new URL("/api/boards/{board}/swimlanes");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
- new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-
-package main
-
-import (
- "bytes"
- "net/http"
-)
-
-func main() {
-
- headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
+ ],
+ "members": [
+ {
+ "userId": "string",
+ "isAdmin": true,
+ "isActive": true,
+ "isNoComments": true,
+ "isCommentOnly": true,
+ "isWorker": true
}
-
- data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes", data)
- req.Header = headers
-
- client := &http.Client{}
- resp, err := client.Do(req)
- // ...
-}
-
-
-GET /api/boards/{board}/swimlanes
-Get the list of swimlanes attached to a board
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-
-board
-path
-string
-true
-the ID of the board
-
-
-
-Detailed descriptions
-board: the ID of the board
-
-Example responses
-
-
-200 Response
-
-[
- {
- "_id": "string",
- "title": "string"
- }
-]
-
-Responses
-
-
-
-Status
-Meaning
-Description
-Schema
-
-
-
-
-200
-OK
-200 response
-Inline
-
-
-
-Response Schema
-Status Code 200
-
-
-
-Name
-Type
-Required
-Restrictions
-Description
-
-
-
-
-» _id
-string
-false
-none
-none
-
-
-» title
-string
-false
-none
-none
-
-
-
-
-new_swimlane
-
-
-Code samples
-
-# You can also use wget
-curl -X POST /api/boards/{board}/swimlanes \
- -H 'Content-Type: multipart/form-data' \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
-
-
-POST /api/boards/{board}/swimlanes HTTP/1.1
-
-Content-Type: multipart/form-data
-Accept: application/json
-
-
-var headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/swimlanes',
- method: 'post',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-const inputBody = '{
- "title": "string"
-}';
-const headers = {
- 'Content-Type':'multipart/form-data',
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-fetch('/api/boards/{board}/swimlanes',
-{
- method: 'POST',
- body: inputBody,
- headers: headers
-})
-.then(function(res) {
- return res.json();
-}).then(function(body) {
- console.log(body);
-});
-
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Content-Type' => 'multipart/form-data',
- 'Accept' => 'application/json',
- 'Authorization' => 'API_KEY'
-}
-
-result = RestClient.post '/api/boards/{board}/swimlanes',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
-
-
-import requests
-headers = {
- 'Content-Type': 'multipart/form-data',
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
-}
-
-r = requests.post('/api/boards/{board}/swimlanes', params={
-
-}, headers = headers)
-
-print r.json()
-
-
-URL obj = new URL("/api/boards/{board}/swimlanes");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("POST");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
- new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-
-package main
-
-import (
- "bytes"
- "net/http"
-)
-
-func main() {
-
- headers := map[string][]string{
- "Content-Type": []string{"multipart/form-data"},
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
- }
-
- data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("POST", "/api/boards/{board}/swimlanes", data)
- req.Header = headers
-
- client := &http.Client{}
- resp, err := client.Do(req)
- // ...
-}
-
-
-POST /api/boards/{board}/swimlanes
-Add a swimlane to a board
-
-Body parameter
-
-title: string
-
-
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-
-board
-path
-string
-true
-the ID of the board
-
-
-body
-body
-object
-false
-none
-
-
-» title
-body
-string
-true
-the new title of the swimlane
-
-
-
-Detailed descriptions
-board: the ID of the board
-
-Example responses
-
-
-200 Response
-
-{
- "_id": "string"
-}
-
-Responses
-
-
-
-Status
-Meaning
-Description
-Schema
-
-
-
-
-200
-OK
-200 response
-Inline
-
-
-
-Response Schema
-Status Code 200
-
-
-
-Name
-Type
-Required
-Restrictions
-Description
-
-
-
-
-» _id
-string
-false
-none
-none
-
-
-
-
-get_swimlane
-
-
-Code samples
-
-# You can also use wget
-curl -X GET /api/boards/{board}/swimlanes/{swimlane} \
- -H 'Accept: application/json' \
- -H 'Authorization: API_KEY'
-
-
-GET /api/boards/{board}/swimlanes/{swimlane} HTTP/1.1
-
-Accept: application/json
-
-
-var headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/swimlanes/{swimlane}',
- method: 'get',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-
-const headers = {
- 'Accept':'application/json',
- 'Authorization':'API_KEY'
-
-};
-
-fetch('/api/boards/{board}/swimlanes/{swimlane}',
-{
- method: 'GET',
-
- headers: headers
-})
-.then(function(res) {
- return res.json();
-}).then(function(body) {
- console.log(body);
-});
-
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Accept' => 'application/json',
- 'Authorization' => 'API_KEY'
-}
-
-result = RestClient.get '/api/boards/{board}/swimlanes/{swimlane}',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
-
-
-import requests
-headers = {
- 'Accept': 'application/json',
- 'Authorization': 'API_KEY'
-}
-
-r = requests.get('/api/boards/{board}/swimlanes/{swimlane}', params={
-
-}, headers = headers)
-
-print r.json()
-
-
-URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("GET");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
- new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-
-package main
-
-import (
- "bytes"
- "net/http"
-)
-
-func main() {
-
- headers := map[string][]string{
- "Accept": []string{"application/json"},
- "Authorization": []string{"API_KEY"},
-
- }
-
- data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes/{swimlane}", data)
- req.Header = headers
-
- client := &http.Client{}
- resp, err := client.Do(req)
- // ...
-}
-
-
-GET /api/boards/{board}/swimlanes/{swimlane}
-Get a swimlane
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-
-board
-path
-string
-true
-the ID of the board
-
-
-swimlane
-path
-string
-true
-the ID of the swimlane
-
-
-
-Detailed descriptions
-board: the ID of the board
-swimlane: the ID of the swimlane
-
-Example responses
-
-
-200 Response
-
-{
- "title": "string",
- "archived": true,
- "boardId": "string",
- "createdAt": "string",
- "sort": 0,
- "color": "white",
- "updatedAt": "string",
- "modifiedAt": "string",
- "type": "string"
-}
-
-Responses
-
-
-
-Status
-Meaning
-Description
-Schema
-
-
-
-
-200
-OK
-200 response
-Swimlanes
-
-
-
-
-delete_board_swimlane
-
-
-Code samples
-
-# You can also use wget
-curl -X DELETE /api/boards/{board}/swimlanes/{swimlane} \
- -H 'Authorization: API_KEY'
-
-
-DELETE /api/boards/{board}/swimlanes/{swimlane} HTTP/1.1
-
-
-var headers = {
- 'Authorization':'API_KEY'
-
-};
-
-$.ajax({
- url: '/api/boards/{board}/swimlanes/{swimlane}',
- method: 'delete',
-
- headers: headers,
- success: function(data) {
- console.log(JSON.stringify(data));
- }
-})
-
-
-const fetch = require('node-fetch');
-
-const headers = {
- 'Authorization':'API_KEY'
-
-};
-
-fetch('/api/boards/{board}/swimlanes/{swimlane}',
-{
- method: 'DELETE',
-
- headers: headers
-})
-.then(function(res) {
- return res.json();
-}).then(function(body) {
- console.log(body);
-});
-
-
-require 'rest-client'
-require 'json'
-
-headers = {
- 'Authorization' => 'API_KEY'
-}
-
-result = RestClient.delete '/api/boards/{board}/swimlanes/{swimlane}',
- params: {
- }, headers: headers
-
-p JSON.parse(result)
-
-
-import requests
-headers = {
- 'Authorization': 'API_KEY'
-}
-
-r = requests.delete('/api/boards/{board}/swimlanes/{swimlane}', params={
-
-}, headers = headers)
-
-print r.json()
-
-
-URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}");
-HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("DELETE");
-int responseCode = con.getResponseCode();
-BufferedReader in = new BufferedReader(
- new InputStreamReader(con.getInputStream()));
-String inputLine;
-StringBuffer response = new StringBuffer();
-while ((inputLine = in.readLine()) != null) {
- response.append(inputLine);
-}
-in.close();
-System.out.println(response.toString());
-
-
-package main
-
-import (
- "bytes"
- "net/http"
-)
-
-func main() {
-
- headers := map[string][]string{
- "Authorization": []string{"API_KEY"},
-
- }
-
- data := bytes.NewBuffer([]byte{jsonReq})
- req, err := http.NewRequest("DELETE", "/api/boards/{board}/swimlanes/{swimlane}", data)
- req.Header = headers
-
- client := &http.Client{}
- resp, err := client.Do(req)
- // ...
-}
-
-
-DELETE /api/boards/{board}/swimlanes/{swimlane}
-Parameters
-
-
-
-Name
-In
-Type
-Required
-Description
-
-
-
-
-board
-path
-string
-true
-the board value
-
-
-swimlane
-path
-string
-true
-the swimlane value
-
-
-
-Responses
-
-
-
-Status
-Meaning
-Description
-Schema
-
-
-
-
-200
-OK
-200 response
-None
-
-
-
-
-Schemas
-Boards
-
-{
- "title": "string",
- "slug": "string",
- "archived": true,
- "createdAt": "string",
- "modifiedAt": "string",
- "stars": 0,
- "labels": [
- {
- "_id": "string",
- "name": "string",
- "color": "green"
- }
- ],
- "members": [
- {
- "userId": "string",
- "isAdmin": true,
- "isActive": true,
- "isNoComments": true,
- "isCommentOnly": true,
- "isWorker": true
- }
- ],
- "permission": "public",
- "color": "belize",
- "description": "string",
- "subtasksDefaultBoardId": "string",
- "subtasksDefaultListId": "string",
- "dateSettingsDefaultBoardId": "string",
- "dateSettingsDefaultListId": "string",
- "allowsSubtasks": true,
- "allowsAttachments": true,
- "allowsChecklists": true,
- "allowsComments": true,
- "allowsDescriptionTitle": true,
- "allowsDescriptionText": true,
- "allowsActivities": true,
- "allowsLabels": true,
- "allowsAssignee": true,
- "allowsMembers": true,
- "allowsRequestedBy": true,
- "allowsAssignedBy": true,
- "allowsReceivedDate": true,
- "allowsStartDate": true,
- "allowsEndDate": true,
- "allowsDueDate": true,
- "presentParentTask": "prefix-with-full-path",
- "startAt": "string",
- "dueAt": "string",
- "endAt": "string",
- "spentTime": 0,
- "isOvertime": true,
- "type": "string"
-}
-
-
-This is a Board.
-Properties
-
-
-
-Name
-Type
-Required
-Restrictions
-Description
-
-
-
-
-title
-string
-true
-none
-The title of the board
-
-
-slug
-string
-true
-none
-The title slugified.
-
-
-archived
-boolean
-true
-none
-Is the board archived?
-
-
-createdAt
-string
-true
-none
-Creation time of the board
-
-
-modifiedAt
-string|null
-false
-none
-Last modification time of the board
-
-
-stars
-number
-true
-none
-How many stars the board has
-
-
-labels
-[BoardsLabels]
-true
-none
-List of labels attached to a board
-
-
-members
-[BoardsMembers]
-true
-none
-List of members of a board
-
-
-permission
-string
-true
-none
-visibility of the board
-
-
-color
-string
-true
-none
-The color of the board.
-
-
-description
-string|null
-false
-none
-The description of the board
-
-
-subtasksDefaultBoardId
-string|null
-false
-none
-The default board ID assigned to subtasks.
-
-
-subtasksDefaultListId
-string|null
-false
-none
-The default List ID assigned to subtasks.
-
-
-dateSettingsDefaultBoardId
-string|null
-false
-none
-none
-
-
-dateSettingsDefaultListId
-string|null
-false
-none
-none
-
-
-allowsSubtasks
-boolean
-true
-none
-Does the board allows subtasks?
-
-
-allowsAttachments
-boolean
-true
-none
-Does the board allows attachments?
-
-
-allowsChecklists
-boolean
-true
-none
-Does the board allows checklists?
-
-
-allowsComments
-boolean
-true
-none
-Does the board allows comments?
-
-
-allowsDescriptionTitle
-boolean
-true
-none
-Does the board allows description title?
-
-
-allowsDescriptionText
-boolean
-true
-none
-Does the board allows description text?
-
-
-allowsActivities
-boolean
-true
-none
-Does the board allows comments?
-
-
-allowsLabels
-boolean
-true
-none
-Does the board allows labels?
-
-
-allowsAssignee
-boolean
-true
-none
-Does the board allows assignee?
-
-
-allowsMembers
-boolean
-true
-none
-Does the board allows members?
-
-
-allowsRequestedBy
-boolean
-true
-none
-Does the board allows requested by?
-
-
-allowsAssignedBy
-boolean
-true
-none
-Does the board allows requested by?
-
-
-allowsReceivedDate
-boolean
-true
-none
-Does the board allows received date?
-
-
-allowsStartDate
-boolean
-true
-none
-Does the board allows start date?
-
-
-allowsEndDate
-boolean
-true
-none
-Does the board allows end date?
-
-
-allowsDueDate
-boolean
-true
-none
-Does the board allows due date?
-
-
-presentParentTask
-string|null
-false
-none
-Controls how to present the parent task: - prefix-with-full-path
: add a prefix with the full path - prefix-with-parent
: add a prefisx with the parent name - subtext-with-full-path
: add a subtext with the full path - subtext-with-parent
: add a subtext with the parent name - no-parent
: does not show the parent at all
-
-
-startAt
-string|null
-false
-none
-Starting date of the board.
-
-
-dueAt
-string|null
-false
-none
-Due date of the board.
-
-
-endAt
-string|null
-false
-none
-End date of the board.
-
-
-spentTime
-number|null
-false
-none
-Time spent in the board.
-
-
-isOvertime
-boolean|null
-false
-none
-Is the board overtimed?
-
-
-type
-string
-true
-none
-The type of board
-
-
-
-Enumerated Values
-
-
-
-Property
-Value
-
-
-
-
-permission
-public
-
-
-permission
-private
-
-
-color
-belize
-
-
-color
-nephritis
-
-
-color
-pomegranate
-
-
-color
-pumpkin
-
-
-color
-wisteria
-
-
-color
-moderatepink
-
-
-color
-strongcyan
-
-
-color
-limegreen
-
-
-color
-midnight
-
-
-color
-dark
-
-
-color
-relax
-
-
-color
-corteza
-
-
-presentParentTask
-prefix-with-full-path
-
-
-presentParentTask
-prefix-with-parent
-
-
-presentParentTask
-subtext-with-full-path
-
-
-presentParentTask
-subtext-with-parent
-
-
-presentParentTask
-no-parent
-
-
-
-BoardsLabels
-
-{
- "_id": "string",
- "name": "string",
- "color": "green"
-}
-
-
-Properties
-
-
-
-Name
-Type
-Required
-Restrictions
-Description
-
-
-
-
-_id
-string
-true
-none
-Unique id of a label
-
-
-name
-string
-false
-none
-Name of a label
-
-
-color
-string
-true
-none
-color of a label. Can be amongst green
, yellow
, orange
, red
, purple
, blue
, sky
, lime
, pink
, black
, silver
, peachpuff
, crimson
, plum
, darkgreen
, slateblue
, magenta
, gold
, navy
, gray
, saddlebrown
, paleturquoise
, mistyrose
, indigo
-
-
-
-Enumerated Values
-
-
-
-Property
-Value
-
-
-
-
-color
-green
-
-
-color
-yellow
-
-
-color
-orange
-
-
-color
-red
-
-
-color
-purple
-
-
-color
-blue
-
-
-color
-sky
-
-
-color
-lime
-
-
-color
-pink
-
-
-color
-black
-
-
-color
-silver
-
-
-color
-peachpuff
-
-
-color
-crimson
-
-
-color
-plum
-
-
-color
-darkgreen
-
-
-color
-slateblue
-
-
-color
-magenta
-
-
-color
-gold
-
-
-color
-navy
-
-
-color
-gray
-
-
-color
-saddlebrown
-
-
-color
-paleturquoise
-
-
-color
-mistyrose
-
-
-color
-indigo
-
-
-
-BoardsMembers
-
-{
- "userId": "string",
- "isAdmin": true,
- "isActive": true,
- "isNoComments": true,
- "isCommentOnly": true,
- "isWorker": true
+ ],
+ "permission": "public",
+ "color": "belize",
+ "description": "string",
+ "subtasksDefaultBoardId": "string",
+ "subtasksDefaultListId": "string",
+ "dateSettingsDefaultBoardId": "string",
+ "dateSettingsDefaultListId": "string",
+ "allowsSubtasks": true,
+ "allowsAttachments": true,
+ "allowsChecklists": true,
+ "allowsComments": true,
+ "allowsDescriptionTitle": true,
+ "allowsDescriptionText": true,
+ "allowsActivities": true,
+ "allowsLabels": true,
+ "allowsAssignee": true,
+ "allowsMembers": true,
+ "allowsRequestedBy": true,
+ "allowsAssignedBy": true,
+ "allowsReceivedDate": true,
+ "allowsStartDate": true,
+ "allowsEndDate": true,
+ "allowsDueDate": true,
+ "presentParentTask": "prefix-with-full-path",
+ "startAt": "string",
+ "dueAt": "string",
+ "endAt": "string",
+ "spentTime": 0,
+ "isOvertime": true,
+ "type": "string"
}
+This is a Board.
Properties
@@ -14230,392 +12256,401 @@ UserSecurity
-userId
+title
string
true
none
-The uniq ID of the member
+The title of the board
-isAdmin
-boolean
+slug
+string
true
none
-Is the member an admin of the board?
+The title slugified.
-isActive
+archived
boolean
true
none
-Is the member active?
-
-
-isNoComments
-boolean
-false
-none
-Is the member not allowed to make comments
+Is the board archived?
-isCommentOnly
-boolean
-false
+createdAt
+string
+true
none
-Is the member only allowed to comment on the board
+Creation time of the board
-isWorker
-boolean
+modifiedAt
+string|null
false
none
-Is the member only allowed to move card, assign himself to card and comment
-
-
-
-CardComments
-
-{
- "boardId": "string",
- "cardId": "string",
- "text": "string",
- "createdAt": "string",
- "modifiedAt": "string",
- "userId": "string"
-}
-
-
-A comment on a card
-Properties
-
-
-
-Name
-Type
-Required
-Restrictions
-Description
+Last modification time of the board
-
-
-boardId
-string
+stars
+number
true
none
-the board ID
+How many stars the board has
-cardId
-string
+labels
+[BoardsLabels]
true
none
-the card ID
+List of labels attached to a board
-text
-string
+members
+[BoardsMembers]
true
none
-the text of the comment
+List of members of a board
-createdAt
+permission
string
true
none
-when was the comment created
+visibility of the board
-modifiedAt
+color
string
true
none
-none
+The color of the board.
-userId
-string
-true
+description
+string|null
+false
none
-the author ID of the comment
-
-
-
-Cards
-
-{
- "title": "string",
- "archived": true,
- "parentId": "string",
- "listId": "string",
- "swimlaneId": "string",
- "boardId": "string",
- "coverId": "string",
- "color": "white",
- "createdAt": "string",
- "modifiedAt": "string",
- "customFields": [
- {}
- ],
- "dateLastActivity": "string",
- "description": "string",
- "requestedBy": "string",
- "assignedBy": "string",
- "labelIds": [
- "string"
- ],
- "members": [
- "string"
- ],
- "assignees": [
- "string"
- ],
- "receivedAt": "string",
- "startAt": "string",
- "dueAt": "string",
- "endAt": "string",
- "spentTime": 0,
- "isOvertime": true,
- "userId": "string",
- "sort": 0,
- "subtaskSort": 0,
- "type": "string",
- "linkedId": "string",
- "vote": {
- "question": "string",
- "positive": [
- "string"
- ],
- "negative": [
- "string"
- ],
- "end": "string"
- }
-}
-
-
-Properties
-
-
-
-Name
-Type
-Required
-Restrictions
-Description
+The description of the board
-
-
-title
+subtasksDefaultBoardId
string|null
false
none
-the title of the card
+The default board ID assigned to subtasks.
-archived
-boolean
-true
+subtasksDefaultListId
+string|null
+false
none
-is the card archived
+The default List ID assigned to subtasks.
-parentId
+dateSettingsDefaultBoardId
string|null
false
none
-ID of the parent card
+none
-listId
+dateSettingsDefaultListId
string|null
false
none
-List ID where the card is
+none
-swimlaneId
-string
+allowsSubtasks
+boolean
true
none
-Swimlane ID where the card is
+Does the board allows subtasks?
-boardId
-string|null
-false
+allowsAttachments
+boolean
+true
none
-Board ID of the card
+Does the board allows attachments?
-coverId
-string|null
-false
+allowsChecklists
+boolean
+true
none
-Cover ID of the card
+Does the board allows checklists?
-color
-string|null
-false
+allowsComments
+boolean
+true
none
+Does the board allows comments?
+
+
+allowsDescriptionTitle
+boolean
+true
none
+Does the board allows description title?
-createdAt
-string
+allowsDescriptionText
+boolean
true
none
-creation date
+Does the board allows description text?
-modifiedAt
-string
+allowsActivities
+boolean
true
none
+Does the board allows comments?
+
+
+allowsLabels
+boolean
+true
none
+Does the board allows labels?
-customFields
-[CardsCustomfields]|null
-false
+allowsAssignee
+boolean
+true
none
-list of custom fields
+Does the board allows assignee?
-dateLastActivity
-string
+allowsMembers
+boolean
true
none
-Date of last activity
+Does the board allows members?
-description
-string|null
-false
+allowsRequestedBy
+boolean
+true
none
-description of the card
+Does the board allows requested by?
-requestedBy
-string|null
-false
+allowsAssignedBy
+boolean
+true
none
-who requested the card (ID of the user)
+Does the board allows requested by?
-assignedBy
-string|null
-false
+allowsReceivedDate
+boolean
+true
none
-who assigned the card (ID of the user)
+Does the board allows received date?
-labelIds
-[string]|null
-false
+allowsStartDate
+boolean
+true
none
-list of labels ID the card has
+Does the board allows start date?
-members
-[string]|null
-false
+allowsEndDate
+boolean
+true
none
-list of members (user IDs)
+Does the board allows end date?
-assignees
-[string]|null
-false
+allowsDueDate
+boolean
+true
none
-who is assignee of the card (user ID), maximum one ID of assignee in array.
+Does the board allows due date?
-receivedAt
+presentParentTask
string|null
false
none
-Date the card was received
+Controls how to present the parent task: - prefix-with-full-path
: add a prefix with the full path - prefix-with-parent
: add a prefisx with the parent name - subtext-with-full-path
: add a subtext with the full path - subtext-with-parent
: add a subtext with the parent name - no-parent
: does not show the parent at all
startAt
string|null
false
none
-Date the card was started to be worked on
+Starting date of the board.
dueAt
string|null
false
none
-Date the card is due
+Due date of the board.
endAt
string|null
false
none
-Date the card ended
+End date of the board.
spentTime
number|null
false
none
-How much time has been spent on this
+Time spent in the board.
isOvertime
boolean|null
false
none
-is the card over time?
+Is the board overtimed?
-userId
+type
string
true
none
-user ID of the author of the card
+The type of board
+
+
+Enumerated Values
+
+
-sort
-number
-true
-none
-Sort value
+Property
+Value
+
+
+
+
+permission
+public
-subtaskSort
-number|null
-false
-none
-subtask sort value
+permission
+private
-type
+color
+belize
+
+
+color
+nephritis
+
+
+color
+pomegranate
+
+
+color
+pumpkin
+
+
+color
+wisteria
+
+
+color
+moderatepink
+
+
+color
+strongcyan
+
+
+color
+limegreen
+
+
+color
+midnight
+
+
+color
+dark
+
+
+color
+relax
+
+
+color
+corteza
+
+
+presentParentTask
+prefix-with-full-path
+
+
+presentParentTask
+prefix-with-parent
+
+
+presentParentTask
+subtext-with-full-path
+
+
+presentParentTask
+subtext-with-parent
+
+
+presentParentTask
+no-parent
+
+
+
+BoardsLabels
+
+{
+ "_id": "string",
+ "name": "string",
+ "color": "green"
+}
+
+
+Properties
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+_id
string
true
none
-type of the card
+Unique id of a label
-linkedId
-string|null
+name
+string
false
none
-ID of the linked card
+Name of a label
-vote
-CardsVote
-false
+color
+string
+true
none
-vote object, see below
+color of a label. Can be amongst green
, yellow
, orange
, red
, purple
, blue
, sky
, lime
, pink
, black
, silver
, peachpuff
, crimson
, plum
, darkgreen
, slateblue
, magenta
, gold
, navy
, gray
, saddlebrown
, paleturquoise
, mistyrose
, indigo
@@ -14630,10 +12665,6 @@ UserSecurity
color
-white
-
-
-color
green
@@ -14730,17 +12761,15 @@ UserSecurity
-CardsVote
-
+BoardsMembers
+
{
- "question": "string",
- "positive": [
- "string"
- ],
- "negative": [
- "string"
- ],
- "end": "string"
+ "userId": "string",
+ "isAdmin": true,
+ "isActive": true,
+ "isNoComments": true,
+ "isCommentOnly": true,
+ "isWorker": true
}
@@ -14757,42 +12786,118 @@ UserSecurity
-question
+userId
string
true
none
+The uniq ID of the member
+
+
+isAdmin
+boolean
+true
none
+Is the member an admin of the board?
-positive
-[string]
-false
+isActive
+boolean
+true
none
-list of members (user IDs)
+Is the member active?
-negative
-[string]
+isNoComments
+boolean
false
none
-list of members (user IDs)
+Is the member not allowed to make comments
-end
-string
+isCommentOnly
+boolean
false
none
+Is the member only allowed to comment on the board
+
+
+isWorker
+boolean
+false
none
+Is the member only allowed to move card, assign himself to card and comment
-CardsCustomfields
-
-{}
+CardComments
+
+{
+ "boardId": "string",
+ "cardId": "string",
+ "text": "string",
+ "createdAt": "string",
+ "modifiedAt": "string",
+ "userId": "string"
+}
+A comment on a card
Properties
-None
+
+
+
+Name
+Type
+Required
+Restrictions
+Description
+
+
+
+
+boardId
+string
+true
+none
+the board ID
+
+
+cardId
+string
+true
+none
+the card ID
+
+
+text
+string
+true
+none
+the text of the comment
+
+
+createdAt
+string
+true
+none
+when was the comment created
+
+
+modifiedAt
+string
+true
+none
+none
+
+
+userId
+string
+true
+none
+the author ID of the comment
+
+
+
ChecklistItems
{
diff --git a/public/api/wekan.yml b/public/api/wekan.yml
index 074619406..2b25fd972 100644
--- a/public/api/wekan.yml
+++ b/public/api/wekan.yml
@@ -1,7 +1,7 @@
swagger: '2.0'
info:
title: Wekan REST API
- version: v3.93
+ version: v3.94
description: |
The REST API allows you to control and extend Wekan with ease.
@@ -1221,296 +1221,6 @@ paths:
properties:
_id:
type: string
- /api/boards/{board}/lists/{list}/cards:
- get:
- operationId: get_all_cards
- summary: Get all Cards attached to a List
- tags:
- - Cards
- parameters:
- - name: board
- in: path
- description: |
- the board ID
- type: string
- required: true
- - name: list
- in: path
- description: |
- the list ID
- type: string
- required: true
- produces:
- - application/json
- security:
- - UserSecurity: []
- responses:
- '200':
- description: |-
- 200 response
- schema:
- type: array
- items:
- type: object
- properties:
- _id:
- type: string
- title:
- type: string
- description:
- type: string
- post:
- operationId: new_card
- summary: Create a new Card
- tags:
- - Cards
- consumes:
- - multipart/form-data
- - application/json
- parameters:
- - name: authorId
- in: formData
- description: the authorId value
- type: string
- required: true
- - name: members
- in: formData
- description: |
- the member IDs list of the new card
- type: string
- required: false
- - name: assignees
- in: formData
- description: |
- the array of maximum one ID of assignee of the new card
- type: string
- required: false
- - name: title
- in: formData
- description: |
- the title of the new card
- type: string
- required: true
- - name: description
- in: formData
- description: |
- the description of the new card
- type: string
- required: true
- - name: swimlaneId
- in: formData
- description: |
- the swimlane ID of the new card
- type: string
- required: true
- - name: board
- in: path
- description: |
- the board ID of the new card
- type: string
- required: true
- - name: list
- in: path
- description: |
- the list ID of the new card
- type: string
- required: true
- produces:
- - application/json
- security:
- - UserSecurity: []
- responses:
- '200':
- description: |-
- 200 response
- schema:
- type: object
- properties:
- _id:
- type: string
- /api/boards/{board}/lists/{list}/cards/{card}:
- get:
- operationId: get_board_list_card
- tags:
- - Cards
- parameters:
- - name: board
- in: path
- description: the board value
- type: string
- required: true
- - name: list
- in: path
- description: the list value
- type: string
- required: true
- - name: card
- in: path
- description: the card value
- type: string
- required: true
- produces:
- - application/json
- security:
- - UserSecurity: []
- responses:
- '200':
- description: |-
- 200 response
- put:
- operationId: put_board_list_card
- tags:
- - Cards
- consumes:
- - multipart/form-data
- - application/json
- parameters:
- - name: title
- in: formData
- description: the title value
- type: string
- required: true
- - name: listId
- in: formData
- description: the listId value
- type: string
- required: true
- - name: authorId
- in: formData
- description: the authorId value
- type: string
- required: true
- - name: parentId
- in: formData
- description: the parentId value
- type: string
- required: true
- - name: description
- in: formData
- description: the description value
- type: string
- required: true
- - name: color
- in: formData
- description: the color value
- type: string
- required: true
- - name: labelIds
- in: formData
- description: the labelIds value
- type: string
- required: true
- - name: requestedBy
- in: formData
- description: the requestedBy value
- type: string
- required: true
- - name: assignedBy
- in: formData
- description: the assignedBy value
- type: string
- required: true
- - name: receivedAt
- in: formData
- description: the receivedAt value
- type: string
- required: true
- - name: startAt
- in: formData
- description: the startAt value
- type: string
- required: true
- - name: dueAt
- in: formData
- description: the dueAt value
- type: string
- required: true
- - name: endAt
- in: formData
- description: the endAt value
- type: string
- required: true
- - name: spentTime
- in: formData
- description: the spentTime value
- type: string
- required: true
- - name: isOverTime
- in: formData
- description: the isOverTime value
- type: string
- required: true
- - name: customFields
- in: formData
- description: the customFields value
- type: string
- required: true
- - name: members
- in: formData
- description: the members value
- type: string
- required: true
- - name: assignees
- in: formData
- description: the assignees value
- type: string
- required: true
- - name: swimlaneId
- in: formData
- description: the swimlaneId value
- type: string
- required: true
- - name: board
- in: path
- description: the board value
- type: string
- required: true
- - name: list
- in: path
- description: the list value
- type: string
- required: true
- - name: card
- in: path
- description: the card value
- type: string
- required: true
- produces:
- - application/json
- security:
- - UserSecurity: []
- responses:
- '200':
- description: |-
- 200 response
- delete:
- operationId: delete_board_list_card
- tags:
- - Cards
- parameters:
- - name: board
- in: path
- description: the board value
- type: string
- required: true
- - name: list
- in: path
- description: the list value
- type: string
- required: true
- - name: card
- in: path
- description: the card value
- type: string
- required: true
- produces:
- - application/json
- security:
- - UserSecurity: []
- responses:
- '200':
- description: |-
- 200 response
/api/boards/{board}/members/{member}:
post:
operationId: set_board_member_permission
@@ -1780,30 +1490,6 @@ paths:
'200':
description: |-
200 response
- /api/boards/{board}/swimlanes/{swimlane}/cards:
- get:
- operationId: get_board_swimlane_cards
- tags:
- - Cards
- parameters:
- - name: board
- in: path
- description: the board value
- type: string
- required: true
- - name: swimlane
- in: path
- description: the swimlane value
- type: string
- required: true
- produces:
- - application/json
- security:
- - UserSecurity: []
- responses:
- '200':
- description: |-
- 200 response
/api/user:
get:
operationId: get_current_user
@@ -2349,219 +2035,6 @@ definitions:
- createdAt
- modifiedAt
- userId
- Cards:
- type: object
- properties:
- title:
- description: |
- the title of the card
- type: string
- x-nullable: true
- archived:
- description: |
- is the card archived
- type: boolean
- parentId:
- description: |
- ID of the parent card
- type: string
- x-nullable: true
- listId:
- description: |
- List ID where the card is
- type: string
- x-nullable: true
- swimlaneId:
- description: |
- Swimlane ID where the card is
- type: string
- boardId:
- description: |
- Board ID of the card
- type: string
- x-nullable: true
- coverId:
- description: |
- Cover ID of the card
- type: string
- x-nullable: true
- color:
- type: string
- enum:
- - 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
- x-nullable: true
- createdAt:
- description: |
- creation date
- type: string
- modifiedAt:
- type: string
- customFields:
- description: |
- list of custom fields
- type: array
- items:
- $ref: "#/definitions/CardsCustomfields"
- x-nullable: true
- dateLastActivity:
- description: |
- Date of last activity
- type: string
- description:
- description: |
- description of the card
- type: string
- x-nullable: true
- requestedBy:
- description: |
- who requested the card (ID of the user)
- type: string
- x-nullable: true
- assignedBy:
- description: |
- who assigned the card (ID of the user)
- type: string
- x-nullable: true
- labelIds:
- description: |
- list of labels ID the card has
- type: array
- items:
- type: string
- x-nullable: true
- x-nullable: true
- members:
- description: |
- list of members (user IDs)
- type: array
- items:
- type: string
- x-nullable: true
- x-nullable: true
- assignees:
- description: |
- who is assignee of the card (user ID),
- maximum one ID of assignee in array.
- type: array
- items:
- type: string
- x-nullable: true
- x-nullable: true
- receivedAt:
- description: |
- Date the card was received
- type: string
- x-nullable: true
- startAt:
- description: |
- Date the card was started to be worked on
- type: string
- x-nullable: true
- dueAt:
- description: |
- Date the card is due
- type: string
- x-nullable: true
- endAt:
- description: |
- Date the card ended
- type: string
- x-nullable: true
- spentTime:
- description: |
- How much time has been spent on this
- type: number
- x-nullable: true
- isOvertime:
- description: |
- is the card over time?
- type: boolean
- x-nullable: true
- userId:
- description: |
- user ID of the author of the card
- type: string
- sort:
- description: |
- Sort value
- type: number
- subtaskSort:
- description: |
- subtask sort value
- type: number
- x-nullable: true
- type:
- description: |
- type of the card
- type: string
- linkedId:
- description: |
- ID of the linked card
- type: string
- x-nullable: true
- vote:
- description: |
- vote object, see below
- $ref: "#/definitions/CardsVote"
- x-nullable: true
- required:
- - archived
- - swimlaneId
- - createdAt
- - modifiedAt
- - dateLastActivity
- - userId
- - sort
- - type
- CardsVote:
- type: object
- properties:
- question:
- type: string
- positive:
- description: |
- list of members (user IDs)
- type: array
- items:
- type: string
- x-nullable: true
- negative:
- description: |
- list of members (user IDs)
- type: array
- items:
- type: string
- x-nullable: true
- end:
- type: string
- required:
- - question
- CardsCustomfields:
- type: object
ChecklistItems:
type: object
description: An item in a checklist
diff --git a/sandstorm-pkgdef.capnp b/sandstorm-pkgdef.capnp
index 6b5713021..18124e310 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 = 393,
+ appVersion = 394,
# Increment this for every release.
- appMarketingVersion = (defaultText = "3.93.0~2020-04-10"),
+ appMarketingVersion = (defaultText = "3.94.0~2020-04-12"),
# Human-readable presentation of the app version.
minUpgradableAppVersion = 0,