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
fix(docs): correct JSDoc param syntax to fix build issues
- Updated JSDoc `@param` annotations in `ticketimport.js` to use `tickets[].field` syntax, ensuring compatibility with VitePress.
- Added `.temp` directory to `.gitignore` to prevent unnecessary files from being tracked.
- These changes resolve the issue where the docs build was failing due to improper parsing of the `@param` block.
Copy file name to clipboardExpand all lines: src/clients/core/ticketimport.js
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -58,12 +58,12 @@ class TicketImport extends Client {
58
58
/**
59
59
* Bulk imports multiple tickets into Zendesk.
60
60
* @param {Array<object>} tickets - An array containing ticket data to be imported. Each ticket should include the following fields:
61
-
* - `assignee_id` (number): The ID of the user to assign this ticket to.
62
-
* - `comments` (Array<Object>): Array of comments associated with the ticket.
63
-
* - `description` (string): The description of the ticket.
64
-
* - `requester_id` (number): The ID of the user requesting the ticket.
65
-
* - `subject` (string): The subject of the ticket.
66
-
* - `tags` (Array<string>): Array of tags associated with the ticket.
61
+
* @param {number} tickets[].assignee_id - The ID of the user to assign this ticket to.
62
+
* @param {Array<object>} tickets[].comments - Array of comments associated with the ticket.
63
+
* @param {string} tickets[].description - The description of the ticket.
64
+
* @param {number} tickets[].requester_id - The ID of the user requesting the ticket.
65
+
* @param {string} tickets[].subject - The subject of the ticket.
66
+
* @param {Array<string>} tickets[].tags - Array of tags associated with the ticket.
67
67
* **Note**: While these fields are required for each ticket object, they are not directly accessed within this function. The entire array of tickets is passed to the Zendesk API.
68
68
* @returns {Promise<{response: object, result: object}>} The response from the Zendesk API, including a job status object.
69
69
* @throws {Error} Throws an error if the request to the Zendesk API fails.
0 commit comments