Page MenuHomePhabricator

Document REST API overview
Closed, ResolvedPublic2 Estimated Story Points

Description

To do

  • Decide on a location for REST API docs on mediawiki.org. The REST API overview will be at API:REST; endpoint docs will be at API:REST/[Resource] API
  • Draft an overview page for the REST API on mediawiki.org https://www.mediawiki.org/wiki/API:REST
  • Create a configuration setting page on mediawiki.org for $wgEnableRestAPI

Overview page checklist

  • URL structure
  • Versioning policy
  • Response codes (currently documented per endpoint)
  • Errors (currently documented per endpoint)
  • Access policy (depends on public launch)
  • Rate limits (depends on public launch)
  • Conditional requests (If-Modified-Since, etc.) (not implemented)

Organization

  • The API namespace is currently reserved for Action API docs, so we should avoid adding REST API docs there unless we add a consistent prefix like API:REST/. Once the REST API is stable, we should consider updating the API main page to include the REST API as an option or creating a multi-API landing page.
  • Mediawiki.org currently documents the RESTBase API as the "Wikimedia REST API". We should decide on terminology here to distinguish between the two REST APIs.

References

Event Timeline

apaskulin updated the task description. (Show Details)
apaskulin set the point value for this task to 2.Oct 4 2019, 10:44 PM
apaskulin moved this task from Ready to Doing on the Platform Team Workboards (Green) board.

For now, the overview page includes basic, introductory information for the REST API. I'll be updating the page as additional API features are implemented and in preparation for the public launch of the API. That work will be tracked in separate tasks.

eprodromou added a subscriber: eprodromou.

I've reviewed the draft; it looks done. Since we'll be tracking other parts of the API in separate tasks, I think this task is resolved.