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

Assigned To

None

Authored By

	Daimona
	Dec 11 2023, 3:29 PM

Project Tags

Referenced Files

None

Subscribers

Aklapper

apaskulin

Daimona

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.

Details

Related Changes in Gerrit:

Subject	Author	Repo	Branch	Lines +/-
Localise response description strings in REST handlers	Mhorsey	mediawiki/extensions/CampaignEvents	master	+42 -10
REST: Document error responses across all handlers	Mhorsey	mediawiki/extensions/CampaignEvents	master	+216 -2
Document parameters with i18n	Mhorsey	mediawiki/extensions/CampaignEvents	master	+969 -42

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	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

Event Timeline

Daimona created this task.Dec 11 2023, 3:29 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptDec 11 2023, 3:29 PM

Daimona moved this task from Backlog to Tech debt on the CampaignEvents board.Dec 11 2023, 3:29 PM

Daimona added a subtask: T362006: Provide a Swagger-UI for exploring the core REST API.May 6 2024, 1:36 PM

daniel closed subtask T362006: Provide a Swagger-UI for exploring the core REST API as Resolved.Jul 16 2024, 7:39 PM

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.

Daimona updated the task description. (Show Details)Jan 7 2025, 7:18 PM

Daimona mentioned this in T387152: [EPIC] Get CampaignEvents extension on the Wikipedia apps (iOS and Android).Feb 25 2025, 6:42 PM

Daimona updated the task description. (Show Details)Dec 12 2025, 2:01 PM

Change #1305884 had a related patch set uploaded (by Mhorsey; author: Mhorsey):

[mediawiki/extensions/CampaignEvents@master] Document parameters with i18n

https://gerrit.wikimedia.org/r/1305884

gerritbot added a project: Patch-For-Review.Jul 7 2026, 2:33 PM

Daimona changed the task status from Stalled to Open.Aug 3 2026, 10:37 PM

Change #1321550 had a related patch set uploaded (by Mhorsey; author: Mhorsey):

[mediawiki/extensions/CampaignEvents@master] Localise response description strings in REST handlers

https://gerrit.wikimedia.org/r/1321550

Change #1321551 had a related patch set uploaded (by Mhorsey; author: Mhorsey):

[mediawiki/extensions/CampaignEvents@master] REST: Document error responses across all handlers

https://gerrit.wikimedia.org/r/1321551

Change #1305884 merged by jenkins-bot:

[mediawiki/extensions/CampaignEvents@master] Document parameters with i18n

https://gerrit.wikimedia.org/r/1305884

Daimona mentioned this in T426280: Create CampaignEvents REST API module for the extension.Wed, Sep 30, 11:34 PM

apaskulin subscribed.Thu, Oct 1, 7:37 PM

Change #1321550 merged by jenkins-bot: