You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* export sorts
* deprecation code fixed
* tests compiling updated
* Version 2 API updates
* Version 3 API updates
* Service Desk API updates
* README updated
Copy file name to clipboardExpand all lines: src/agile/board.ts
+18-14Lines changed: 18 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -43,9 +43,10 @@ export class Board {
43
43
44
44
/**
45
45
* Creates a new board. Board name, type and filter ID is required. <ul> <li><code>name</code> - Must be less than 255
46
-
* characters.</li> <li><code>type</code> - Valid values: scrum, kanban</li> <li><code>filterId</code> - ID of a filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects'
47
-
* permission and tries to create a shared board, a private board will be created instead (remember that board sharing depends on the filter sharing).</li>
48
-
* <li><code>location</code> - The container that the board will be located in. <code>location</code> must include the <code>type</code> property (Valid values: project, user).
46
+
* characters.</li> <li><code>type</code> - Valid values: scrum, kanban</li> <li><code>filterId</code> - ID of a
47
+
* filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects'
48
+
* permission and tries to create a shared board, a private board will be created instead (remember that board sharing
49
+
* depends on the filter sharing).</li> <li><code>location</code> - The container that the board will be located in. <code>location</code> must include the <code>type</code> property (Valid values: project, user).
49
50
* If choosing 'project', then a project must be specified by a <code>projectKeyOrId</code> property in <code>location</code>.
50
51
* If choosing 'user', the current user is chosen by default. The <code>projectKeyOrId</code> property should not be provided.
* Creates a new board. Board name, type and filter ID is required. <ul> <li><code>name</code> - Must be less than 255
74
-
* characters.</li> <li><code>type</code> - Valid values: scrum, kanban</li> <li><code>filterId</code> - ID of a filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects'
75
-
* permission and tries to create a shared board, a private board will be created instead (remember that board sharing depends on the filter sharing).</li>
76
-
* <li><code>location</code> - The container that the board will be located in. <code>location</code> must include the <code>type</code> property (Valid values: project, user).
75
+
* characters.</li> <li><code>type</code> - Valid values: scrum, kanban</li> <li><code>filterId</code> - ID of a
76
+
* filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects'
77
+
* permission and tries to create a shared board, a private board will be created instead (remember that board sharing
78
+
* depends on the filter sharing).</li> <li><code>location</code> - The container that the board will be located in. <code>location</code> must include the <code>type</code> property (Valid values: project, user).
77
79
* If choosing 'project', then a project must be specified by a <code>projectKeyOrId</code> property in <code>location</code>.
78
80
* If choosing 'user', the current user is chosen by default. The <code>projectKeyOrId</code> property should not be provided.
79
81
* </li>
@@ -225,8 +227,8 @@ export class Board {
225
227
226
228
/**
227
229
* Get the board configuration. The response contains the following fields: <ul> <li><code>id</code> - ID of the
228
-
* board.</li> <li><code>name</code> - Name of the board.</li> <li><code>filter</code> - Reference to the filter used by the given board.</li>
229
-
* <li><code>location</code> - Reference to the container that the board is located in.
230
+
* board.</li> <li><code>name</code> - Name of the board.</li> <li><code>filter</code> - Reference to the filter used
231
+
* by the given board.</li> <li><code>location</code> - Reference to the container that the board is located in.
230
232
* Includes the container type (Valid values: project, user).
231
233
* </li>
232
234
* <li><code>subQuery</code> (Kanban only) - JQL subquery used by the given board.</li>
@@ -249,8 +251,8 @@ export class Board {
249
251
): Promise<void>;
250
252
/**
251
253
* Get the board configuration. The response contains the following fields: <ul> <li><code>id</code> - ID of the
252
-
* board.</li> <li><code>name</code> - Name of the board.</li> <li><code>filter</code> - Reference to the filter used by the given board.</li>
253
-
* <li><code>location</code> - Reference to the container that the board is located in.
254
+
* board.</li> <li><code>name</code> - Name of the board.</li> <li><code>filter</code> - Reference to the filter used
255
+
* by the given board.</li> <li><code>location</code> - Reference to the container that the board is located in.
254
256
* Includes the container type (Valid values: project, user).
255
257
* </li>
256
258
* <li><code>subQuery</code> (Kanban only) - JQL subquery used by the given board.</li>
@@ -541,8 +543,9 @@ export class Board {
541
543
542
544
/**
543
545
* Returns all projects that are statically associated with the board, for the given board ID. Returned projects are
544
-
* ordered by the name. </p> A project is associated with a board if the board filter contains reference the project.</p> The board filter contains reference the project only if JQL query guarantees that returned issues will be
545
-
* returned from the project set defined in JQL. For instance the query <code>project in (ABC, BCD) AND reporter =
546
+
* ordered by the name. </p> A project is associated with a board if the board filter contains reference the
547
+
* project.</p> The board filter contains reference the project only if JQL query guarantees that returned issues will
548
+
* be returned from the project set defined in JQL. For instance the query <code>project in (ABC, BCD) AND reporter =
546
549
* admin</code> have reference to ABC and BCD projects but query <code>project in (ABC, BCD) OR reporter =
547
550
* admin</code> doesn't have reference to any project. </p>
548
551
*/
@@ -552,8 +555,9 @@ export class Board {
552
555
): Promise<void>;
553
556
/**
554
557
* Returns all projects that are statically associated with the board, for the given board ID. Returned projects are
555
-
* ordered by the name. </p> A project is associated with a board if the board filter contains reference the project.</p> The board filter contains reference the project only if JQL query guarantees that returned issues will be
556
-
* returned from the project set defined in JQL. For instance the query <code>project in (ABC, BCD) AND reporter =
558
+
* ordered by the name. </p> A project is associated with a board if the board filter contains reference the
559
+
* project.</p> The board filter contains reference the project only if JQL query guarantees that returned issues will
560
+
* be returned from the project set defined in JQL. For instance the query <code>project in (ABC, BCD) AND reporter =
557
561
* admin</code> have reference to ABC and BCD projects but query <code>project in (ABC, BCD) OR reporter =
558
562
* admin</code> doesn't have reference to any project. </p>
0 commit comments