Page MenuHomePhabricator

⛵️ Get data of descriptions of a property
Closed, ResolvedPublic5 Estimated Story Points

Description

Description:
As tool builder I want to read data of descriptions on a property so that I can use them in my tool.

AC:

  • Following endpoint is developed:

GET /entities/properties/{property_id}/descriptions

  • Following error cases have to be considered:
HTTP response coderesponse payload
Property does not exist404"code": "property-not-found"
"message": "Could not find a property with the ID: {property_id}"
Invalid property ID400"code": "invalid-property-id"
"message": "Not a valid property ID: <PROPERTY_ID>"
"context": { "property-id": "<PROPERTY_ID>" }

Notes:

  • Handle HTTP conditional request headers as in GET /entities/items/{item_id}/descriptions
  • Handle user authentication/authorization like in GET /entities/items/{item_id}/descriptions

Possibly relevant pointers:

Event Timeline

Notes from task breakdown:
Subtasks:

  • Add GET property descriptions route to OAS doc
  • Create a PropertyDescriptionsRetriever interface
  • Create GetPropertyDescriptions happy path
  • Add ETag and Last-modified headers; also check whether the Property exists
  • Add the usual middlewares
  • Add property ID validation to GetPropertyDescriptions
  • Create openapi-validation tests for GetPropertyDescriptions
  • Mark "Get Property descriptions" as production ready
Silvan_WMDE renamed this task from Get data of descriptions of a property to ⛵️ Get data of descriptions of a property.Sep 19 2023, 1:09 PM
Silvan_WMDE claimed this task.