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

Misguided documentation #99

Open
ricardofiorani opened this issue Mar 1, 2024 · 0 comments
Open

Misguided documentation #99

ricardofiorani opened this issue Mar 1, 2024 · 0 comments

Comments

@ricardofiorani
Copy link

ricardofiorani commented Mar 1, 2024

/**
* Creates a member in a group.
*
* @param {MemberRequest} request The request object that contains all the information used to create the group member(s).
* @returns {Promise<ClientResponse<MemberResponse>>}
*/
createGroupMembers(request: MemberRequest): Promise<ClientResponse<MemberResponse>> {
return this.start<MemberResponse, Errors>()
.withUri('/api/group/member')
.withJSONBody(request)
.withMethod("POST")
.go();
}

According to the official documentation this endpoint and method are to add one or more users to a group.

Calling it Create a member in a group | createGroupMembers does not makes much sense.
Ideally we would make it developer friendlier by calling it assignUserToGroup.

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

1 participant