Migrate JiraPS from Jira API v2 to v3#545
Open
rpx99 wants to merge 1 commit intoAtlassianPS:developfrom
Open
Conversation
This commit comprehensively migrates the JiraPS PowerShell module from Jira REST API v2 to v3 to address GitHub issues AtlassianPS#535, AtlassianPS#530, and AtlassianPS#538. Key Changes: 1. API Endpoint Migration: - Updated all endpoints from /rest/api/2/ to /rest/api/3/ - Changed search endpoint from GET /search to POST /search/jql - Migrated 32+ public and private functions 2. Token-Based Pagination: - Implemented nextPageToken pagination for API v3 - Maintained backward compatibility with offset pagination - Fixed division-by-zero errors in pagination logic 3. Atlassian Document Format (ADF) Support: - Created ConvertFrom-AtlassianDocumentFormat for reading ADF text fields - Created ConvertTo-AtlassianDocumentFormat for writing ADF text fields - Updated all converters (Comment, Issue, Filter, Worklog, etc.) to handle ADF - Ensured backward compatibility - users still work with plain text 4. Request Format Changes: - Changed JQL search from GET with query params to POST with JSON body - Added explicit fields parameter to ensure all issue fields are returned - Fixed expand parameter format (must be string, not array) - Added proper comment field loading 5. API v3 Compatibility Fixes: - Removed deprecated Reporter parameter from New-JiraIssue (API v3 auto-assigns to authenticated user) - Updated error handling for new API v3 error responses - Fixed array serialization issues in pagination 6. Documentation: - Translated INSTALLATION.md from German to English - Added comprehensive installation guide with multiple methods All changes maintain backward compatibility for existing user scripts. The module version remains at 2.14.5 to indicate a patch-level API compatibility update. Fixes AtlassianPS#535, AtlassianPS#530, AtlassianPS#538
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit comprehensively migrates the JiraPS PowerShell module from Jira REST API v2 to v3 to address GitHub issues #535, #530, and #538.
Key Changes:
API Endpoint Migration:
Token-Based Pagination:
Atlassian Document Format (ADF) Support:
Request Format Changes:
API v3 Compatibility Fixes:
Documentation:
All changes maintain backward compatibility for existing user scripts. The module version remains at 2.14.5 to indicate a patch-level API compatibility update.
Fixes #535, #530, #538
Description
Motivation and Context
Types of changes
Checklist