? T351152 Reading List REST Interface: PUT lists endpoint

Reading List REST Interface: PUT lists endpoint
Closed, Resolved Public
Actions

Assigned To

Authored By

	BPirkle
	Nov 14 2023, 1:25 AM

Description

NOTE: The deprecated "id" value from the response is not being used by any callers and can be removed in the new implementation

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

endpoint implemented
tests created
tests pass

Endpoint summary:
Update a list

Endpoint description:
List must belong to current user and request must be authenticated with a MediaWiki session cookie. If the name is changed, the new name must not be in use.
Stability: unstable

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

Associated Action API code
ApiReadingListsUpdate
ApiReadingListsUpdateTest

Parameters:

name	source	required	type	example	default	possible values	description
id	path	yes	integer	42	N/A	N/A
csrf_token	query	yes	string	f63c343876da566045e6b59c4532450559c828d3+\\	N/A	N/A	The CRSF edit token provided by the MediaWiki API

Request Body:
list_write

Error Response

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

Success Response

value	type	description
id	integer	List ID. Deprecated, will be removed. Use the full list object.
list	object: list_read

Response Headers

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

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

Details

	Subject	Repo	Branch	Lines +/-
	REST Handlers for managing reading lists	mediawiki/extensions/ReadingLists	master	+3 K -125

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Stalled	None	T324931 Clean up open RESTBase related tickets
In Progress	None	T262315 <CORE TECHNOLOGY> API Migration & RESTbase Sunset
In Progress	BPirkle	T336693 Re-implement reading lists REST interface outside RESTbase
Resolved	BPirkle	T348491 Reading List REST Interface: create REST endpoints
Resolved	BPirkle	T351152 Reading List REST Interface: PUT lists endpoint

Event Timeline

BPirkle created this task. Nov 14 2023, 1:25 AM

Restricted Application removed a project: Patch-For-Review . · View Herald Transcript Nov 14 2023, 1:25 AM

Restricted Application added a subscriber: Aklapper . · View Herald Transcript

BPirkle mentioned this in T348491: Reading List REST Interface: create REST endpoints . Nov 14 2023, 1:32 AM

BPirkle updated the task description. (Show Details) Nov 14 2023, 2:16 AM

BPirkle renamed this task from Reading List REST Interface: create lists PUT endpoint to Reading List REST Interface: PUT lists endpoint . Nov 14 2023, 2:58 AM

BPirkle updated the task description. (Show Details)

BPirkle updated the task description. (Show Details) Nov 14 2023, 4:19 AM

BPirkle updated the task description. (Show Details) Nov 15 2023, 6:39 PM

BPirkle updated the task description. (Show Details) Dec 14 2023, 9:26 PM

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

gerritbot added a project: Patch-For-Review . Dec 18 2023, 4:53 PM

BPirkle added a project: MW-Interfaces-Team . Jan 29 2024, 7:56 PM

FJoseph-WMF moved this task from Incoming (Needs Triage) to Backlog (Triaged and Ready) on the MW-Interfaces-Team board. Feb 8 2024, 3:55 PM

BPirkle claimed this task. Feb 8 2024, 4:08 PM

BPirkle moved this task from Backlog (Triaged and Ready) to In Progress on the MW-Interfaces-Team board.