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