Page MenuHomePhabricator

Fix description and example issues for transform paths in the MediaWiki REST API OAD (part 1)
Closed, ResolvedPublic

Description

Fix linter issues related to descriptions and examples under a subset of /v1/transform paths in the MediaWiki REST API OAD (96 issues).

Paths in scope for this task:

  • /v1/transform/wikitext/to/html/{title}/{revision}
  • /v1/transform/html/to/wikitext/{title}/{revision}
  • /v1/transform/wikitext/to/lint/{title}/{revision}
  • /v1/transform/wikitext/to/html
  • /v1/transform/html/to/wikitext

Add descriptions:

  • to response schema properties (wikimedia-response-schema-properties-description)
  • to request bodies; after T427355 is done (wikimedia-requestbody-description)
  • to request body schema properties (wikimedia-requestbody-schema-properties-description)
  • to operations (wikimedia-operation-description)
  • to parameters (wikimedia-paths-parameter-description-customized)

Add examples after T427361, T427360, T424002, T426836 are done:

  • for parameters (wikimedia-paths-parameter-example-exists)
  • for responses (wikimedia-response-example-exists)
  • for request bodies (wikimedia-requestbody-example-exists)
  • for all components (wikimedia-schema-example-recommended)

When adding or editing descriptions in the OAD, be sure to follow the style guide.

Details

Event Timeline

KBach triaged this task as Medium priority.
KBach renamed this task from Fix description issues in the MW REST API OAD to Fix description issues in the MediaWiki REST API OAD.Jun 4 2026, 12:02 PM
KineticPelagic subscribed.

As part of my Clinic Duty rotation, I add a project tag and move this task to "To Estimate" because the task is clear enough to be sized and valuable in our current hypothesis.

KBach renamed this task from Fix description issues in the MediaWiki REST API OAD to Fix description and example issues for transform paths in the MediaWiki REST API OAD (part 1).Jun 8 2026, 11:17 AM
KBach updated the task description. (Show Details)
KBach changed the task status from Open to In Progress.Thu, Jul 2, 5:50 AM
KBach claimed this task.

Change #1308056 had a related patch set uploaded (by KBach; author: KBach):

[mediawiki/core@master] REST: Add examples and descriptions for transform endpoints

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

Change #1308056 merged by jenkins-bot:

[mediawiki/core@master] REST: Add examples and descriptions for transform endpoints

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