Page MenuHomePhabricator

Include wikitext/to/lint endpoint in OpenAPI spec generation
Closed, ResolvedPublic3 Estimated Story Points

Description

Description

Conditions of acceptance

Add the following endpoints to all MediaWiki REST API documentation solutions

  • /transform/wikitext/to/lint
  • /transform/wikitext/to/lint/{title}
  • /transform/wikitext/to/lint/{title}/{revision}
  • Create response body JSON representing returned Lint errors
  • Update spec generation to include this endpoint
  • Add description strings for translation
  • Add end to end tests for validating accurate response body

Implementation details

  • The page lint endpoints do have an example; we can use it as the same response body example and for mocha testing purposes on the transform endpoints.
  • Existing mocha tests check specific return values, but not spec matching

Event Timeline

HCoplin-WMF renamed this task from Document wikitext/to/lint endpoint in production to Include wikitext/to/lint endpoint in OpenAPI spec generation.Mar 10 2025, 2:53 PM
HCoplin-WMF triaged this task as Medium priority.
HCoplin-WMF updated the task description. (Show Details)
HCoplin-WMF set the point value for this task to 3.

Change #1203192 had a related patch set uploaded (by Aaron Schulz; author: Aaron Schulz):

[mediawiki/core@master] rest: set return body spec for lint TransformHandler subclasses

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

Change #1203192 merged by jenkins-bot:

[mediawiki/core@master] rest: set return body spec for lint TransformHandler subclasses

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