Page MenuHomePhabricator

Improve documentation for writing an API module
Closed, ResolvedPublic

Description

@Fhocutt ran into a lot of problems.

API:Extension needs work

  • explain prefix
  • explain tokens better
  • update example
  • big new section about returning API errors and warnings "How $ApiStatus and ApiBase::dieStatus() work, and API error handling on the server side in general."
  • synchronize the example code with extensions/examples/Example and new extensions/BoilerPlate
  • update the i18n message stuff.

Event Timeline

Spage raised the priority of this task from to Needs Triage.
Spage updated the task description. (Show Details)
Spage added a project: Web-APIs-Hub.
Spage moved this task to Supporting documentation on the Web-APIs-Hub board.
Spage added subscribers: Spage, Fhocutt.

An "API extension" is kind of confusing terminology. This is really about creating API modules from within MediaWiki extensions, right?

Fhocutt renamed this task from Improve documentation for writing an API extension to Improve documentation for writing API modules for MediaWiki extensions.Jul 24 2015, 6:29 PM
Fhocutt set Security to None.
Spage renamed this task from Improve documentation for writing API modules for MediaWiki extensions to Improve documentation for writing an API module.Jul 26 2015, 10:44 PM
Spage triaged this task as Medium priority.Jul 28 2015, 5:26 AM
Aklapper lowered the priority of this task from Medium to Low.Oct 7 2017, 6:56 PM

Proposing to close this task as resolved as a rewrite of mw:API:Extensions took place in June 2017.

Anomie claimed this task.
Anomie added a subscriber: Anomie.

I suppose we may as well, since Frances and S are both gone :(