Improve documentation for writing an API module
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	• Spage
	Jul 24 2015, 6:12 AM

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 created this task.Jul 24 2015, 6:12 AM

• 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.

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJul 24 2015, 6:12 AM

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 added projects: MediaWiki-Action-API, Documentation.

Anomie moved this task from Unsorted to Non-Code on the MediaWiki-Action-API board.Jul 27 2015, 1:36 PM

• Spage triaged this task as Medium priority.Jul 28 2015, 5:26 AM

Tinaj1234 subscribed.Jul 28 2015, 10:39 AM

MrStradivarius added a project: MediaWiki-extensions-Examples.Aug 2 2015, 3:46 AM

Danny_B moved this task from Backlog to About MediaWiki extensions on the Documentation board.May 6 2016, 10:17 PM