863093 - The usermatchmode parameter no longer exists. The POD for User.get must be fixed accordingly

Status: RESOLVED FIXED

(Bugzilla :: WebService, defect)

Description

[Frédéric Buclin]

The documentation for the User.get API says that:

"Some Bugzilla installations have user-matching turned off, in which case you will only be returned exact matches.

Most installations have a limit on how many matches are returned for each string, which defaults to 1000 but can be changed by the Bugzilla administrator."


First of all, the usermatchmode parameter is gone since Bugzilla 3.6, see bug 399089. So the first sentence is obsolete.

Also, the 2nd sentence makes us think that User.get follows the maxusermatches parameter, but it ignores it completely. The description of this parameter is:

"If set to '1', no users will be displayed on ambiguous matches. This is useful for user privacy purposes."

But it only applies to the web UI, not to the WebServices. Either we indeed don't care about this limitation and the 2nd sentence must go away, or it's a bug and it must be fixed.

Thoughts?

Comment 1

[Frédéric Buclin]

Attachment: patch, v1

Now that bug 962060 is fixed, the patch is trivial.

Comment 2

[David Lawrence [:dkl]]

Comment on attachment 8382912 [details] [diff] [review]
patch, v1

Review of attachment 8382912 [details] [diff] [review]:
-----------------------------------------------------------------

r=dkl

Comment 3

[Frédéric Buclin]

Committing to: bzr+ssh://[e-mail]/bugzilla/trunk/
modified Bugzilla/WebService/User.pm
Committed revision 8939.

Committing to: bzr+ssh://[e-mail]/bugzilla/4.4/
modified Bugzilla/WebService/User.pm
Committed revision 8666.