Page MenuHomePhabricator

Reading List REST Interface: POST lists/setup endpoint
Closed, ResolvedPublic


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

  • endpoint implemented
  • tests created
  • tests pass

Endpoint summary:
Opt in to use reading lists

Endpoint description:
Must precede other list operations.
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
csrf_tokenqueryyesstringf63c343876da566045e6b59c4532450559c828d3+\\N/AN/AThe CRSF edit token provided by the MediaWiki API

Error Response

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

Success Response

json object

Event Timeline

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

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

[mediawiki/extensions/ReadingLists@master] Setup and Teardown REST Handlers

Change 980831 merged by jenkins-bot:

[mediawiki/extensions/ReadingLists@master] Setup and Teardown REST Handlers

Endpoints is implemented. Phpunit-based testing exists and passes (thanks @FGoodwin!). Leaving the testing boxes unchecked for now, as we might decide to do mocha tests as well.

BPirkle moved this task from In Progress to Done on the MW-Interfaces-Team board.