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

fix!: update Add/Remove due to 'username' argument being deprecated #414

Closed
wants to merge 1 commit into from

Conversation

t-junjie
Copy link

BREAKING CHANGE: Replace 'username' argument with 'accountID'
Refer to: https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/

Modify Group struct fields to reflect different fields returned by the API and documented JIRA API URLs to match the JIRA docs

Description

Please describe what does this Pull Request fix or add?

  • The What: Update documented JIRA API URLs and modify Group struct & Add/Remove to match the JIRA docs
  • The Why: The Add/Remove methods will fail upon being called now as they try to add or remove a user from group using their username, which is now deprecated. This update allows us to use these methods with the latest JIRA API.
  • Type of change: Bugfix
  • Breaking change: Yes, users will have to use accountid instead of username as argument to the abovementioned methods.
  • Related to an issue: NA
  • Jira Version + Type: Jira Cloud

Example:

Let us know how users can use or test this functionality.

// Add
group, resp, err := testClient.Group.Add("default", "000000000000000000000000");

// Remove
resp, err := testClient.Group.Remove("default", "000000000000000000000000"); 

Checklist

@andygrunwald
Copy link
Owner

Hey,

I am very sorry that this pull request has been open for a long time with no final feedback or merge/decline. We work on this project in our spare time, and sometimes, other priorities take over. This is the typical open source dilemma.

However, there is news: We are kicking off v2 of this library 🚀

To provide visibility, we created the Road to v2 Milestone and calling for your feedback in #489

The development will take some time; however, I hope you can benefit from the changes.
If you seek priority development for your pull request + you like to sponsor it, please contact me.

What does this mean for my pull request?

We will work on this pull request indirectly.
We might merge it during the development or pull parts of it into the new version.
This means that during the development phase, we aim to tackle it.
Maybe in a different way like it is currently handled.
Please understand that this will take a while because we are running this in our spare time.

Final words

Thanks for using and contributing to this library.
If there is anything else you would like to tell us, let us know!

@github-actions github-actions bot added the conflicts Indicates merge conflicts label Aug 25, 2022
andygrunwald added a commit that referenced this pull request Oct 19, 2022
…countId

Additionally:
* Cloud/Group: Renamed `Group.Add` to `Group.AddUserByGroupName`
* Cloud/Group: Renamed `Group.Remove` to `Group.RemoveUserByGroupName`

Thanks a lot to @t-junjie for the work in #414
@andygrunwald
Copy link
Owner

Thanks again @t-junjie for this Pull Request.
In the meantime, I did several changes in the library already.
Thats why I was not able to re-use your commits one by one.

I re-used your code as much as I could and re-implemented it in #589

I attributed the commit to you.
Thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants