Page MenuHomePhabricator

Reading List REST Interface: GET lists/pages endpoint
Closed, ResolvedPublic


Create a REST handler and any other necessary associated code (extension.json entry, helper classes, etc.) for the GET lists/pages endpoint.

  • endpoint implemented
  • tests created
  • tests pass

Endpoint summary:
Get lists of the current user which contain a given page.

Endpoint description:
Request must be authenticated with a MediaWiki session cookie.
Stability: unstable

Associated RESTBase code
lists.yaml (spec+forwarding)
lists.js (tests)

Associated Action API code


namesourcerequiredtypeexampledefaultpossible valuesdescription
projectpathyesstringhttps://en.wikipedia.orgN/AN/ADomain of the wiki containing the page.
titlepathyesstringBarack_ObamaN/AN/ATitle of the page containing the page, in database format.
nextquerynostringN/AN/AContinuation parameter from previous request

Error Response

#/components/schemas/problem per and draft-nottingham-http-problem

Success Response

listsarray: list_read
nextstringContinuation token

Response Headers

This endpoints has additional response headers specified in the RESTBase code:

  content-type: application/json; charset=utf-8; profile=""
  cache-control: max-age=0, s-maxage=0

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript
BPirkle renamed this task from Reading List REST Interface: create lists/pages GET endpoint to Reading List REST Interface: GET lists/pages endpoint.Nov 14 2023, 2:58 AM
BPirkle updated the task description. (Show Details)

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

[mediawiki/extensions/ReadingLists@master] REST Handlers for managing reading lists

Change 983241 merged by jenkins-bot:

[mediawiki/extensions/ReadingLists@master] REST Handlers for managing reading lists

Added the following parameter that was previously exposed by the underlying Action API endpoint, but not by RESTBase:

namesourcerequiredtypeexampledefaultpossible valuesdescription
limitquerynointeger5101..10Maximum number of values to return
BPirkle updated the task description. (Show Details)