Maniphest T370422

Improve documentation for writing REST handlers
Open, LowPublic
Actions

Assigned To

None

Authored By

	daniel
	Jul 18 2024, 2:52 PM

Tags

Referenced Files

None

Subscribers

Description

The docs we have are hard to find, partially outdated:
https://www.mediawiki.org/wiki/API:REST_API/Extensions

In particular, we need to document the new things we added like getSupportedRequestTypes and getBodyParamSettings.

Event Timeline

daniel created this task.Jul 18 2024, 2:52 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJul 18 2024, 2:52 PM

BPirkle triaged this task as Low priority.Jul 25 2024, 3:28 PM

BPirkle moved this task from Incoming (Needs Triage) to Backlog (Triaged and Ready) on the MW-Interfaces-Team board.

We also have various other documentation that we should consider updating. Some is wider than just handlers, but still deserves a look. For example:
https://www.mediawiki.org/wiki/Core_Platform_Team/Initiative/Core_REST_API_in_MediaWiki/Design_principles#Operations
https://www.mediawiki.org/wiki/Core_Platform_Team/Initiatives/Core_REST_API_in_MediaWiki
https://www.mediawiki.org/wiki/API:REST_API