🩹️ Temporarily remove/disable PATCH routes in Wikibase REST API
Closed, ResolvedPublic3 Estimated Story Points
Actions

Assigned To

Authored By

	WMDE-leszek
	Dec 15 2022, 8:42 AM

Description

Tentatively planned based on the timeline of the security readiness review of the Json Patch PHP library. (T316523)

PATCH method should not be available in the Wikibase REST API.
API specification and the autodocs should not mention unavailable routes.

Likely means moving the PATCH routes to a separate files so that routes.json will only contain routes that can be used in production environments, including WMF production environments. (Wikidata)

Related Objects
Search...

Status	Assigned	Task
Resolved	WMDE-leszek	T325264 🩹️ Temporarily remove/disable PATCH routes in Wikibase REST API
Resolved	• Muhammad_Yasser_Jazirahly_WMDE	T326151 🩹️ Modify README.md file
Resolved	Ollie.Shotton_WMDE	T326153 🩹️ Separate WIP and production ready routes into separate files
Resolved	Silvan_WMDE	T326197 🩹️ Mark PATCH endpoints as [WIP] in OpenAPI docs

Event Timeline

WMDE-leszek created this task.Dec 15 2022, 8:42 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptDec 15 2022, 8:42 AM

WMDE-leszek updated the task description. (Show Details)Dec 15 2022, 8:43 AM

WMDE-leszek updated the task description. (Show Details)Jan 3 2023, 11:00 AM

WMDE-leszek set the point value for this task to 5.Jan 3 2023, 11:05 AM

WMDE-leszek changed the point value for this task from 5 to 3.Jan 3 2023, 11:08 AM

WMDE-leszek updated the task description. (Show Details)Jan 3 2023, 11:12 AM

WMDE-leszek edited projects, added Wikibase Product Platform (v1) (Sprint 20); removed Wikibase Product Platform (v1).

Silvan_WMDE renamed this task from Temporarily remove/disable PATCH routes in Wikibase REST API to 🩹️ Temporarily remove/disable PATCH routes in Wikibase REST API.Jan 3 2023, 2:08 PM

Silvan_WMDE added a project: Story.

Task Breakdown Notes

edit files (@Ollie.Shotton_WMDE creates the task)
- remove PATCH routes from existing rest-api/routes.json file
- add PATCH routes to a new rest-api/routes.dev.json file
- update CI configuration file repo/config/Wikibase.ci.php to take into account the new rest-api/routes.dev.json file
modify README.md to explain rest-api/routes.json and rest-api/routes.dev.json (@Muhammad_Yasser_Jazirahly_WMDE creates task)
- one for production-ready routes
- one for dev routes that are work-in-progress
modify OpenAPI docs (@Silvan_WMDE creates task)
- Add a [WIP] marker to the summary of both PATCH endpoints
- Add 'This endpoint is currently not available on wikidata.org' to the description of both PATCH endpoints