Page MenuHomePhabricator

API should allow for marking individual values of enum-style parameters as deprecated
Closed, ResolvedPublic

Description

See https://gerrit.wikimedia.org/r/#/c/264718/ for an example of a use case.

Brainstorming:

  • Add ApiBase::PARAM_VALUE_DEPRECATED as a string[] naming the deprecated parameters.
  • ApiParamInfo would want to include this in its output.
  • In combination with ApiBase::PARAM_HELP_MSG_PER_VALUE, ApiHelp and ApiParamInfo should indicate this in the message text.
  • Would there be a sane way to indicate it in the "list of possible values" too?
  • Parameter type 'submodule' should ideally pick this up from the submodules' isDeprecated() methods, but be careful of performance. See also T123930.

Event Timeline

Anomie raised the priority of this task from to Medium.
Anomie updated the task description. (Show Details)
Anomie added a project: MediaWiki-API.
Anomie moved this task to Needs details or plan on the MediaWiki-API board.
Anomie added a subscriber: Anomie.
Anomie set Security to None.
Anomie updated the task description. (Show Details)

Change 355818 had a related patch set uploaded (by Anomie; owner: Anomie):
[mediawiki/core@master] API: Add the ability to flag parameter values as deprecated

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

Change 355818 merged by jenkins-bot:
[mediawiki/core@master] API: Add the ability to flag parameter values as deprecated

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

The "Parameter type 'submodule' should ideally pick this up from the submodules' isDeprecated() methods" bit is being done as part of T123930.