Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add_watcher should accept a user ID, as per Jira API #1855

Open
supermitch opened this issue Apr 3, 2024 · 2 comments
Open

add_watcher should accept a user ID, as per Jira API #1855

supermitch opened this issue Apr 3, 2024 · 2 comments

Comments

@supermitch
Copy link

Problem trying to solve

I noticed that in version 3.5.x, the new Jira cloud (and this package) required a user ID to add watchers.
See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-watchers/#api-rest-api-3-issue-issueidorkey-watchers-post

However, in #1682, someone added the (very useful) ability to once again add watchers by email addresses. However, they:

  1. Added an extra API call
  2. Broke consistency with the API docs

Possible solution(s)

Please update the method and documentation so we can pass either an email address or an accountId, if we already have it.

Alternatives

  • Alternatively, I would revert the functionality to be more in-line with the REST API.
  • Alternatively, update the documentation to be more explicit, stating that a user search is being conducted internally.

Additional Context

Source: https://jira.readthedocs.io/_modules/jira/client.html#JIRA.add_watcher

@dimitarOnGithub
Copy link

I agree with the sentiment here, and also described that the internal user lookup might be resulting in unexpected behaviour in this comment on #1301.

@adehad I'll be happy to look into this since I believe it'd be a good way to solve both this issue, as well as #1284.

@adehad
Copy link
Contributor

adehad commented Jul 9, 2024

@dimitarOnGithub happy for you to look further into a solution, thanks for this

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

No branches or pull requests

3 participants