🔍 Provide the data for statements of an item that are using the given property
Closed, ResolvedPublic5 Estimated Story Points
Actions

Assigned To

Authored By

	WMDE-leszek
	May 23 2022, 11:30 AM

Description

As a tool developer I want to get all statements of an item that are using a given property so that I can show them in my tool.

Initial implementation suggestion:
Add path parameter that allows "filtering" statements to only include ones with a given property, i.e. GET /entities/items/{item_id}/statements?property={property_id}

Notes:

response structure will be a single-key map {property_id} -> statements

Related Objects
Search...

Status	Assigned	Task
Invalid	None	T324668 Expand the reading item data statement functionality in Wikibase REST API
Resolved	WMDE-leszek	T309021 🔍 Provide the data for statements of an item that are using the given property
Resolved	Jakob_WMDE	T329632 🔍 Update the GetItemStatements Use Case (happy path)
Resolved	Jakob_WMDE	T329634 🔍 Validation and error handling
Resolved	Silvan_WMDE	T329641 🔍 Add the new query parameter 'property' to the OpenAPI definition
Resolved	Jakob_WMDE	T329707 🔍 Update GetItemStatementsRouteHandler for the "property" query param

Event Timeline

WMDE-leszek created this task.May 23 2022, 11:30 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMay 23 2022, 11:30 AM

WMDE-leszek added a parent task: T324668: Expand the reading item data statement functionality in Wikibase REST API.Dec 7 2022, 1:36 PM

WMDE-leszek moved this task from Backlog to Next on the Wikibase Product Platform (v1) board.Feb 14 2023, 6:20 AM

WMDE-leszek updated the task description. (Show Details)Feb 14 2023, 6:25 AM

Outstanding questions (for @WMDE-leszek) :

Should we return an empty map ({}) if no statements exists with the provided property id?

Ollie.Shotton_WMDE set the point value for this task to 5.Feb 14 2023, 11:06 AM

Ollie.Shotton_WMDE moved this task from Next to Sprint 23 on the Wikibase Product Platform (v1) board.Feb 14 2023, 11:17 AM

Ollie.Shotton_WMDE edited projects, added Wikibase Product Platform (v1) (Sprint 23); removed Wikibase Product Platform (v1).

Ollie.Shotton_WMDE renamed this task from Provide the data fo statements of an item that are using the given property to Provide the data for statements of an item that are using the given property.Feb 14 2023, 11:19 AM

In T309021#8613899, @Ollie.Shotton_WMDE wrote:

Outstanding questions (for @WMDE-leszek) :

Should we return an empty map ({}) if no statements exists with the provided property id?

seems like the best solution, please do.
Alternatives considered and dismissed: responding with HTTP 404 or 204 codes.

Task breakdown:

T329641: 🔍 Add the new query parameter 'property' to the OpenAPI definition
T329632: 🔍 Update the GetItemStatements Use Case (happy path)
- Use case request class gets a new optional string $propertyId member
- Convert string property id into a PropertyId object
- Add an optional propertyId parameter to the ItemStatementsRetriever::getStatements() method and, if provided, only return statements with that property id
T329632: 🔍 Update the GetItemStatements Use Case (happy path)
- Configure the new optional query parameter on the handler
- Pass the new parameter into the use case request object
- Add/update e2e tests
T329634: 🔍 Validation and error handling
- Update use case validator to validate the property id via a new PropertyIdValidator class
- Add a new error code to status code mapping to ErrorResponseToHttpStatus
- Add/update e2e tests

Outstanding questions for PM (@WMDE-leszek):

What error code and message should be returned for an invalid property id? And should there be a context object?

Ollie.Shotton_WMDE renamed this task from Provide the data for statements of an item that are using the given property to 🔍 Provide the data for statements of an item that are using the given property.Feb 14 2023, 2:54 PM

In T309021#8614521, @Ollie.Shotton_WMDE wrote:

Outstanding questions for PM (@WMDE-leszek):

What error code and message should be returned for an invalid property id? And should there be a context object?

When the property ID is invalid: (e.g. Pabc, Q123) { "code": "invalid-property-id", "message": "Not a valid property ID: {input}" }. No context field please.
When the property ID is valid "syntactically" but does not exist: treat it like the situation of item not having statements using the given property, i.e. 200 "P123": {}"

WMDE-leszek mentioned this in T329092: Allow getting statements based on the Property ID used.Feb 15 2023, 9:21 PM

tfmorris subscribed.Feb 15 2023, 9:31 PM

Bean49 subscribed.Feb 15 2023, 10:56 PM