@resolution/jira-api-client 0.5.2 → 0.5.4

package/lib/openapi/software/services/BoardService.js

@@ -5,8 +5,8 @@ exports.BoardService = void 0;
 // This file is generated by "api-typescript-generator".
 // To update this file run "yarn build:openapi".
 const zod_1 = require("zod");
-const commonHttpClient = require("../core/CommonHttpClient");
-const CommonHttpService_1 = require("../core/CommonHttpService");
+const commonHttpClient = require("../../core/CommonHttpClient");
+const CommonHttpService_1 = require("../../core/CommonHttpService");
 const board_1 = require("../models/board");
 const common_1 = require("../models/common");
 const validationSchemaStorage_1 = require("../validationSchemaStorage");
@@ -50,14 +50,18 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the created board.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "id": 84,
          *   "name": "scrum board",
          *   "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
          *   "type": "scrum"
          * }
-         * @path {POST} /rest/agile/1.0/board
+         * ```
+         * @path POST `/rest/agile/1.0/board`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-post
+         * @param params
          */
         this.createBoard = ({ boardCreateBean, }) => {
             return this.getClientInstance()
@@ -81,8 +85,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
         /**
          * Deletes the board. Admin without the view permission can still remove the board.
          *
-         * @path {DELETE} /rest/agile/1.0/board/{boardId}
+         * @path DELETE `/rest/agile/1.0/board/{boardId}`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-delete
+         * @param params
          */
         this.deleteBoard = ({ boardId, }) => {
             return this.getClientInstance()
@@ -99,8 +104,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          * Removes the property from the board identified by the id. Ths user removing the
          * property is required to have permissions to modify the board.
          *
-         * @path {DELETE} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
+         * @path DELETE `/rest/agile/1.0/board/{boardId}/properties/{propertyKey}`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-delete
+         * @param params
          */
         this.deleteBoardProperty = ({ boardId, propertyKey, }) => {
             return this.getClientInstance()
@@ -125,7 +131,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the requested boards, at the specified page of the results.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": false,
          *   "maxResults": 2,
          *   "startAt": 1,
@@ -145,8 +153,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {GET} /rest/agile/1.0/board
+         * ```
+         * @path GET `/rest/agile/1.0/board`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-get
+         * @param params
          */
         this.getAllBoards = ({ startAt, maxResults, type, name, projectKeyOrId, accountIdLocation, projectLocation, includePrivate, negateLocationFiltering, orderBy, expand, projectTypeLocation, filterId, } = {}) => {
             return this.getClientInstance()
@@ -181,10 +191,11 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
         /**
          * Returns all quick filters from a board, for a given board ID.
          *
-         * @returns Returns the requested quick filters, at the specified page of the results.
-         * Quick filters will be ordered first by position.
+         * @returns Returns the requested quick filters, at the specified page of the results. Quick filters will be ordered first by position.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": false,
          *   "maxResults": 2,
          *   "startAt": 1,
@@ -208,8 +219,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {GET} /rest/agile/1.0/board/{boardId}/quickfilter
+         * ```
+         * @path GET `/rest/agile/1.0/board/{boardId}/quickfilter`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-quickfilter-get
+         * @param params
          */
         this.getAllQuickFilters = ({ boardId, startAt, maxResults, }) => {
             return this.getClientInstance()
@@ -237,11 +250,11 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          * Returns all sprints from a board, for a given board ID. This only includes
          * sprints that the user has permission to view.
          *
-         * @returns Returns the requested sprints, at the specified page of the results. Sprints
-         * will be ordered first by state (i.e. closed, active, future) then by their
-         * position in the backlog.
+         * @returns Returns the requested sprints, at the specified page of the results. Sprints will be ordered first by state (i.e. closed, active, future) then by their position in the backlog.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": false,
          *   "maxResults": 2,
          *   "startAt": 1,
@@ -267,8 +280,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {GET} /rest/agile/1.0/board/{boardId}/sprint
+         * ```
+         * @path GET `/rest/agile/1.0/board/{boardId}/sprint`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-sprint-get
+         * @param params
          */
         this.getAllSprints = ({ boardId, startAt, maxResults, state, }) => {
             return this.getClientInstance()
@@ -302,7 +317,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the requested versions, at the specified page of the results.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": false,
          *   "maxResults": 2,
          *   "startAt": 1,
@@ -329,8 +346,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {GET} /rest/agile/1.0/board/{boardId}/version
+         * ```
+         * @path GET `/rest/agile/1.0/board/{boardId}/version`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-version-get
+         * @param params
          */
         this.getAllVersions = ({ boardId, startAt, maxResults, released, }) => {
             return this.getClientInstance()
@@ -363,7 +382,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the requested board.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "id": 84,
          *   "location": {
          *     "displayName": "Example Project",
@@ -379,8 +400,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *   "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
          *   "type": "scrum"
          * }
-         * @path {GET} /rest/agile/1.0/board/{boardId}
+         * ```
+         * @path GET `/rest/agile/1.0/board/{boardId}`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-get
+         * @param params
          */
         this.getBoard = ({ boardId, }) => {
             return this.getClientInstance()
@@ -407,13 +430,17 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the requested boards, at the specified page of the results.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "id": 84,
          *   "name": "scrum board",
          *   "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84"
          * }
-         * @path {GET} /rest/agile/1.0/board/filter/{filterId}
+         * ```
+         * @path GET `/rest/agile/1.0/board/filter/{filterId}`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-filter-filterid-get
+         * @param params
          */
         this.getBoardByFilterId = ({ filterId, startAt, maxResults, }) => {
             return this.getClientInstance()
@@ -446,7 +473,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the requested issues, at the specified page of the results.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "expand": "names,schema",
          *   "issues": [
          *     {
@@ -463,8 +492,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *         "closedSprints": [
          *           {
          *             "id": 37,
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
+         *             "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
          *             "state": "closed",
          *             "name": "sprint 1",
          *             "startDate": "2015-04-11T15:22:00.000+10:00",
@@ -476,14 +504,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *         "description": "example bug report",
          *         "project": {
          *           "avatarUrls": {
-         *             "16x16":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
-         *             "24x24":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
-         *             "32x32":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
-         *             "48x48":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+         *             "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+         *             "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+         *             "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+         *             "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          *           },
          *           "id": "10000",
          *           "insight": {
@@ -496,8 +520,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             "description": "First Project Category",
          *             "id": "10000",
          *             "name": "FIRST",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          *           },
          *           "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          *           "simplified": false,
@@ -509,8 +532,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "body": {
          *               "type": "doc",
@@ -521,10 +543,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *                   "content": [
          *                     {
          *                       "type": "text",
-         *                       "text": "Lorem ipsum dolor sit amet, consectetur
-         * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
-         * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
-         * semper."
+         *                       "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
          *                     }
          *                   ]
          *                 }
@@ -532,14 +551,12 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             },
          *             "created": "2021-01-17T12:34:00.000+0000",
          *             "id": "10000",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
          *             "updateAuthor": {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "updated": "2021-01-18T23:45:00.000+0000",
          *             "visibility": {
@@ -565,8 +582,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "comment": {
          *               "type": "doc",
@@ -585,8 +601,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             },
          *             "id": "100028",
          *             "issueId": "10002",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
          *             "started": "2021-01-17T12:34:00.000+0000",
          *             "timeSpent": "3h 20m",
          *             "timeSpentSeconds": 12000,
@@ -594,8 +609,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "updated": "2021-01-18T23:45:00.000+0000",
          *             "visibility": {
@@ -617,16 +631,17 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *       },
          *       "id": "10001",
          *       "key": "HSP-1",
-         *       "self":
-         * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
+         *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
          *     }
          *   ],
          *   "maxResults": 50,
          *   "startAt": 0,
          *   "total": 1
          * }
-         * @path {GET} /rest/agile/1.0/board/{boardId}/epic/{epicId}/issue
+         * ```
+         * @path GET `/rest/agile/1.0/board/{boardId}/epic/{epicId}/issue`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-epicid-issue-get
+         * @param params
          */
         this.getBoardIssuesForEpic = ({ boardId, epicId, startAt, maxResults, jql, validateQuery, fields, expand, }) => {
             return this.getClientInstance()
@@ -663,7 +678,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the requested issues, at the specified page of the results.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "expand": "names,schema",
          *   "issues": [
          *     {
@@ -680,8 +697,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *         "closedSprints": [
          *           {
          *             "id": 37,
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
+         *             "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
          *             "state": "closed",
          *             "name": "sprint 1",
          *             "startDate": "2015-04-11T15:22:00.000+10:00",
@@ -693,14 +709,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *         "description": "example bug report",
          *         "project": {
          *           "avatarUrls": {
-         *             "16x16":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
-         *             "24x24":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
-         *             "32x32":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
-         *             "48x48":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+         *             "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+         *             "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+         *             "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+         *             "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          *           },
          *           "id": "10000",
          *           "insight": {
@@ -713,8 +725,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             "description": "First Project Category",
          *             "id": "10000",
          *             "name": "FIRST",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          *           },
          *           "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          *           "simplified": false,
@@ -726,8 +737,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "body": {
          *               "type": "doc",
@@ -738,10 +748,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *                   "content": [
          *                     {
          *                       "type": "text",
-         *                       "text": "Lorem ipsum dolor sit amet, consectetur
-         * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
-         * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
-         * semper."
+         *                       "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
          *                     }
          *                   ]
          *                 }
@@ -749,14 +756,12 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             },
          *             "created": "2021-01-17T12:34:00.000+0000",
          *             "id": "10000",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
          *             "updateAuthor": {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "updated": "2021-01-18T23:45:00.000+0000",
          *             "visibility": {
@@ -782,8 +787,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "comment": {
          *               "type": "doc",
@@ -802,8 +806,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             },
          *             "id": "100028",
          *             "issueId": "10002",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
          *             "started": "2021-01-17T12:34:00.000+0000",
          *             "timeSpent": "3h 20m",
          *             "timeSpentSeconds": 12000,
@@ -811,8 +814,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "updated": "2021-01-18T23:45:00.000+0000",
          *             "visibility": {
@@ -834,16 +836,17 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *       },
          *       "id": "10001",
          *       "key": "HSP-1",
-         *       "self":
-         * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
+         *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
          *     }
          *   ],
          *   "maxResults": 50,
          *   "startAt": 0,
          *   "total": 1
          * }
-         * @path {GET} /rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue
+         * ```
+         * @path GET `/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-sprint-sprintid-issue-get
+         * @param params
          */
         this.getBoardIssuesForSprint = ({ boardId, sprintId, startAt, maxResults, jql, validateQuery, fields, expand, }) => {
             return this.getClientInstance()
@@ -878,8 +881,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          * permissions to view the board.
          *
          * @returns Returned if the board exists and the property was found.
-         * @path {GET} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
+         * @path GET `/rest/agile/1.0/board/{boardId}/properties/{propertyKey}`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-get
+         * @param params
          */
         this.getBoardProperty = ({ boardId, propertyKey, }) => {
             return this.getClientInstance()
@@ -906,8 +910,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          * board.
          *
          * @returns Returned if the board with given id exists.
-         * @path {GET} /rest/agile/1.0/board/{boardId}/properties
+         * @path GET `/rest/agile/1.0/board/{boardId}/properties`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-get
+         * @param params
          */
         this.getBoardPropertyKeys = ({ boardId, }) => {
             return this.getClientInstance()
@@ -954,7 +959,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the configuration of the board for given boardId.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "columnConfig": {
          *     "columns": [
          *       {
@@ -1018,8 +1025,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *   },
          *   "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84/config"
          * }
-         * @path {GET} /rest/agile/1.0/board/{boardId}/configuration
+         * ```
+         * @path GET `/rest/agile/1.0/board/{boardId}/configuration`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-configuration-get
+         * @param params
          */
         this.getConfiguration = ({ boardId, }) => {
             return this.getClientInstance()
@@ -1046,7 +1055,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the requested epics, at the specified page of the results.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": false,
          *   "maxResults": 2,
          *   "startAt": 1,
@@ -1074,8 +1085,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {GET} /rest/agile/1.0/board/{boardId}/epic
+         * ```
+         * @path GET `/rest/agile/1.0/board/{boardId}/epic`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-get
+         * @param params
          */
         this.getEpics = ({ boardId, startAt, maxResults, done, }) => {
             return this.getClientInstance()
@@ -1102,8 +1115,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
         };
         /**
          * @returns 200 response
-         * @path {GET} /rest/agile/1.0/board/{boardId}/features
+         * @path GET `/rest/agile/1.0/board/{boardId}/features`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-features-get
+         * @param params
          */
         this.getFeaturesForBoard = ({ boardId, }) => {
             return this.getClientInstance()
@@ -1134,7 +1148,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the requested issues, at the specified page of the results.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "expand": "names,schema",
          *   "issues": [
          *     {
@@ -1151,8 +1167,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *         "closedSprints": [
          *           {
          *             "id": 37,
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
+         *             "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
          *             "state": "closed",
          *             "name": "sprint 1",
          *             "startDate": "2015-04-11T15:22:00.000+10:00",
@@ -1164,14 +1179,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *         "description": "example bug report",
          *         "project": {
          *           "avatarUrls": {
-         *             "16x16":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
-         *             "24x24":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
-         *             "32x32":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
-         *             "48x48":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+         *             "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+         *             "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+         *             "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+         *             "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          *           },
          *           "id": "10000",
          *           "insight": {
@@ -1184,8 +1195,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             "description": "First Project Category",
          *             "id": "10000",
          *             "name": "FIRST",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          *           },
          *           "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          *           "simplified": false,
@@ -1197,8 +1207,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "body": {
          *               "type": "doc",
@@ -1209,10 +1218,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *                   "content": [
          *                     {
          *                       "type": "text",
-         *                       "text": "Lorem ipsum dolor sit amet, consectetur
-         * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
-         * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
-         * semper."
+         *                       "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
          *                     }
          *                   ]
          *                 }
@@ -1220,14 +1226,12 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             },
          *             "created": "2021-01-17T12:34:00.000+0000",
          *             "id": "10000",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
          *             "updateAuthor": {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "updated": "2021-01-18T23:45:00.000+0000",
          *             "visibility": {
@@ -1253,8 +1257,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "comment": {
          *               "type": "doc",
@@ -1273,8 +1276,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             },
          *             "id": "100028",
          *             "issueId": "10002",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
          *             "started": "2021-01-17T12:34:00.000+0000",
          *             "timeSpent": "3h 20m",
          *             "timeSpentSeconds": 12000,
@@ -1282,8 +1284,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "updated": "2021-01-18T23:45:00.000+0000",
          *             "visibility": {
@@ -1305,16 +1306,17 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *       },
          *       "id": "10001",
          *       "key": "HSP-1",
-         *       "self":
-         * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
+         *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
          *     }
          *   ],
          *   "maxResults": 50,
          *   "startAt": 0,
          *   "total": 1
          * }
-         * @path {GET} /rest/agile/1.0/board/{boardId}/backlog
+         * ```
+         * @path GET `/rest/agile/1.0/board/{boardId}/backlog`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-backlog-get
+         * @param params
          */
         this.getIssuesForBacklog = ({ boardId, startAt, maxResults, jql, validateQuery, fields, expand, }) => {
             return this.getClientInstance()
@@ -1353,7 +1355,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the requested issues, at the specified page of the results.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "expand": "names,schema",
          *   "issues": [
          *     {
@@ -1370,8 +1374,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *         "closedSprints": [
          *           {
          *             "id": 37,
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
+         *             "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
          *             "state": "closed",
          *             "name": "sprint 1",
          *             "startDate": "2015-04-11T15:22:00.000+10:00",
@@ -1383,14 +1386,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *         "description": "example bug report",
          *         "project": {
          *           "avatarUrls": {
-         *             "16x16":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
-         *             "24x24":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
-         *             "32x32":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
-         *             "48x48":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+         *             "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+         *             "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+         *             "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+         *             "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          *           },
          *           "id": "10000",
          *           "insight": {
@@ -1403,8 +1402,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             "description": "First Project Category",
          *             "id": "10000",
          *             "name": "FIRST",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          *           },
          *           "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          *           "simplified": false,
@@ -1416,8 +1414,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "body": {
          *               "type": "doc",
@@ -1428,10 +1425,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *                   "content": [
          *                     {
          *                       "type": "text",
-         *                       "text": "Lorem ipsum dolor sit amet, consectetur
-         * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
-         * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
-         * semper."
+         *                       "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
          *                     }
          *                   ]
          *                 }
@@ -1439,14 +1433,12 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             },
          *             "created": "2021-01-17T12:34:00.000+0000",
          *             "id": "10000",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
          *             "updateAuthor": {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "updated": "2021-01-18T23:45:00.000+0000",
          *             "visibility": {
@@ -1472,8 +1464,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "comment": {
          *               "type": "doc",
@@ -1492,8 +1483,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             },
          *             "id": "100028",
          *             "issueId": "10002",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
          *             "started": "2021-01-17T12:34:00.000+0000",
          *             "timeSpent": "3h 20m",
          *             "timeSpentSeconds": 12000,
@@ -1501,8 +1491,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "updated": "2021-01-18T23:45:00.000+0000",
          *             "visibility": {
@@ -1524,16 +1513,17 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *       },
          *       "id": "10001",
          *       "key": "HSP-1",
-         *       "self":
-         * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
+         *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
          *     }
          *   ],
          *   "maxResults": 50,
          *   "startAt": 0,
          *   "total": 1
          * }
-         * @path {GET} /rest/agile/1.0/board/{boardId}/issue
+         * ```
+         * @path GET `/rest/agile/1.0/board/{boardId}/issue`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-issue-get
+         * @param params
          */
         this.getIssuesForBoard = ({ boardId, startAt, maxResults, jql, validateQuery, fields, expand, }) => {
             return this.getClientInstance()
@@ -1569,7 +1559,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the requested issues, at the specified page of the results.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "expand": "names,schema",
          *   "issues": [
          *     {
@@ -1586,8 +1578,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *         "closedSprints": [
          *           {
          *             "id": 37,
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
+         *             "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
          *             "state": "closed",
          *             "name": "sprint 1",
          *             "startDate": "2015-04-11T15:22:00.000+10:00",
@@ -1599,14 +1590,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *         "description": "example bug report",
          *         "project": {
          *           "avatarUrls": {
-         *             "16x16":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
-         *             "24x24":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
-         *             "32x32":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
-         *             "48x48":
-         * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+         *             "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+         *             "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+         *             "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+         *             "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          *           },
          *           "id": "10000",
          *           "insight": {
@@ -1619,8 +1606,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             "description": "First Project Category",
          *             "id": "10000",
          *             "name": "FIRST",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          *           },
          *           "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          *           "simplified": false,
@@ -1632,8 +1618,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "body": {
          *               "type": "doc",
@@ -1644,10 +1629,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *                   "content": [
          *                     {
          *                       "type": "text",
-         *                       "text": "Lorem ipsum dolor sit amet, consectetur
-         * adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue
-         * iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue
-         * semper."
+         *                       "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
          *                     }
          *                   ]
          *                 }
@@ -1655,14 +1637,12 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             },
          *             "created": "2021-01-17T12:34:00.000+0000",
          *             "id": "10000",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
          *             "updateAuthor": {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "updated": "2021-01-18T23:45:00.000+0000",
          *             "visibility": {
@@ -1688,8 +1668,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "comment": {
          *               "type": "doc",
@@ -1708,8 +1687,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *             },
          *             "id": "100028",
          *             "issueId": "10002",
-         *             "self":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+         *             "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
          *             "started": "2021-01-17T12:34:00.000+0000",
          *             "timeSpent": "3h 20m",
          *             "timeSpentSeconds": 12000,
@@ -1717,8 +1695,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *               "accountId": "5b10a2844c20165700ede21g",
          *               "active": false,
          *               "displayName": "Mia Krystof",
-         *               "self":
-         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+         *               "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
          *             },
          *             "updated": "2021-01-18T23:45:00.000+0000",
          *             "visibility": {
@@ -1740,16 +1717,17 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *       },
          *       "id": "10001",
          *       "key": "HSP-1",
-         *       "self":
-         * "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
+         *       "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
          *     }
          *   ],
          *   "maxResults": 50,
          *   "startAt": 0,
          *   "total": 1
          * }
-         * @path {GET} /rest/agile/1.0/board/{boardId}/epic/none/issue
+         * ```
+         * @path GET `/rest/agile/1.0/board/{boardId}/epic/none/issue`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-none-issue-get
+         * @param params
          */
         this.getIssuesWithoutEpicForBoard = ({ boardId, startAt, maxResults, jql, validateQuery, fields, expand, }) => {
             return this.getClientInstance()
@@ -1796,7 +1774,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the board's projects, at the specified page of the results.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": true,
          *   "maxResults": 10,
          *   "startAt": 0,
@@ -1823,8 +1803,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {GET} /rest/agile/1.0/board/{boardId}/project
+         * ```
+         * @path GET `/rest/agile/1.0/board/{boardId}/project`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-project-get
+         * @param params
          */
         this.getProjects = ({ boardId, startAt, maxResults, }) => {
             return this.getClientInstance()
@@ -1861,8 +1843,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          * to ABC and BCD projects but query `project in (ABC, BCD) OR reporter = admin`
          * doesn't have reference to any project.
          *
-         * @path {GET} /rest/agile/1.0/board/{boardId}/project/full
+         * @path GET `/rest/agile/1.0/board/{boardId}/project/full`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-project-full-get
+         * @param params
          */
         this.getProjectsFull = ({ boardId, }) => {
             return this.getClientInstance()
@@ -1882,7 +1865,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the requested quick filter.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "boardId": 1,
          *   "description": "Issues of type bug",
          *   "id": 1,
@@ -1890,8 +1875,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *   "name": "Bugs",
          *   "position": 0
          * }
-         * @path {GET} /rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}
+         * ```
+         * @path GET `/rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-quickfilter-quickfilterid-get
+         * @param params
          */
         this.getQuickFilter = ({ boardId, quickFilterId, }) => {
             return this.getClientInstance()
@@ -1914,8 +1901,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
         };
         /**
          * @returns 200 response
-         * @path {GET} /rest/agile/1.0/board/{boardId}/reports
+         * @path GET `/rest/agile/1.0/board/{boardId}/reports`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-reports-get
+         * @param params
          */
         this.getReportsForBoard = ({ boardId, }) => {
             return this.getClientInstance()
@@ -1945,7 +1933,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returns the list of issue with status of rank operation.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "entries": [
          *     {
          *       "issueId": 10000,
@@ -1959,8 +1949,7 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *     },
          *     {
          *       "errors": [
-         *         "JIRA Agile cannot execute the rank operation at this time. Please try
-         * again later."
+         *         "JIRA Agile cannot execute the rank operation at this time. Please try again later."
          *       ],
          *       "issueId": 10002,
          *       "issueKey": "PR-3",
@@ -1968,8 +1957,10 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {POST} /rest/agile/1.0/board/{boardId}/issue
+         * ```
+         * @path POST `/rest/agile/1.0/board/{boardId}/issue`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-issue-post
+         * @param params
          */
         this.moveIssuesToBoard = ({ boardId, issueRankRequestBean, }) => {
             return this.getClientInstance()
@@ -2001,15 +1992,17 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
          * by the id. The user who stores the data is required to have permissions to
          * modify the board.
          *
-         * @returns * status: 200, mediaType: application/json
+         * @returns
+         *  * status: 200, mediaType: application/json
          *
          *    Returned if the board property is successfully updated.
          *
          *  * status: 201, mediaType: application/json
          *
          *    Returned if the board property is successfully created.
-         * @path {PUT} /rest/agile/1.0/board/{boardId}/properties/{propertyKey}
+         * @path PUT `/rest/agile/1.0/board/{boardId}/properties/{propertyKey}`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-put
+         * @param params
          */
         this.setBoardProperty = ({ boardId, propertyKey, requestBody, }) => {
             return this.getClientInstance()
@@ -2039,8 +2032,9 @@ class BoardService extends CommonHttpService_1.CommonHttpService {
         };
         /**
          * @returns 200 response
-         * @path {PUT} /rest/agile/1.0/board/{boardId}/features
+         * @path PUT `/rest/agile/1.0/board/{boardId}/features`
          * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-features-put
+         * @param params
          */
         this.toggleFeatures = ({ boardId, featureToggleRequestBean, }) => {
             return this.getClientInstance()