Page MenuHomePhabricator

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

Description

NOTE: The deprecated "batch" value from the response is still being used by callers and should be included in the new implementation

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

  • endpoint implemented
  • tests created
  • tests pass

Endpoint summary:
Create multiple new lists for the current user

Endpoint description:
See POST /lists/.
Stability: unstable

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

Associated Action API code
ApiReadingListsCreate
ApiReadingListsCreateTest

Parameters:

namesourcerequiredtypeexampledefaultpossible valuesdescription
csrf_tokenqueryyesstringf63c343876da566045e6b59c4532450559c828d3+\\N/AN/AThe CRSF edit token provided by the MediaWiki API

Request Body:
list_write, array of max 500

Error Response

#/components/schemas/problem per API.md and draft-nottingham-http-problem

Success Response

valuetypedescription
batcharrayDeprecated, will be removed. Use the full list objects instead.
listsarray: list_read

Response Headers

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

headers:
  content-type: application/json; charset=utf-8

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript
BPirkle renamed this task from Reading List REST Interface: create lists/batch POST endpoint to Reading List REST Interface: POST lists/batch 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

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

Change 983241 merged by jenkins-bot:

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

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

BPirkle updated the task description. (Show Details)