statements
Closed, ResolvedPublic8 Estimated Story Points
Actions

Assigned To

Authored By

	WMDE-leszek
	Apr 12 2022, 9:22 PM

Description

As an developer I want to get all statements of an item so I can show the data in my app

return a json representation of the statements as returned by the /entities/items/<item_id> endpoint
error handling:
- 400 - invalid item ID
- 404 - item not found
- 500 - unexpected

Link to Proposed API spec

Not included in this story

If-None-Match/If-Modified-Since conditional headers T307031: 🟩️ Conditionally request the data of statements of an item
"pagination" of statements. Always return up to 50 statements: T306664: Paginate statements in GET /entities/items/{item_id}/statements
filtering statement data "fields" to be included in the response T307033: Filter elements of a statement structure to be returned by GET /entities/items/{item_id}/statements

Related Objects
Search...

Status	Assigned	Task
Open	None	T344228 Functionality for REST API v1
Resolved	WMDE-leszek	T305988 🟪️ Create an initial implementation of GET /entities/items/{item_id}/statements
Resolved	WMDE-leszek	T307200 🟪️ Schema tests for GET /entities/items/{item_id}/statements
Resolved	Jakob_WMDE	T307201 🟪️ Handle Item redirects in GET /entities/items/{item_id}/statements
Resolved	WMDE-leszek	T307210 🟪️ Respond with 404 if the Item was not found
Resolved	WMDE-leszek	T307227 🟧️🟪️ Create a service to retrieve item revision metadata
Resolved	WMDE-leszek	T307231 🟪 Create Use Case and Data Access Service for GET /entities/items/{item_id}/statements
Resolved	WMDE-leszek	T307232 🟪 Respond with 500 error response in case of unexpected errors for GET /entities/items/{item_id}/statements
Resolved	WMDE-leszek	T307234 🟪️ Create GetItemStatementsRouteHandler
Resolved	WMDE-leszek	T307235 🟪️ Add an endpoint section for GET /entities/items/{item_id}/statements to the OpenAPI specification
Resolved	WMDE-leszek	T307237 🟪 Respond with 400 status in case of an invalid item_id

Event Timeline

WMDE-leszek created this task.Apr 12 2022, 9:22 PM

WMDE-leszek updated the task description. (Show Details)Apr 12 2022, 9:28 PM

WMDE-leszek updated the task description. (Show Details)Apr 12 2022, 9:42 PM

WMDE-leszek mentioned this in T306664: Paginate statements in GET /entities/items/{item_id}/statements.Apr 21 2022, 9:00 PM

WMDE-leszek updated the task description. (Show Details)Apr 27 2022, 7:49 AM

Silvan_WMDE updated the task description. (Show Details)Apr 27 2022, 1:38 PM

WMDE-leszek updated the task description. (Show Details)Apr 27 2022, 7:17 PM

Jakob_WMDE set the point value for this task to 8.Apr 28 2022, 10:40 AM

WMDE-leszek moved this task from Backlog to Next on the Wikibase Product Platform (v1) board.Apr 28 2022, 10:48 AM

WMDE-leszek moved this task from Next to Sprint 5 on the Wikibase Product Platform (v1) board.Apr 28 2022, 10:56 AM

WMDE-leszek edited projects, added Wikibase Product Platform (v1) (Sprint 5); removed Wikibase Product Platform (v1).

Task breakdown notes:

copy relevant parts from the proposed OpenAPI spec to ours: T307235: 🟪️ Add an endpoint section for GET /entities/items/{item_id}/statements to the OpenAPI specification
create or reuse a service to retrieve item revision metadata (revision id and last modified timestamp): T307227: 🟧️🟪️ Create a service to retrieve item revision metadata
return json with map of statements for existing Item
- T307231: 🟪 Create Use Case and Data Access Service for GET /entities/items/{item_id}/statements
  - new use case GetItemStatements
  - new data access service ItemStatementsRetriever which returns a list of statements or null
- T307234: 🟪️ Create GetItemStatementsRouteHandler
  - implement the retriever
  - new GetItemStatementsRouteHandler (create body and headers)
- don't forget the schema tests T307200: 🟪️ Schema tests for GET /entities/items/{item_id}/statements
handle item redirects: T307201: 🟪️ Handle Item redirects in GET /entities/items/{item_id}/statements
handle errors
- 400 in case of an invalid item ID: T307237: 🟪 Respond with 400 status in case of an invalid item_id
- 404 in case of "item does not exist": T307210: 🟪️ Respond with 404 if the Item was not found
- 500 in case of unexpected errors T307232: 🟪 Respond with 500 error response in case of unexpected errors for GET /entities/items/{item_id}/statements

Jakob_WMDE renamed this task from Create an initial implementation of GET /entities/items/{item_id}/statements to 🟪️ Create an initial implementation of GET /entities/items/{item_id}/statements.Apr 29 2022, 2:35 PM

Ollie.Shotton_WMDE added a subtask: T307227: 🟧️🟪️ Create a service to retrieve item revision metadata.Apr 29 2022, 2:55 PM

Change 788368 had a related patch set uploaded (by Silvan Heintze; author: Silvan Heintze):

[mediawiki/extensions/Wikibase@master] REST: Add new statements section to OpenAPI spec

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

gerritbot added a project: Patch-For-Review.May 2 2022, 3:33 PM