Port CampaignEvents REST API documentation to swagger
Open, Stalled, Needs TriagePublic
Actions

Assigned To

None

Authored By

	Daimona
	Dec 11 2023, 3:29 PM

Description

Once the REST sandbox leaves the experimental/beta status (see https://www.mediawiki.org/wiki/MediaWiki_Interfaces_Team/Feature_Feedback/REST_Sandbox), we should port our existing API documentation to swagger/openAPI specs and delete the wikipage in favour of linking to the REST sandbox.

Status	Assigned	Task
Stalled	None	T353157 Port CampaignEvents REST API documentation to swagger
Resolved	daniel	T362006 Provide a Swagger-UI for exploring the core REST API
Resolved	BPirkle	T323786 REST framework: Add support for outputting an OpenAPI (swagger) spec
Resolved	Mstyles	T325558 Application Security Review Request: Swagger UI
Resolved	BPirkle	T350161 Cleanup: REST framework: Add support for outputting an OpenAPI (swagger) spec
Invalid	None	T350060 Split the init method, so instantiateHandlerObject can inject the spec.
Invalid	None	T350059 Add fields based on the output mode
Invalid	None	T350057 We should reference a re-usable "user" type. The license structure should also be re-usable.
Declined	None	T350053 Create a JsonBodyValidator if getParamSettings() returns body params
Resolved	BPirkle	T350050 Create a utility function for loading spec files.
Invalid	None	T350051 Add info about redirects, and maybe a default for errors?
Invalid	None	T351741 Enable filtering the spec by endpoints/path prefix
Resolved	BPirkle	T352183 Support i18n for JSON body descriptions
Resolved	Atieno	T352664 Add unit testing for RootSpecHandler

I think the REST sandbox is still considered experimental, so it may be a bit too early to migrate, but the documentation is visible on testwiki: https://test.wikipedia.org/w/index.php?api=mw-extra&title=Special%3ARestSandbox and it can be enabled locally by setting:

$wgRestSandboxSpecs = [
	'mw' => [
		'url' => $wgScriptPath . '/rest.php/specs/v0/module/-',
		'name' => 'MediaWiki REST API',
	]
];

Marking as stalled due to the REST sandbox still being considered experimental as per https://www.mediawiki.org/wiki/Help:RestSandbox.