Page MenuHomePhabricator
Create Task
Maniphest T316077

🥣️ Do not include redundant "type" field in statement data (both requests and responses)
Closed, ResolvedPublic3 Estimated Story Points
Actions

Description

Concerns "endpoints"
GET /entities/items/{item_id}
GET /entities/items/{item_id}/statements
GET /entities/items/{item_id}/statements/{statement_id}
GET /statements/{statement_id}
POST /entities/items/{item_id}/statements
PUT /entities/items/{item_id}/statements/{statement_id}
PUT /statements/{statement_id}
PATCH /entities/items/{item_id}/statements/{statement_id}
PATCH /statements/{statement_id}

Providing "type": "statement" is redundant as "statement" is the only value of the "type" field.

Acceptance criteria

  • Responses containing statement data, i.e. GET /entities/items/{item_id}, GET /entities/items/{item_id}/statements, GET /statements/{statement_id} do not include the discussed "type" field in the provided data. Also applies to success responses to POST/PUT/PATCH requests
  • POST /entities/items/{item_id}/statements requests do not require "type" field to be provided in the request
  • PUT /entities/items/{item_id}/statements/{statement_id} requests do not require "type" field to be provided in the request
  • PUT /statements/{statement_id} requests do not require "type" field to be provided in the request
  • PATCH /entities/items/{item_id}/statements/{statement_id} requests do not require "type" field to be provided in the request
  • PATCH /statements/{statement_id} requests do not require "type" field to be provided in the request

Related Objects
Search...

Event Timeline

WMDE-leszek created this task.Aug 24 2022, 8:21 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptAug 24 2022, 8:21 AM
WMDE-leszek moved this task from Backlog to Next on the Wikibase Product Platform (v1) board.Aug 24 2022, 10:44 AM
WMDE-leszek moved this task from Next to Backlog on the Wikibase Product Platform (v1) board.
WMDE-leszek updated the task description. (Show Details)Aug 24 2022, 11:12 AM
Ollie.Shotton_WMDE subscribed.Aug 24 2022, 2:03 PM

"type" field is also not include in the GET responses providing the statement data, so requiring the field to be provided in the "write" request is not particularly intuitive for the clients

Actually, I just noticed that the "type": field is included in the GET responses!
https://wikidata.beta.wmflabs.org/w/rest.php/wikibase/v0/entities/items/Q11/statements/Q11$2c668af1-4daf-cbe4-3893-2a61574d8afc

Maybe we just talked about removing them?
It will be easy to implement and probably better to remove both at the same time. =)

Ollie.Shotton_WMDE mentioned this in T315164: Wikibase REST API Swagger docs are missing "type: statement" on statements POST endpoint.Aug 24 2022, 2:12 PM
WMDE-leszek changed the task status from Open to Stalled.Aug 24 2022, 7:28 PM

Epic finding. And epic fail on my end. Yeah, I figure I dreamt it had been changed. I sure wanted it but we might have stopped at talking. Apologies. Will adjust the scope of this. Stalling until then

Lydia_Pintscher subscribed.Aug 30 2022, 2:59 PM

See also T315164.

Silvan_WMDE renamed this task from Do not require redundant "type" field in POST and PUT requests creating or replacing a statement to Do not include redundant "type" field in statement data (both requests and responses).Sep 12 2022, 10:25 AM
Silvan_WMDE updated the task description. (Show Details)
WMDE-leszek changed the task status from Stalled to Open.Sep 12 2022, 10:30 AM
WMDE-leszek updated the task description. (Show Details)
WMDE-leszek set the point value for this task to 3.
WMDE-leszek moved this task from Backlog to Next on the Wikibase Product Platform (v1) board.Sep 14 2022, 11:45 AM
WMDE-leszek moved this task from Next to Sprint 13 on the Wikibase Product Platform (v1) board.Sep 14 2022, 12:15 PM
WMDE-leszek edited projects, added Wikibase Product Platform (v1) (Sprint 13); removed Wikibase Product Platform (v1).
Silvan_WMDE subscribed.Sep 15 2022, 10:50 AM

Task breakdown notes:

  • for request input: - @Silvan_WMDE
    • in a separate patch, first rename Wikibase\Repo\RestApi\Domain\Serializers to Wikibase\Repo\RestApi\Domain\Serialization
    • inside that namespace, create a wrapper around existing StatementDeserializer, which adds the 'type' => 'statement' field
    • use newly created wrapped Deserializer in JsonDiffStatementPatcher
    • remove type fields from all statement serializations in unit, e2e and schema tests
  • for response output: - @Ollie.Shotton_WMDE
    • remove the type field from the statement serialisation in Wikibase\Repo\RestApi\Domain\Serializers\StatementSerializer
    • explicitly test absence of the type field in unit tests
Silvan_WMDE renamed this task from Do not include redundant "type" field in statement data (both requests and responses) to 🥣️ Do not include redundant "type" field in statement data (both requests and responses).Sep 15 2022, 10:52 AM
Ollie.Shotton_WMDE claimed this task.Sep 19 2022, 3:31 PM
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, 4:22 PM
Ollie.Shotton_WMDE moved this task from Doing to Product Verification on the Wikibase Product Platform (v1) (Sprint 13) board.
WMDE-leszek updated the task description. (Show Details)Sep 20 2022, 9:04 PM
WMDE-leszek updated the task description. (Show Details)Sep 21 2022, 3:51 PM
WMDE-leszek moved this task from Product Verification to Done on the Wikibase Product Platform (v1) (Sprint 13) board.
WMDE-leszek added a project: Story.Sep 26 2022, 9:25 AM
WMDE-leszek closed this task as Resolved.Oct 14 2022, 12:53 PM
WMDE-leszek claimed this task.
WMDE-leszek closed subtask T317868: 🥣️Add the type field to statement serialization as Resolved.
WMDE-leszek closed subtask T317866: 🥣️ Remove the `type` field from responses that include Statement(s) as Resolved.
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