As a user, I want to be able to browse and search for properties so that I can find properties of interest and their details.
Acceptance Criteria
[ ] The API endpoint is reachable at /api/properties.
[ ] The endpoint accepts GET requests to retrieve property listings.
[ ] The response includes an array of property listings with details such as address, price, and number of bedrooms.
[ ] Users can filter properties by price, property type, and number of bedrooms.
[ ] The response is paginated if there are more than 50 property listings.
[ ] The endpoint provides a status code of 200 upon a successful request.
[ ] The endpoint provides a helpful error message and status code if something goes wrong.
sequenceDiagram
participant Client as User
participant Endpoint as /api/properties
Client->>Endpoint: GET /api/properties{?type, bedrooms, price, page}
Endpoint-->>Client: Returns JSON with property listings
Property Listings API Endpoint Specification
As a user, I want to be able to browse and search for properties so that I can find properties of interest and their details.
Acceptance Criteria
/api/properties
.GET
requests to retrieve property listings.200
upon a successful request.