Skip to content

fix: Update deprecated endpoint#892

Merged
ankitpokhrel merged 5 commits intomainfrom
issue-891
Aug 25, 2025
Merged

fix: Update deprecated endpoint#892
ankitpokhrel merged 5 commits intomainfrom
issue-891

Conversation

@ankitpokhrel
Copy link
Owner

Fixes #891

This PR is a work in progress

Important

  • The new API does not return the total number of entries anymore, so the total issue count is no longer displayed in the search results.
  • Consequently, the startAt parameter in the new API is unsupported. Therefore, the from part of the --paginate=<from>:<limit> flag is effectively ignored. Users can still paginate using the maxResults parameter (e.g., --paginate=10).

@ankitpokhrel ankitpokhrel marked this pull request as ready for review August 23, 2025 09:41
@ankitpokhrel ankitpokhrel requested a review from Copilot August 23, 2025 09:46

This comment was marked as outdated.

ankitpokhrel and others added 2 commits August 23, 2025 11:47
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit fixes the style issues introduced in 5a797cf according to the output
from Go fmt.

Details: #892
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the Jira API integration from the deprecated v3 /search endpoint to the new /search/jql endpoint. The main change involves removing pagination support and total count tracking since the new API doesn't provide these features.

  • Migrates from deprecated API v3 /search to /search/jql endpoint
  • Removes total count display and pagination offset support across the codebase
  • Updates data structures to use isLast and nextPageToken for pagination instead of startAt, maxResults, and total

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
pkg/jira/search.go Updates API endpoint path and removes startAt parameter from Search method
pkg/jira/testdata/search.json Updates test data to match new API response format
pkg/jira/search_test.go Updates test expectations for new endpoint and response structure
pkg/jira/sprint_test.go Removes total count assertions from sprint test
pkg/jira/epic_test.go Removes total count assertions from epic test
internal/view/issues.go Removes Total field and updates footer text format
internal/view/epic.go Removes Total field and updates footer text, changes interface{} to any
internal/view/issues_test.go Removes Total field from test data
internal/view/epic_test.go Removes Total field from test data
internal/cmd/issue/list/list.go Removes total count handling and updates function signatures
internal/cmd/epic/list/list.go Removes total count handling and updates Search method calls
internal/cmd/sprint/list/list.go Removes total count handling and updates footer text generation
api/client.go Updates ProxySearch to remove startAt parameter for v3 API calls

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@ankitpokhrel ankitpokhrel merged commit d796db2 into main Aug 25, 2025
3 of 4 checks passed
@ankitpokhrel ankitpokhrel deleted the issue-891 branch August 25, 2025 17:53
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Sep 2, 2025
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [ankitpokhrel/jira-cli](https://github.com/ankitpokhrel/jira-cli) | minor | `v1.6.0` -> `v1.7.0` |

MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot).

**Proposed changes to behavior should be submitted there as MRs.**

---

### Release Notes

<details>
<summary>ankitpokhrel/jira-cli (ankitpokhrel/jira-cli)</summary>

### [`v1.7.0`](https://github.com/ankitpokhrel/jira-cli/releases/tag/v1.7.0)

[Compare Source](ankitpokhrel/jira-cli@v1.6.0...v1.7.0)

This release adds CSV and JSON output support for issue listings and upgrades deprecated endpoints to ensure compatibility with the latest Jira APIs.

> \[!IMPORTANT]
>
> - The [new API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-jql-get) does not return the total number of entries anymore, so the total issue count is no longer displayed in the search results.
> - Consequently, the `startAt` parameter in the new API is unsupported. Therefore, the `from` part of the `--paginate=<from>:<limit>` flag is effectively ignored. Users can still paginate using the maxResults parameter (e.g., --paginate=10).

#### 🥷 What's added?

- feat: Add option to list issues in raw JSON by [@&#8203;evg656e](https://github.com/evg656e) in [#&#8203;840](ankitpokhrel/jira-cli#840)
- feat: Add releases Subcommand by [@&#8203;vkhitrin](https://github.com/vkhitrin) in [#&#8203;851](ankitpokhrel/jira-cli#851)
- feat: Support num comments in issue list cmd by [@&#8203;ankitpokhrel](https://github.com/ankitpokhrel) in [#&#8203;853](ankitpokhrel/jira-cli#853)
- feat: Support CSV when listing issues by [@&#8203;ankitpokhrel](https://github.com/ankitpokhrel) in [#&#8203;854](ankitpokhrel/jira-cli#854)
- feat: Allow skipping notification on edit by [@&#8203;ankitpokhrel](https://github.com/ankitpokhrel) in [#&#8203;855](ankitpokhrel/jira-cli#855)
- feat: Add command line arg delimiter for custom delimiter instead of tab. by [@&#8203;iksi4prs](https://github.com/iksi4prs) in [#&#8203;662](ankitpokhrel/jira-cli#662)
- feat: Add support for environment variable to specify config file path by [@&#8203;aazon](https://github.com/aazon) in [#&#8203;858](ankitpokhrel/jira-cli#858)

#### 🐞 What's fixed?

- fix: usernames can be 2 chars by [@&#8203;jontyq](https://github.com/jontyq) in [#&#8203;890](ankitpokhrel/jira-cli#890)
- fix: Update deprecated endpoint by [@&#8203;ankitpokhrel](https://github.com/ankitpokhrel) in [#&#8203;892](ankitpokhrel/jira-cli#892)
- fix: csv format priority by [@&#8203;ciricc](https://github.com/ciricc) in [#&#8203;882](ankitpokhrel/jira-cli#882)

#### ☕️ Other changes

- chore(docs): Add packaging stats to Installation section in README.md by [@&#8203;kskarthik](https://github.com/kskarthik) in [#&#8203;857](ankitpokhrel/jira-cli#857)

#### New Contributors

- [@&#8203;evg656e](https://github.com/evg656e) made their first contribution in [#&#8203;840](ankitpokhrel/jira-cli#840)
- [@&#8203;vkhitrin](https://github.com/vkhitrin) made their first contribution in [#&#8203;851](ankitpokhrel/jira-cli#851)
- [@&#8203;iksi4prs](https://github.com/iksi4prs) made their first contribution in [#&#8203;662](ankitpokhrel/jira-cli#662)
- [@&#8203;aazon](https://github.com/aazon) made their first contribution in [#&#8203;858](ankitpokhrel/jira-cli#858)
- [@&#8203;jontyq](https://github.com/jontyq) made their first contribution in [#&#8203;890](ankitpokhrel/jira-cli#890)
- [@&#8203;ciricc](https://github.com/ciricc) made their first contribution in [#&#8203;882](ankitpokhrel/jira-cli#882)
- [@&#8203;kskarthik](https://github.com/kskarthik) made their first contribution in [#&#8203;857](ankitpokhrel/jira-cli#857)

**Full Changelog**: <ankitpokhrel/jira-cli@v1.6.0...v1.7.0>

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS45MS4zIiwidXBkYXRlZEluVmVyIjoiNDEuOTEuMyIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90Il19-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deprecated API endpoint returns HTTP 410 error [Critical]

2 participants