Page MenuHomePhabricator
Create Task
Maniphest T302055

🟧 Allow requesting subset of fields of item data to be returned by the GET /entities/items/{item_id} REST API
Closed, ResolvedPublic5 Estimated Story Points
Actions

Description

As a developer of an application I want to specify which item fields I want to get from the API, so that I do not need to parse through unwanted fields

Allowed values of the _fields parameter:

  • type
  • labels
  • descriptions
  • aliases
  • statements
  • sitelinks

ID is always included in the response.

BDD

WHEN I request GET /entities/items/{item_id}
AND provide the _fields parameter containing allowed field names
THEN I get 200 HTTP response
AND response contains serialization of the item data following the specification, including ID and only the fields I have requested
AND headers of the response include the headers as defined in the specification

WHEN I request GET /entities/items/{item_id}
AND provide the _fields parameter including the value which is not allowed
THEN I get 400 HTTP response
AND it contains a invalid-field code and a message "Not a valid field: {field}"
AND a HTTP header Content-Language set to en

Not included in this story

  • internationalized/translated error message via Accept-Language HTTP header

See Gerrit patch 770445 for the _fields parameter specification

Details

SubjectRepoBranchLines +/-
REST: Use comma separator in _field query parammediawiki/extensions/Wikibasemaster+8 -11
REST: Added specs for _fields param of GET /entities/items/{item_id}mediawiki/extensions/Wikibasemaster+30 -4
Customize query in gerrit

Related Objects
Search...

Event Timeline

WMDE-leszek created this task.Feb 18 2022, 8:58 AM
WMDE-leszek mentioned this in T302054: 🟪 Create a simple implementation of GET /entities/items/{item_id}.Feb 21 2022, 11:16 AM
WMDE-leszek updated the task description. (Show Details)Feb 22 2022, 11:24 AM
WMDE-leszek renamed this task from Allow defining which data fields should be returned by the GET /entities/items/{item_id} REST API to Allow requesting subset of fields of item data to be returned by the GET /entities/items/{item_id} REST API.Feb 22 2022, 11:40 AM
WMDE-leszek updated the task description. (Show Details)Feb 22 2022, 12:56 PM
WMDE-leszek updated the task description. (Show Details)Mar 3 2022, 1:41 PM
WMDE-leszek updated the task description. (Show Details)Mar 3 2022, 2:48 PM
WMDE-leszek updated the task description. (Show Details)Mar 3 2022, 2:50 PM
Silvan_WMDE set the point value for this task to 5.Mar 3 2022, 2:55 PM
gerritbot added a comment.Mar 14 2022, 8:27 AM

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

[mediawiki/extensions/Wikibase@master] REST: Added specs for _fields param of GET /entities/items/{item_id}

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

gerritbot added a project: Patch-For-Review.Mar 14 2022, 8:27 AM
WMDE-leszek moved this task from Backlog to Sprint 2 on the Wikibase Product Platform (v1) board.Mar 14 2022, 1:14 PM
WMDE-leszek edited projects, added Wikibase Product Platform (v1) (Sprint 2); removed Wikibase Product Platform (v1).
Silvan_WMDE updated the task description. (Show Details)Mar 15 2022, 12:22 PM
Silvan_WMDE added subscribers: Ollie.Shotton_WMDE, Silvan_WMDE.EditedMar 15 2022, 3:08 PM

Task Breakdown Notes:

T303919: 🟧 Filter item data by input from the _fields request parameter

  • in the RouteHandler, construct the GetItemRequest object based on both the ItemId and the _fields request parameter
  • in the GetItem use case, filter the itemSerialization based on the _fields from the GetItemRequest
    • create a new GetItemFieldsFilter object that filters the itemSerialization based on requested fields
  • since it is an array, the filtered ItemSerialization can still be passed into GetItemResult

T303916: 🟧 Handle error when `_fields` parameter includes an invalid value

  • use the validator to return a new "Failure" GetItemResult (with isSuccessful() == false)
  • the RouteHandler will create an error response (set http status, code, message) based on the GetItemResult
Ollie.Shotton_WMDE renamed this task from Allow requesting subset of fields of item data to be returned by the GET /entities/items/{item_id} REST API to 🟧 Allow requesting subset of fields of item data to be returned by the GET /entities/items/{item_id} REST API.Mar 16 2022, 8:58 AM
gerritbot added a comment.Mar 25 2022, 4:25 PM

Change 770445 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] REST: Added specs for _fields param of GET /entities/items/{item_id}

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

ReleaseTaggerBot added a project: MW-1.39-notes (1.39.0-wmf.5; 2022-03-28).Mar 25 2022, 5:00 PM
Maintenance_bot removed a project: Patch-For-Review.Mar 25 2022, 5:10 PM
Silvan_WMDE moved this task from To Do to Product Verification on the Wikibase Product Platform (v1) (Sprint 2) board.Mar 29 2022, 6:56 AM
Ollie.Shotton_WMDE claimed this task.Mar 29 2022, 9:53 AM
Ollie.Shotton_WMDE moved this task from Product Verification to Doing on the Wikibase Product Platform (v1) (Sprint 2) board.
gerritbot added a comment.Mar 29 2022, 11:08 AM

Change 774869 had a related patch set uploaded (by Ollie Shotton; author: Ollie Shotton):

[mediawiki/extensions/Wikibase@master] REST: Use comma separator in _field query param

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

gerritbot added a project: Patch-For-Review.Mar 29 2022, 11:08 AM
gerritbot added a comment.Mar 29 2022, 1:52 PM

Change 774869 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] REST: Use comma separator in _field query param

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

ReleaseTaggerBot edited projects, added MW-1.39-notes (1.39.0-wmf.6; 2022-04-04); removed MW-1.39-notes (1.39.0-wmf.5; 2022-03-28).Mar 29 2022, 2:00 PM
Maintenance_bot removed a project: Patch-For-Review.Mar 29 2022, 2:10 PM
Ollie.Shotton_WMDE removed Ollie.Shotton_WMDE as the assignee of this task.Mar 29 2022, 2:43 PM
Ollie.Shotton_WMDE moved this task from Doing to Peer Review on the Wikibase Product Platform (v1) (Sprint 2) board.
Ollie.Shotton_WMDE moved this task from Peer Review to Product Verification on the Wikibase Product Platform (v1) (Sprint 2) board.
WMDE-leszek added a comment.Mar 30 2022, 8:57 AM

Looks good, thanks all!

WMDE-leszek moved this task from Product Verification to Done on the Wikibase Product Platform (v1) (Sprint 2) board.Mar 30 2022, 8:58 AM
WMDE-leszek closed this task as Resolved.Mar 31 2022, 12:38 PM
WMDE-leszek claimed this task.
WMDE-leszek closed subtask T303919: 🟧 Filter item data by input from the _fields request parameter as Resolved.
WMDE-leszek closed subtask T303916: 🟧 Handle error when `_fields` parameter includes an invalid value 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