Skip to content

Misguided documentation #99

Open
Open
@ricardofiorani

Description

@ricardofiorani

/**
* 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions