Page MenuHomePhabricator

Update MediaWiki REST API Documentation to include /wikitext/to/lint
Open, MediumPublic2 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}

Update MediaWiki documentation

  • Under the the "Convert HTML to Wikitext" section, add a section for "Check Wikitext for errors"
    • Endpoint description: Parse the supplied wikitext and check it for lint errors.
    • Method: POST
    • Parameters: See those documented in RESTbase documentation)
    • Payload: Transform request body with source
    • Returns: Lint errors, if any exist.
  • Create a new response body example that reflects expected Lint error formant.
  • Increment MediaWiki version number to v1.44 for the transform section

Update API Portal documentation (?)

  • Decision: We will NOT update the API Portal at this time. It is not an 'officially' launched or supported product.
    • NOTE: Other transform endpoints are not currently in the API portal --> Is there an intentional reason for that?
NOTE: Per Tech Writer recommendation, we need to keep the on-wiki reference documentation up to date as we create new endpoints. Eventually we will transition to have the REST Sandbox be THE source of truth for reference documentation for the REST APIs and will remove/reroute the existing reference docs. However, until we do that, both must be kept in sync.