Maniphest T379705

Create JSON schema definition for MediaWiki REST API 'transform' endpoints
Closed, ResolvedPublic3 Estimated Story Points
Actions

Description

Description

To accurately generate complete OpenAPI specifications for the MediaWiki REST API, we need to define JSON schema representations of responses on all available endpoints in our system.

Due to additional complexity in how the transform endpoints are defined, we broke this work out from: https://phabricator.wikimedia.org/T376603

1. Conditions of Acceptance
Define JSON schemas for 'transform' endpoints:
- Convert Wikitext to HTML
- Convert HTML to Wikitext

Details

Related Changes in Gerrit:

	Subject	Author	Repo	Branch	Lines +/-
	TransformHandler: allow spec for unknown formats	Daniel Kinzler	mediawiki/core	master	+2 -3
	REST Add response schemas for 'transform' endpoints	WQuarshie	mediawiki/core	master	+113 -21

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Resolved		None	T375511 Hypothesis 5.1.7 (FY24-25 Q2): Define and Validate Response Bodies in Generated OpenAPI Specs
		Resolved		HCoplin-WMF	T376344 [5.1.7 Milestone]: OpenAPI spec response validation for all remaining MediaWiki REST API endpoints
		Resolved		BPirkle	T379705 Create JSON schema definition for MediaWiki REST API 'transform' endpoints

Event Timeline

HCoplin-WMF created this task.Nov 13 2024, 2:30 AM

HCoplin-WMF mentioned this in T376603: Create JSON schema definitions for all response bodies on remaining MediaWiki REST API endpoints.Nov 13 2024, 2:34 AM

HCoplin-WMF assigned this task to • codebug.Nov 13 2024, 2:37 AM

HCoplin-WMF triaged this task as Low priority.

HCoplin-WMF moved this task from Incoming (Needs Triage) to Backlog (Triaged and Ready) on the FY2024-25 KR 5.1 MediaWiki Automated API Documentation board.Nov 14 2024, 7:43 PM

BPirkle moved this task from Incoming (Needs Triage) to Backlog on the MediaWiki-API-Platform-Team board.Nov 21 2024, 4:47 PM

Change #1095080 had a related patch set uploaded (by WQuarshie; author: WQuarshie):

[mediawiki/core@master] Create JSON schema definition for MediaWiki REST API 'transform' endpoints

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

gerritbot added a project: Patch-For-Review.Nov 23 2024, 12:06 PM

BPirkle claimed this task.Nov 26 2024, 1:42 AM

BPirkle removed a subscriber: • codebug.

BPirkle mentioned this in T382264: Define and store remaining core MediaWiki REST API endpoint responses as JSON schemas.Dec 16 2024, 4:12 PM

BPirkle moved this task from Backlog to In Progress on the MediaWiki-API-Platform-Team board.Dec 18 2024, 10:45 PM

HCoplin-WMF mentioned this in T382456: Add response validation check to end-to-end testing on Transform MW REST API endpoints.Dec 18 2024, 11:26 PM

HCoplin-WMF moved this task from In Progress to To Refine on the MediaWiki-API-Platform-Team board.Jan 14 2025, 4:21 PM

HCoplin-WMF raised the priority of this task from Low to Medium.Jan 14 2025, 4:26 PM

HCoplin-WMF set the point value for this task to 3.

HCoplin-WMF moved this task from To Refine to MWI-Sprint-1 (2025-01-14 to 2025-01-28) on the MediaWiki-API-Platform-Team board.

HCoplin-WMF edited projects, added: MediaWiki-API-Platform-Team (MWI-Sprint-1 (2025-01-14 to 2025-01-28)); removed: MediaWiki-API-Platform-Team.

HCoplin-WMF mentioned this in T376607: Add response validation check to end-to-end testing on Page & History MW REST API endpoints.Jan 14 2025, 4:35 PM

Change #1095080 merged by jenkins-bot:

[mediawiki/core@master] REST Add response schemas for 'transform' endpoints

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

Maintenance_bot removed a project: Patch-For-Review.Jan 16 2025, 2:32 PM

ReleaseTaggerBot added a project: MW-1.44-notes (1.44.0-wmf.13; 2025-01-21).Jan 16 2025, 3:01 PM

Change #1112169 had a related patch set uploaded (by Daniel Kinzler; author: Daniel Kinzler):

[mediawiki/core@master] TransformHandler: allow spec for unknown formats

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

gerritbot added a project: Patch-For-Review.Jan 17 2025, 8:25 AM

Change #1112169 merged by jenkins-bot:

[mediawiki/core@master] TransformHandler: allow spec for unknown formats

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

Maintenance_bot removed a project: Patch-For-Review.Jan 17 2025, 3:30 PM

HCoplin-WMF moved this task from Committed to Demo Ready! on the MediaWiki-API-Platform-Team (MWI-Sprint-1 (2025-01-14 to 2025-01-28)) board.Jan 21 2025, 4:07 PM

HCoplin-WMF edited projects, added: MediaWiki-API-Platform-Team (MWI-Sprint-2 (2025-01-28 to 2025-02-11)); removed: MediaWiki-API-Platform-Team (MWI-Sprint-1 (2025-01-14 to 2025-01-28)).Jan 28 2025, 5:02 PM

HCoplin-WMF closed this task as Resolved.Jan 28 2025, 5:08 PM

HCoplin-WMF edited projects, added: MediaWiki-API-Platform-Team (MWI-Sprint-1 (2025-01-14 to 2025-01-28)); removed: MediaWiki-API-Platform-Team (MWI-Sprint-2 (2025-01-28 to 2025-02-11)).