Page MenuHomePhabricator
Create Task
Maniphest T314503

rollout of the new Wikibase REST API to Wikidata
Closed, ResolvedPublic
Actions

Description

We are developing the new REST API for Wikibase. This ticket tracks what needs to still be done before it can be rolled out on Wikidata in a first version.

Related Objects
Search...

StatusSubtypeAssignedTask
 OpenNoneT335067 Epic: Wikidata Query Service stabilization
 ResolvedLydia_PintscherT314503 rollout of the new Wikibase REST API to Wikidata
 ResolvedWMDE-leszekT320470 "Non-functional" blockers of delivering Wikibase REST API to production Wikidata
 ResolvedWMDE-leszekT314133 Allow recording Wikibase REST API usage for Wikidata monitoring and metrics
 ResolvedWMDE-leszekT301970 Rate limit request to Wikibase REST API
 ResolvedJakob_WMDET318679 [INVESTIGATE] Understand current rate limitting of Mediawiki/Wikibase Action API
 ResolvedJakob_WMDET322746 [INVESTIGATE] Find out if/how current rate limiting applies to REST API
 DeclinedNoneT320478 Error logging in Wikibase REST API
 ResolvedLydia_PintscherT316354 Ensure rate limiting and potentially other harm preventions are in place for the Wikibase REST API
 ResolvedSecurityWMDE-leszekT321318 🤖️ Wikibase REST API ignores `bot` user right, lets anyone mark edits as bot edits
 ResolvedSecurityJakob_WMDET321567 🤖️ Check the 'bot' user privilege in REST API's ItemUpdater
 ResolvedSecurityJakob_WMDET321570 🤖️ Create middleware to check `bot` user right
 ResolvedMuhammad_Yasser_Jazirahly_WMDET326954 Ensure that blocked users/IPs can not make edits
 ResolvedOllie.Shotton_WMDET326093 Confirm Wikibase REST API are considered by the AbuseFilter
 ResolvedSilvan_WMDET326955 Ensure URLs on the spam block list can not be added as values
 ResolvedIfrahkhanyaree_WMDET301859 Provide item data from Wikibase REST API
 ResolvedWMDE-leszekT302055 🟧 Allow requesting subset of fields of item data to be returned by the GET /entities/items/{item_id} REST API
 ResolvedWMDE-leszekT303916 🟧 Handle error when `_fields` parameter includes an invalid value
 ResolvedWMDE-leszekT303919 🟧 Filter item data by input from the _fields request parameter
 ResolvedWMDE-leszekT302060 Allow requesting conditionally only returning data if item changed in GET /entities/items/{item_id}
 ResolvedWMDE-leszekT305021 Add conditional request headers in GET /entities/items/{item_id} to the OpenAPI specification of Wikibase REST API
 InvalidNoneT305055 Handle If-None-Match header in GET /entities/items/{item_id}
 InvalidNoneT305056 Handle If-Modified-Since header in GET /entities/items/{item_id}
 ResolvedWMDE-leszekT302065 🟦 Handle errors in GET /entities/items/{item_id}
 ResolvedWMDE-leszekT303914 🟦 Create 404 error response for non existing item IDs in GET /entities/items/{item_id}
 ResolvedWMDE-leszekT303915 🟦 Create 500 error response on exceptions in GET /entities/items/{item_id}
 ResolvedWMDE-leszekT303918 🟦 Create a 400 HTTP response for invalid item IDs
 ResolvedSilvan_WMDET304094 🟦 Add OpenAPI spec validation tests for error responses
 ResolvedWMDE-leszekT304305 Create an error presenter
 ResolvedSilvan_WMDET321483 Simplify the structure of sitelinks in item data in Wikibase REST API
 InvalidNoneT301860 Enable reading and modifying a statement of item or property using REST API
 InvalidNoneT301861 Authenticate as mediawiki user when making write operations to a stement using REST API
 ResolvedWMDE-leszekT306917 Request data of a single statement of an item
 ResolvedWMDE-leszekT307088 🟦️ Create an initial implementation of GET /entities/items/{item_id}/statements/{statement_id}
 ResolvedWMDE-leszekT308426 🟦️ Return error response in `GetItemStatement` use case when item does not exist
 ResolvedWMDE-leszekT308427 🟦️ Create schema tests for GET /entities/items/{item_id}/statements/{statement_id}
 ResolvedWMDE-leszekT308515 🟦️ Create route handler for GET /entities/items/{item_id}/statements/{statement_id}
 ResolvedWMDE-leszekT308516 🟦️ Add spec for GET /entities/items/{item_id}/statements/{statement_id}
 ResolvedWMDE-leszekT308517 🟦️ Change GetItemStatement to work with a combination of item id + statement id
 ResolvedWMDE-leszekT309020 🟦️ Respond with statement not found if item exists but statement id does not match item id
 ResolvedWMDE-leszekT307087 🟧 Create an initial implementation of GET /statements/{statement_id}
 ResolvedOllie.Shotton_WMDET307223 🟧 Create Use Case and Data Access Service interface for GET /statements/{statement_id}
 ResolvedWMDE-leszekT307225 🟧 Add endpoint section for GET /statements/{statement_id} to the OpenAPI specification
 ResolvedWMDE-leszekT307227 🟧️🟪️ Create a service to retrieve item revision metadata
 ResolvedJakob_WMDET307226 🟧 Respond with 500 error response in case of unexpected errors for GET /statements/{statement_id}
 ResolvedWMDE-leszekT307228 🟧 Schema tests for GET /statements/{statement_id}
 ResolvedWMDE-leszekT307230 🟧 Respond with 404 if the Statement was not found
 ResolvedOllie.Shotton_WMDET307238 🟧 Create GetStatementRouteHandler
ResolvedOllie.Shotton_WMDET307239 🟧 Respond with 400 status code in case of an invalid statement id
 ResolvedJakob_WMDET307031 🟩️ Conditionally request the data of statements of an item
 ResolvedJakob_WMDET309680 🟩️ Add a 304 spec test for statements of an item
 ResolvedWMDE-leszekT307032 🟪️ Conditionally request the data of an item statement
 ResolvedSilvan_WMDET309513 🟪️ Add header parameters to the OpenAPI spec
 ResolvedSilvan_WMDET309514 🟪️ Implement conditional requests for single statement
 ResolvedSilvan_WMDET309515 🟪️ Implement conditional requests for item specific single statement
 ResolvedSilvan_WMDET309516 🟪️ Add 304 spec tests for single statement and item specific single statement
 ResolvedWMDE-leszekT309846 🟦️ Authenticate and authorize as mediawiki user when creating statement using POST /entities/items/{item_id}/statements
 ResolvedJakob_WMDET311154 🟦️ Implement REST API specific PermissionChecker
 ResolvedJakob_WMDET311200 🟦️ Authorization prerequisites
 ResolvedSilvan_WMDET311221 🟦️ Use the newly created `PermissionChecker` in the AddItemStatement use case
 ResolvedNoneT312748 🟦️ Authenticate and authorize as mediawiki user when making DELETE and PUT requests to REST API statement routes
 ResolvedJakob_WMDET314031 🟦️ Check authorization for PUT statement requests
 ResolvedOllie.Shotton_WMDET314033 🟦️ Check authorization for DELETE statement requests
 ResolvedSilvan_WMDET312750 🟪️ Do not use a placeholder edit summary/comment when none provided by the client
 ResolvedWMDE-leszekT312811 🥑️ Provide initial "automated summaries" to statement edits made with Wikibase REST API
 ResolvedOllie.Shotton_WMDET317772 🥑️ Create EditMetadata with summary data in all edit use cases
 ResolvedJakob_WMDET317774 🥑️ Create a `FormatableSummaryAdapter`
 ResolvedOllie.Shotton_WMDET317779 🥑️ Include auto summary data in `EditMetadata`
 ResolvedJakob_WMDET317780 🥑️ Generate auto summaries in `MediaWikiEditEntityFactoryItemUpdater`
 ResolvedJakob_WMDET318312 🥑️ Change EditSummaryFormatter to always produce singular edit summary messages
 ResolvedWMDE-leszekT321459 🌯️ Adjust statement data structure in Wikibase REST API responses and requests
 ResolvedJakob_WMDET322650 🌯️ Create Deserializers to read adjusted statement data structure
 ResolvedOllie.Shotton_WMDET322653 🌯️ Use new Deserializers in Wikibase REST API requests
 ResolvedOllie.Shotton_WMDET322655 🌯️ Cleanup after statement data structure change
 ResolvedOllie.Shotton_WMDET322660 🌯️ Adjust OpenAPI definition for the new statement format
 ResolvedJakob_WMDET322661 🌯️ Create serializers for the new statement format
 ResolvedSilvan_WMDET322737 🌯️ Use new Serializers in Wikibase REST API responses
 ResolvedSilvan_WMDET322831 🌯️ Document differences between the new statement structure and the old one
 ResolvedOllie.Shotton_WMDET324088 💥️ Improve error reporting for invalid statement data in REST API (missing field or invalid value)
 ResolvedOllie.Shotton_WMDET324583 💥️ Consider moving DataValueValidator out of the Validation namespace
 ResolvedJakob_WMDET324592 💥️ Respond with statement-data-invalid-field error for invalid statement fields in PUT and POST endpoints
 ResolvedSilvan_WMDET324839 💥️ Respond with statement-data-missing-field error for missing required statement fields in PUT and POST endpoints
 ResolvedJakob_WMDET325079 💥️ Decide how to deal with missing/invalid field errors in patched statements
 ResolvedJakob_WMDET325176 💥️ Document the decision to change our approach to patching
 ResolvedOllie.Shotton_WMDET325179 💥️ Create a generic JsonPatcher service
ResolvedJakob_WMDET325182 💥️ Adjust the PatchStatement use case to apply patches using a generic JsonPatcher
 ResolvedJakob_WMDET325190 💥️ Handle invalid and missing field errors for the PATCH endpoint
 ResolvedSilvan_WMDET325270 💥️ Update the OpenAPI schema
 ResolvedOllie.Shotton_WMDET320358 🐼️ Improve error reporting for PATCH routes
 InvalidJakob_WMDET320652 🐼️ Fork the swaggest/json-diff library
 ResolvedSilvan_WMDET320658 🐼️ Improve PatchTestOperationFailedException error reports
 ResolvedOllie.Shotton_WMDET320659 🐼️ Improve the InvalidPatchedStatementException thrown in JsonPatcher in case a value does not match the data type of its property
 ResolvedJakob_WMDET320698 🐼️ Describe our feature request in a Github Issue to the json-diff library
 ResolvedJakob_WMDET320699 🐼️ Improve JsonDiffStatementPatcher to provide more detailed error reports
 InvalidSilvan_WMDET320700 🐼️ Handle patch resulting in a disallowed value of a field
 ResolvedOllie.Shotton_WMDET320705 🐼️ Improve JsonPatchValidator to provide more detailed error reports
 InvalidJakob_WMDET320706 🐼️ Handle patch with a missing required field
 ResolvedWMDE-leszekT320708 🐼️ Make a Pull Request to `swaggest/json-diff` with the changes in our fork
 ResolvedOllie.Shotton_WMDET320709 🐼️ Handle exceptions that are not explicitly caught yet
 ResolvedJakob_WMDET320710 🐼️ Add additional `context` field to PATCH errors in the OAS definition
 ResolvedLydia_PintscherT324999 configure Wikibase REST API on Wikidata

Event Timeline

Lydia_Pintscher created this task.Aug 3 2022, 3:43 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptAug 3 2022, 3:43 PM
Lydia_Pintscher edited projects, added Wikibase REST API (archieved); removed Wikibase Product Platform (v1).Aug 3 2022, 3:43 PM
Lydia_Pintscher added a subtask: T312811: 🥑️ Provide initial "automated summaries" to statement edits made with Wikibase REST API.
Addshore subscribed.Aug 3 2022, 4:15 PM
Ollie.Shotton_WMDE subscribed.Aug 5 2022, 8:28 AM
connorshea subscribed.Aug 27 2022, 8:10 PM
Lydia_Pintscher added a subtask: T316354: Ensure rate limiting and potentially other harm preventions are in place for the Wikibase REST API.Oct 12 2022, 5:25 PM
WMDE-leszek closed subtask T312811: 🥑️ Provide initial "automated summaries" to statement edits made with Wikibase REST API as Resolved.Oct 14 2022, 12:57 PM
danshick-wmde subscribed.Oct 17 2022, 9:56 AM
Lydia_Pintscher added a subtask: T323143: Read labels, descriptions, and aliases of an item using Wikibase REST API.Nov 26 2022, 2:00 PM
Lydia_Pintscher added a subtask: T323161: Modify labels, descriptions, aliases of an item using Wikibase REST API.
WMDE-leszek added subtasks: T301859: Provide item data from Wikibase REST API, T301860: Enable reading and modifying a statement of item or property using REST API, T324088: 💥️ Improve error reporting for invalid statement data in REST API (missing field or invalid value), T320358: 🐼️ Improve error reporting for PATCH routes.Dec 7 2022, 1:42 PM
Lydia_Pintscher removed subtasks: T323161: Modify labels, descriptions, aliases of an item using Wikibase REST API, T323143: Read labels, descriptions, and aliases of an item using Wikibase REST API.Dec 12 2022, 5:16 PM

Removed T323161 and T323143 as blockers for the first roll-out. It'd be good to have them but not essential.

Lydia_Pintscher triaged this task as High priority.Dec 12 2022, 5:34 PM
Lydia_Pintscher changed the status of subtask T324999: configure Wikibase REST API on Wikidata from Open to Stalled.Dec 13 2022, 9:41 AM
Jakob_WMDE subscribed.Dec 20 2022, 10:20 AM
Lydia_Pintscher added a comment.Jan 6 2023, 1:58 PM

To be considered as blocker: T326410

Lydia_Pintscher moved this task from Backlog to First release on the Wikibase REST API (archieved) board.Jan 6 2023, 1:59 PM
Michael subscribed.Jan 10 2023, 10:33 AM
Lydia_Pintscher changed the status of subtask T324999: configure Wikibase REST API on Wikidata from Stalled to Open.Jan 17 2023, 4:39 PM
Lydia_Pintscher closed subtask T324999: configure Wikibase REST API on Wikidata as Resolved.Jan 26 2023, 6:50 PM
Lydia_Pintscher closed this task as Resolved.Jan 26 2023, 7:12 PM
Lydia_Pintscher claimed this task.
Lydia_Pintscher closed subtask T316354: Ensure rate limiting and potentially other harm preventions are in place for the Wikibase REST API as Resolved.Feb 3 2023, 11:36 AM
WMDE-leszek closed subtask T324088: 💥️ Improve error reporting for invalid statement data in REST API (missing field or invalid value) as Resolved.Feb 7 2023, 9:42 PM
WMDE-leszek closed subtask T320470: "Non-functional" blockers of delivering Wikibase REST API to production Wikidata as Resolved.Feb 13 2023, 8:28 AM
Lydia_Pintscher added a parent task: T335067: Epic: Wikidata Query Service stabilization.May 19 2023, 10:07 AM
Ifrahkhanyaree_WMDE closed subtask T301859: Provide item data from Wikibase REST API as Resolved.Aug 3 2023, 8:24 AM
Ifrahkhanyaree_WMDE closed subtask T301860: Enable reading and modifying a statement of item or property using REST API as Invalid.Aug 10 2023, 11:35 AM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits