Page MenuHomePhabricator
Create Task
Maniphest T21195

Make user IDs more readily available with the API
Closed, ResolvedPublic
Actions

Description

Author: matthew.britton

Description:
It would be nice if the API could supply user IDs anywhere that user names are currently an option, e.g. prop=revisions. This would allow clients to use the ID rather than the name as an identifier for the user, as can be done currently with page IDs, an advantage when dealing with large numbers of items.

Revisions by anonymous users would I believe end up with 0 as the user ID this way, which may render it unsuitable for some purposes but would certainly be OK for mine.

Version: unspecified
Severity: enhancement
See Also:
https://bugzilla.wikimedia.org/show_bug.cgi?id=8816

Details

Reference
bz19195
SubjectRepoBranchLines +/-
API: Use ParamValidator librarymediawiki/coremaster+3 K -1 K
Customize query in gerrit

Related Objects
Search...

Event Timeline

• bzimport raised the priority of this task from to Medium.Nov 21 2014, 10:43 PM
• bzimport added a project: MediaWiki-Action-API.
• bzimport set Reference to bz19195.
• bzimport added a subscriber: Unknown Object (MLST).
• bzimport created this task.Jun 14 2009, 6:54 PM
• bzimport added a comment.Jun 18 2009, 4:19 AM

herd wrote:

Per: http://toolserver.org/~amidaniel/chanlogs/%23mediawiki/20090501.txt

<brion-meeting> user ids are an internal implementation detail which should never be needed externally, but they're not actively hidden

This has been discussed before but nobody gets around to it.

• bzimport added a comment.Jun 18 2009, 10:24 AM

herd wrote:

Suggestions for implementation of almost full User<->ID abstraction in API (per Roan@IRC):

Queries

ApiQueryRevisions.php

  • rvprop=user -> userid="12345" or userid="0"
  • rvuserid=12345
  • rvexcludeuserid=12345

ApiQueryImageInfo.php

  • iiprop=user -> userid="12345" or userid="0"

ApiQueryAllimages.php

  • aiprop=user -> userid="12345" or userid="0"

ApiQueryAllUsers.php

  • list=allusers -> name="" id="12345" or userid="0"
  • austartid=12345 <- if given a userid, possible to return sequenial users by id?

ApiQueryBlocks.php <- note, non-trivial to reference a blocked user from user ID, skip

ApiQueryDeletedrevs.php

  • drprop=user -> userid="12345" or userid="0"
  • druserid=12345

ApiQueryLogEvents.php

  • leprop=user -> userid="12345" or userid="0"
  • leuserid=12345

ApiQueryRecentChanges.php

  • rcprop=user -> userid="12345" or userid="0"

ApiQueryUserContributions.php

  • (any) -> userid="12345" or userid="0"
  • ucuserid=12345

ApiQueryWatchlist.php

  • wlprop=user -> userid="12345" or userid="0"

ApiQueryUsers.php

  • list=users -> userid="12345" or skip for missing=""
  • ususerids=12345

ApiQueryProtectedTitles.php

  • ptprop=user -> userid="12345" or userid="0"
Actions - should also output ID on success where applicable.

ApiRollback.php

  • userid=12345

ApiBlock.php

  • userid=12345

ApiUnblock.php

  • userid=12345

ApiEmailUser.php

  • targetid=12345 <- this might be weird.

ApiUserrights.php

  • userid=12345
• bzimport added a comment.Jun 23 2009, 10:22 PM

matthew.britton wrote:

(In reply to comment #1)

Per: http://toolserver.org/~amidaniel/chanlogs/%23mediawiki/20090501.txt

<brion-meeting> user ids are an internal implementation detail which should never be needed externally

True, but only in the sense that page IDs and revision IDs are internal implementation details, and they're available.

• bzimport added a comment.Jun 24 2009, 1:28 AM

herd wrote:

(In reply to comment #3)

<brion-meeting> user ids are an internal implementation detail which should never be needed externally,

True, but only in the sense that page IDs and revision IDs are internal
implementation details, and they're available.

Not the same sense at all. Page IDs are extensively used in the UI as &curid in most recent changes links (to allow the correct page to be shown even if the page has moved since). And of course, revision IDs are used anywhere a diff or permanent link is shown. User IDs however are not used in the UI anywhere... except in some extensions, which usually involve direct requests from the user (who is generally the only one with access to this number, excluding the Special:Export trick).

So, they've just never been exposed as they are never used. There are cases where they would have been handy in the API though, such as the unfortunate case of bug 17878 (usernames that could log in, and edit, but not be blocked). For this same reason, things like move and delete can be done in the API via page IDs now (where invalid titles could not be referred to otherwise). So giving them a use, like the ability to block retroactively invalid usernames, is a good excuse to expose them.

Reedy added a comment.Aug 28 2010, 12:39 AM

Started doing some props in r71831

ApiQueryAllUsers, ApiQueryImageInfo and ApiQueryRevisions

Reedy added a comment.Aug 28 2010, 1:11 AM

r71834

ApiQueryDeletedrevs, ApiQueryLogEvents

r71837

ApiQueryRecentChanges.php, ApiQueryUserContributions.php, ApiQueryWatchlist.php

Reedy added a comment.Aug 28 2010, 1:18 AM

r71838

ApiQueryAllImages, ApiQueryProtectedTitles

Leaves:

Queries

ApiQueryRevisions.php

  • rvuserid=12345
  • rvexcludeuserid=12345

ApiQueryAllUsers.php

  • austartid=12345 <- if given a userid, possible to return sequenial users by

id?

ApiQueryDeletedrevs.php

  • druserid=12345

ApiQueryLogEvents.php

  • leuserid=12345

ApiQueryUserContributions.php

  • ucuserid=12345

ApiQueryUsers.php

  • list=users -> userid="12345" or skip for missing=""
  • ususerids=12345

    Actions - should also output ID on success where applicable.

ApiRollback.php

  • userid=12345

ApiBlock.php

  • userid=12345

ApiUnblock.php

  • userid=12345

ApiEmailUser.php

  • targetid=12345 <- this might be weird.

ApiUserrights.php

  • userid=12345
duplicatebug added a comment.Feb 6 2011, 7:28 PM

ApiQueryFilearchive.php is missing.

duplicatebug added a comment.Feb 21 2011, 6:43 PM

bug 27616

(In reply to comment #8)

ApiQueryFilearchive.php is missing.

bug 27617

Reedy added a comment.Feb 21 2011, 7:50 PM

QueryBlocks (Both blocking and blocked id) in r82570 / bug 27616

duplicatebug added a comment.Feb 24 2011, 6:48 PM

list=users&usprop=blockinfo and list=allusers&auprop=blockinfo gives the username of the blocker. What about adding the user id of the blocker?

duplicatebug added a comment.Feb 24 2011, 7:02 PM

(In reply to comment #11)

list=users&usprop=blockinfo and list=allusers&auprop=blockinfo gives the
username of the blocker. What about adding the user id of the blocker?

meta=userinfo&uiprop=blockinfo also

charitwo added a comment.Mar 5 2011, 9:20 AM

reedy spamming my inbox

Umherirrender added a comment.Apr 21 2012, 7:17 PM

(In reply to comment #11)

list=users&usprop=blockinfo and list=allusers&auprop=blockinfo gives the
username of the blocker. What about adding the user id of the blocker?

(In reply to comment #12)

(In reply to comment #11)

list=users&usprop=blockinfo and list=allusers&auprop=blockinfo gives the
username of the blocker. What about adding the user id of the blocker?

meta=userinfo&uiprop=blockinfo also

I add some user ids to output with gerrit 5546

duplicatebug unsubscribed.Dec 13 2014, 11:49 AM
Anomie moved this task from Unsorted to Needs Code on the MediaWiki-Action-API board.Feb 20 2015, 7:50 PM
Ricordisamoa subscribed.Sep 24 2015, 8:27 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 24 2015, 8:27 PM
Anomie closed subtask T34494: API: Ability to search by user id as Resolved.Dec 9 2016, 6:55 PM
Anomie closed subtask T34496: API should allow blocking/unblocking using userid as Resolved.Dec 13 2016, 5:18 PM
Umherirrender mentioned this in T34496: API should allow blocking/unblocking using userid.Dec 16 2016, 5:35 PM
Anomie added a subtask: T154774: Add userid versions of `rvuser` and `rvexcludeuser`.Jan 6 2017, 2:26 PM
Anomie added a subtask: T154775: Add guiuserid for meta=globaluserinfo.
Anomie closed subtask T114465: API should allow querying user contribs by userid as Resolved.
Anomie moved this task from Needs Code to Needs Review on the MediaWiki-Action-API board.Jan 14 2020, 10:25 PM
Restricted Application added a project: Platform Engineering. · View Herald TranscriptJan 14 2020, 10:25 PM
Anomie removed a project: Platform Engineering.Jan 14 2020, 10:26 PM
gerritbot added a comment.Feb 4 2020, 8:39 PM

Change 434718 merged by jenkins-bot:
[mediawiki/core@master] API: Use ParamValidator library

https://gerrit.wikimedia.org/r/434718

Anomie closed this task as Resolved.Feb 4 2020, 8:40 PM
Anomie claimed this task.
Anomie closed subtask T154774: Add userid versions of `rvuser` and `rvexcludeuser` as Resolved.
DanielFriesen unsubscribed.Feb 4 2020, 10:39 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL