Page MenuHomePhabricator

Define and store remaining core MediaWiki REST API endpoint responses as JSON schemas
Closed, ResolvedPublic

Description

Description

To complete our implementation of interactive documentation and support our long term vision of validated specs, we need to define and document specific endpoint responses as JSON schemas. Other tasks (T375530: Define and store MediaWiki REST API ‘page’ endpoint responses as JSON schemas, T379705: Create JSON schema definition for MediaWiki REST API 'transform' endpoints) covered most of the endpoints defined in core. This task covers the remaining endpoints.

Problem statement
We need JSON schema representations of our response bodies so that we can build and test validation against them.

Conditions of acceptance

Define response schemas for the following endpoints (200 only):

  • page/{title}/history/counts/{type} (PageHistoryCountHandler)
  • revision/{from}/compare/{to} (CompareHandler)
  • revision/{id}/html (RevisionHTMLHandler)
  • revision/{id}/with_html (RevisionHTMLHandler)
  • revision/{id}/bare (RevisionSourceHandler)
  • revision/{id} (RevisionSourceHandler)
  • search (OpenSearchDescriptionHandler)
  • /discovery (DiscoveryHandler)
  • /module/{module} (ModuleSpecHandler)
  • /module/{module}/{version} (ModuleSpecHandler)

Details

Event Timeline

Change #1104681 had a related patch set uploaded (by BPirkle; author: BPirkle):

[mediawiki/core@master] REST: Add remaining response schemas for core endpoints

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

HCoplin-WMF changed the task status from Open to In Progress.Dec 18 2024, 7:41 PM

Change #1104681 merged by jenkins-bot:

[mediawiki/core@master] REST: Add remaining response schemas for core endpoints

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

BPirkle updated the task description. (Show Details)