Page MenuHomePhabricator

Document temporary account APIs on mediawiki.org
Closed, ResolvedPublic

Description

Background

New API endpoints have recently been added to the CheckUser extension, for fetching IP addresses of temporary accounts.

These should be documented on https://mediawiki.org/wiki/Extension:CheckUser

What needs documenting
  • Basic usage of TemporaryAccountHandler and TemporaryAccountRevisionHandler, with examples (either add to https://mediawiki.org/wiki/Extension:CheckUser#API or make a new section)
  • Explanation of the buttons added next to temporary account user links
  • The new checkuser-temporary-account right (where the other rights are documented, in the infobox near the top, via the Extension template
  • The new hooks used, also in the infobox
Testing Notes
  • Check against Acceptance Criteria, make sure everything has been documented.

Event Timeline

https://commons.wikimedia.org/wiki/File:Temporary_user_account_ips.png seems wrong. The response says it's returned by the "checkuser" API query. Also the temporary account revealing REST interface does not provide the first and last time an IP is used.

Also the API query that is listed on the documentation page is not the temporary account reveal REST API. It's the checkuser API which is only accessible by users with the "checkuser" right.

I've made several modifications to the documentation that has been added ( https://www.mediawiki.org/w/index.php?title=Extension%3ACheckUser&diff=5797958&oldid=5792213 ). I'm a little confused by the TemporaryAccountRevisionHandler section. Is this detailing future uses of this REST API? At the moment the documentation here doesn't seem to match with what it is used for.

Let me know if my changes make sense.

I've made several modifications to the documentation that has been added ( https://www.mediawiki.org/w/index.php?title=Extension%3ACheckUser&diff=5797958&oldid=5792213 ). I'm a little confused by the TemporaryAccountRevisionHandler section. Is this detailing future uses of this REST API? At the moment the documentation here doesn't seem to match with what it is used for.

Let me know if my changes make sense.

This looks good to me, thanks for adding more documentation!