Page MenuHomePhabricator

Reading List REST Interface: POST lists/{id}/entries/batch endpoint
Closed, ResolvedPublic

Description

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

  • endpoint implemented
  • tests created
  • tests pass

Endpoint summary:
Create multiple new list entries.

Endpoint description:
See POST /lists/{id}/entries/.
Stability: unstable

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

Associated Action API code
ApiReadingListsCreateEntry
ApiReadingListsCreateEntryTest

Parameters:

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

Request Body:
list_entry_write, array, max of 500

Error Response

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

Success Response

valuetypedescription
batcharray of objects, each containing an integer list entry id
entriesarray of list_entry_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/{id}/entries/batch POST endpoint to Reading List REST Interface: POST lists/{id}/entries/batch endpoint.Nov 14 2023, 2:58 AM
BPirkle updated the task description. (Show Details)

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

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

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

Change 988736 merged by jenkins-bot:

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

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

BPirkle updated the task description. (Show Details)