Page MenuHomePhabricator

ApiHelp displays wiki-specific parameter values
Open, LowPublic


ApiHelp dynamically generates possible values for some parameters, e.g.

This confuses novice API users, and it's also overwhelming in the latter example. In the former example, ApiBase::PARAM_TYPE => 'namespace' results in the list, in the latter case Wikibase generates the list itself with ApiBase::PARAM_TYPE => $sites->getGlobalIdentifiers() generates the list.

Event Timeline

Spage created this task.Mar 3 2015, 5:16 AM
Spage updated the task description. (Show Details)
Spage raised the priority of this task from to Low.
Spage added a project: MediaWiki-API.
Spage moved this task to Unsorted on the MediaWiki-API board.
Spage added a subscriber: Spage.
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 3 2015, 5:16 AM

(From e-mail)
@Anomie thinks it's impossible to determine whether certain parameters have "Values (specific to this wiki)" in general. We could add ApiBase:PARAM_WIKI_SPECIFIC flag to getAllowedParams() that would display the caveat text.

jayvdb added a subscriber: jayvdb.Mar 19 2015, 9:48 AM