in ReadingLists api error message keys should begin with "apierror"
Closed, ResolvedPublic
Actions

Description

Usually, message keys of api help, api warning, and api error messages begin with the strings "apihelp", "apiwarn", or "apierror".

This doesn't seem to be the case with the ReadingLists extension, which has keys like readinglists-apierror-project-title-param. As far as I can see, it would be nice to make this consistent and rename them to something like apierror-readinglists-project-title-param, although it's possible that @Tgr, @Nikerabbit, @Raymond, and @Anomie will have a different opinion.

Thanks!

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	Rename API error messages to match convention	mediawiki/extensions/ReadingLists	master	+41 -41

Customize query in gerrit

Related Objects

Mentioned In: rERLS886f317f78cf: Rename API error messages to match convention
rERLSc1c5b7cc968c: Rename API error messages to match convention
rERLS8582c5baa03f: Rename API error messages to match convention
rERLSb934072d90e9: Rename API error messages to match convention
T182549: Email sometimes not being sent when a task is created and "other task activity" is not set in user preferences

Event Timeline

Amire80 created this task.Dec 10 2017, 5:10 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptDec 10 2017, 5:10 PM

A quick glance over mw core and extensions. it does seem most api error messages use the format you're suggesting

Aklapper added a project: Reading List Service.Dec 10 2017, 8:45 PM

Restricted Application added a project: Product-Infrastructure-Team-Backlog-Deprecated. · View Herald TranscriptDec 10 2017, 8:45 PM

Yes, the convention is to prefix messages with "apihelp", "apiwarn", or "apierror". Most extensions use that convention because I did that when mass-converting everything to the new i18n help and error messages. On the other hand, it does go against the wider convention of prefixing all extension messages with some version of the extension's name.

The apihelp prefix is encouraged by the fact that if you don't follow it you have to override the default message names everywhere.

The other two aren't so encouraged. While the API will turn "apierror-readinglists-project-title-param" into a slightly nicer error code by stripping off the "apierror-" prefix, it's still reasonably likely that you'll override the code to something shorter than "readinglists-project-title-param".

Anomie mentioned this in T182549: Email sometimes not being sent when a task is created and "other task activity" is not set in user preferences.Dec 11 2017, 4:54 AM

Tgr claimed this task.Jan 9 2018, 5:56 PM

Tgr edited projects, added Product-Infrastructure-Team-Backlog-Deprecated (Kanban); removed Product-Infrastructure-Team-Backlog-Deprecated.

Amire80 moved this task from Untriaged to Message keys names on the I18n board.Feb 3 2018, 12:14 PM

Tgr moved this task from To Do to Doing on the Product-Infrastructure-Team-Backlog-Deprecated (Kanban) board.Feb 16 2018, 2:51 AM

Change 412243 had a related patch set uploaded (by Gergő Tisza; owner: Gergő Tisza):
[mediawiki/extensions/ReadingLists@master] Rename API error messages to match convention

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

gerritbot added a project: Patch-For-Review.Feb 18 2018, 8:26 AM

Tgr mentioned this in rERLSb934072d90e9: Rename API error messages to match convention.Feb 18 2018, 8:29 AM

RESTBase patch: #956

Tgr moved this task from Doing to Code Review on the Product-Infrastructure-Team-Backlog-Deprecated (Kanban) board.Feb 18 2018, 8:33 AM

Tgr mentioned this in rERLS8582c5baa03f: Rename API error messages to match convention.Feb 18 2018, 9:16 AM

• Mholloway mentioned this in rERLSc1c5b7cc968c: Rename API error messages to match convention.Feb 21 2018, 3:00 PM

• Mholloway mentioned this in rERLS886f317f78cf: Rename API error messages to match convention.Feb 21 2018, 3:21 PM

Change 412243 merged by jenkins-bot:
[mediawiki/extensions/ReadingLists@master] Rename API error messages to match convention

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

ReleaseTaggerBot added a project: MW-1.31-release-notes (WMF-deploy-2018-02-27 (1.31.0-wmf.23)).Feb 21 2018, 4:00 PM

Tgr closed this task as Resolved.Feb 21 2018, 7:37 PM