Skip to content

Commit

Permalink
fix(docs): correct JSDoc param syntax to fix build issues
Browse files Browse the repository at this point in the history
- 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.
  • Loading branch information
blakmatrix committed Nov 27, 2024
1 parent 8248632 commit 1f794fb
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ jspm_packages/
# vitepress build/dev output
docs/.vitepress/dist
docs/.vitepress/cache
docs/.vitepress/.temp
docs/api/
docs/code/

Expand Down
12 changes: 6 additions & 6 deletions src/clients/core/ticketimport.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@ class TicketImport extends Client {
/**
* Bulk imports multiple tickets into Zendesk.
* @param {Array<object>} tickets - An array containing ticket data to be imported. Each ticket should include the following fields:
* - `assignee_id` (number): The ID of the user to assign this ticket to.
* - `comments` (Array<Object>): Array of comments associated with the ticket.
* - `description` (string): The description of the ticket.
* - `requester_id` (number): The ID of the user requesting the ticket.
* - `subject` (string): The subject of the ticket.
* - `tags` (Array<string>): Array of tags associated with the ticket.
* @param {number} tickets[].assignee_id - The ID of the user to assign this ticket to.
* @param {Array<object>} tickets[].comments - Array of comments associated with the ticket.
* @param {string} tickets[].description - The description of the ticket.
* @param {number} tickets[].requester_id - The ID of the user requesting the ticket.
* @param {string} tickets[].subject - The subject of the ticket.
* @param {Array<string>} tickets[].tags - Array of tags associated with the ticket.
* **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.
* @returns {Promise<{response: object, result: object}>} The response from the Zendesk API, including a job status object.
* @throws {Error} Throws an error if the request to the Zendesk API fails.
Expand Down

0 comments on commit 1f794fb

Please sign in to comment.