Page MenuHomePhabricator
Create Task
Maniphest T312811

đŸĨ‘ī¸ Provide initial "automated summaries" to statement edits made with Wikibase REST API
Closed, ResolvedPublic8 Estimated Story Points
Actions

Description

As a Wikidata patroller I want statement edits made with REST API to have an "automated summary" provided so that I can have a quick overview on what the edit has been about.
As a Wikidata patroller I want statement edits made with REST API to have an "automated summary" provided so that I can consider edits made with the REST API in my regular workflows.

For the time being (July 2022), with no better alternative present, Wikibase REST API will mimic the "automated summaries" of Wikibase's Action API and other logic.

The following "automated summary" templates are suggested to use with edits made with specific REST methods and paths

POST /entities/items/{item_id}/statements/* wbsetclaim-create:1||1 */ [[Property:P123]]: VALUE_FORMATTED
PUT /entities/items/{item_id}/statements/{statement_id}
PUT /statements/{statement_id}		/* wbsetclaim-update:1||1 */ [[Property:P123]]: VALUE_FORMATTED
DELETE /entities/items/{item_id}/statements/{statement_id}
DELETE /statements/{statement_id}		/* wbremoveclaims-remove:1| */ [[Property:P123]]: VALUE_FORMATTED
PATCH /entities/items/{item_id}/statements/{statement_id}
PATCH /statements/{statement_id}		/* wbsetclaim-update:1||1 */ [[Property:P123]]: VALUE_FORMATTED

Notes to the above:

  • [[Property:P123]] should be replaced by the wiki-specific wikitext representation of the link to the property used in the statement (P123 in the examples)
  • VALUE_FORMATTED should be replaced by the wiki-specific wikitext representation of the value of the statement ("main snak")

No "smarter" automated summaries are intended to be provided for the time being.

Note: The MediaWiki framework will automatically truncate comments longer than the allowed limit of characters, so there is no need to change the comment length validation for this story.

Related Objects
Search...

StatusSubtypeAssignedTask
 OpenNoneT335067 Epic: Wikidata Query Service stabilization
 ResolvedLydia_PintscherT314503 rollout of the new Wikibase REST API to Wikidata
 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

Event Timeline

WMDE-leszek created this task.Jul 11 2022, 8:58 PM
WMDE-leszek moved this task from Backlog to Next on the Wikibase Product Platform (v1) board.Jul 15 2022, 7:02 PM
WMDE-leszek updated the task description. (Show Details)Jul 15 2022, 7:21 PM
WMDE-leszek added a subscriber: Lydia_Pintscher.

changed "modules" and "actions" to match existing i18n keys per suggestion from @Lydia_Pintscher

Silvan_WMDE updated the task description. (Show Details)Jul 25 2022, 10:20 AM
WMDE-leszek set the point value for this task to 8.Jul 25 2022, 10:38 AM
Lydia_Pintscher added a parent task: T314503: rollout of the new Wikibase REST API to Wikidata.Aug 3 2022, 3:44 PM
WMDE-leszek updated the task description. (Show Details)Sep 14 2022, 12:11 PM
WMDE-leszek moved this task from Next to Sprint 13 on the Wikibase Product Platform (v1) board.
WMDE-leszek edited projects, added Wikibase Product Platform (v1) (Sprint 13); removed Wikibase Product Platform (v1).
Jakob_WMDE added subscribers: Ollie.Shotton_WMDE, Silvan_WMDE, Jakob_WMDE.Sep 14 2022, 2:45 PM

Notes from task breakdown:

  • include auto summary data in EditMetadata - @Jakob_WMDE
    • change EditMetadata
      • remove the getComment method
      • add a getSummary method which returns an EditSummary object
    • create an EditSummary interface and implement it in a StatementEditSummary class
      • EditSummary has two methods public function getUserComment(): ?string and public function getEditAction(): string and constants for all kinds of edit actions
      • StatementEditSummary has factory methods for all actions, and a public function getStatement(): Statement method
  • change all use cases to create the EditMetadata with the corresponding StatementEditSummary using the factory methods - @Silvan_WMDE
    • in MediaWikiEditEntityFactoryItemUpdater use the user comment from the EditSummary object
  • create a FormatableSummaryAdapter which creates a FormatableSummary from our EditSummary - @Ollie.Shotton_WMDE
    • maps the EditSummary::getEditAction to the FormatableSummary with the module name (wbsetclaim or wbremoveclaims), action name (create, update, remove)
    • gets the property id and mainsnak from StatementEditSummary::getStatement
  • change MediaWikiEditEntityFactoryItemUpdater - @Jakob_WMDE
    • inject the FormatableSummaryAdapter and SummaryFormatter
    • in the call $editEntity->attemptSave() do $this->summaryFormatter->format( $this->mediaWikiSummaryAdapter->newFromSummary( $editMetadata->getSummary() ) ),
    • e2e tests
Jakob_WMDE renamed this task from Provide initial "automated summaries" to statement edits made with Wikibase REST API to đŸĨ‘ī¸ Provide initial "automated summaries" to statement edits made with Wikibase REST API.Sep 14 2022, 2:46 PM
Ollie.Shotton_WMDE claimed this task.Sep 19 2022, 10:41 AM
Ollie.Shotton_WMDE moved this task from To Do to Doing on the Wikibase Product Platform (v1) (Sprint 13) board.
Ollie.Shotton_WMDE removed Ollie.Shotton_WMDE as the assignee of this task.Sep 19 2022, 3:29 PM
Ollie.Shotton_WMDE moved this task from Doing to Product Verification on the Wikibase Product Platform (v1) (Sprint 13) board.
gerritbot added a comment.Sep 21 2022, 8:38 AM

Change 833728 had a related patch set uploaded (by WMDE-leszek; author: WMDE-leszek):

[mediawiki/extensions/Wikibase@master] REST DNM exploration change for T312811

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

gerritbot added a project: Patch-For-Review.Sep 21 2022, 8:38 AM
WMDE-leszek updated the task description. (Show Details)Sep 21 2022, 2:54 PM
WMDE-leszek added a comment.Sep 21 2022, 2:56 PM

Due to @WMDE-leszek's failure the incorrect "autocomment" has been requested in the original description, leading to incorrect plural form message to be used in create/update summaries (accidentally working correctly for the removal summary), i.e. "Create claims", "Updated claims" where it should only mention a single "claim".
Description adjusted to cover the correct "pseudo code" to use.

WMDE-leszek moved this task from Product Verification to To Do on the Wikibase Product Platform (v1) (Sprint 13) board.Sep 21 2022, 2:56 PM
WMDE-leszek updated the task description. (Show Details)Sep 22 2022, 11:20 AM
WMDE-leszek edited projects, added Wikibase Product Platform (v1) (Sprint 14); removed Wikibase Product Platform (v1) (Sprint 13).Sep 27 2022, 9:33 AM
Ollie.Shotton_WMDE moved this task from To Do to Product Verification on the Wikibase Product Platform (v1) (Sprint 14) board.Sep 27 2022, 10:38 AM
WMDE-leszek added a comment.Oct 4 2022, 7:44 AM

Looks good, thank you

WMDE-leszek moved this task from Product Verification to Done on the Wikibase Product Platform (v1) (Sprint 14) board.Oct 4 2022, 7:44 AM
WMDE-leszek closed subtask T318312: đŸĨ‘ī¸ Change EditSummaryFormatter to always produce singular edit summary messages as Resolved.Oct 14 2022, 12:53 PM
WMDE-leszek closed subtask T317780: đŸĨ‘ī¸ Generate auto summaries in `MediaWikiEditEntityFactoryItemUpdater` as Resolved.
WMDE-leszek closed subtask T317779: đŸĨ‘ī¸ Include auto summary data in `EditMetadata` as Resolved.
WMDE-leszek closed subtask T317774: đŸĨ‘ī¸ Create a `FormatableSummaryAdapter` as Resolved.
WMDE-leszek closed subtask T317772: đŸĨ‘ī¸ Create EditMetadata with summary data in all edit use cases as Resolved.
WMDE-leszek closed this task as Resolved.Oct 14 2022, 12:57 PM
WMDE-leszek claimed this task.
gerritbot added a comment.Apr 13 2023, 4:26 PM

Change 833728 abandoned by WMDE-leszek:

[mediawiki/extensions/Wikibase@master] REST DNM exploration change for T312811

Reason:

was an exploration code only

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

Maintenance_bot removed a project: Patch-For-Review.Apr 13 2023, 4:29 PM
WMDE-leszek mentioned this in T342238: 🏴‍☠ī¸ Modify data of a statement on a property.Jul 19 2023, 12:23 PM
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