Description:
As tool builder I want to read data of all sitelinks of an item so that I can use them in my tool.
Acceptance criteria:
- Following endpoint is developed:
GET /entities/items/{item_id}/sitelinks
- Following error cases have to be considered:
| HTTP response code | response payload | |
|---|---|---|
| Item does not exist | 404 | "code": "item-not-found" "message": "Could not find an item with the ID: {item_id}" |
| Invalid item ID | 400 | "code": "invalid-item-id" "message": "Not a valid item ID: <ITEM_ID>" |
Notes:
- Handle HTTP conditional request headers as in GET /entities/items/{item_id}/statements
- Handle user authentication/authorization like in GET /entities/items/{item_id}/statements
- Items that have been redirected should be handled like GET /entities/items/labels
- 200 response format should be the same as the contents of the sitelinks field in a GET /entities/items/{item_id} response
Possibly relevant pointers:
- Suggestion in 2020 Wikibase REST API proposal: https://wmde.github.io/wikibase-rest-api-proposal/
- How Wikibase Action API handles this: https://www.wikidata.org/w/api.php?action=wbgetentities&ids=Q42&props=sitelinks
Task breakdown notes
- add GET /entities/items/{item_id}/sitelinks to OAS
- create SiteLinksRetriever interface and implementation
- using SiteLinkLookup::getSiteLinksForItem() and SiteLinksReadModelConverter
- happy path
- validation
- item existence check and redirect handling
- middlewares + e2e tests and RouteHandlersTest
- spec tests
- mark ready for prod