Skip to content

Commit 2e6b521

Browse files
committed
Add documentation for style query parameter
1 parent 8b81d51 commit 2e6b521

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

api/simplyrets-openapi.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -500,6 +500,7 @@ paths:
500500
- "$ref": "#/components/parameters/lastId"
501501
- "$ref": "#/components/parameters/vendor"
502502
- "$ref": "#/components/parameters/postalCodes"
503+
- "$ref": "#/components/parameters/style"
503504
- "$ref": "#/components/parameters/features"
504505
- "$ref": "#/components/parameters/exteriorFeatures"
505506
- "$ref": "#/components/parameters/water"
@@ -984,6 +985,7 @@ paths:
984985
- "$ref": "#/components/parameters/lastId"
985986
- "$ref": "#/components/parameters/vendor"
986987
- "$ref": "#/components/parameters/postalCodes"
988+
- "$ref": "#/components/parameters/style"
987989
- "$ref": "#/components/parameters/features"
988990
- "$ref": "#/components/parameters/exteriorFeatures"
989991
- "$ref": "#/components/parameters/water"
@@ -1532,6 +1534,26 @@ components:
15321534
type: array
15331535
items:
15341536
type: string
1537+
style:
1538+
required: false
1539+
in: query
1540+
name: features
1541+
description: >
1542+
Filter the listings by **architectural style**. You can use
1543+
the parameter multiple times to filter by multiple styles. For
1544+
example, to search for `Contemporary` and `Bungalow`:
1545+
1546+
```
1547+
https://simplyrets.com/services?style=Contemporary&style=Bungalow
1548+
```
1549+
1550+
The values available for architectural style is provided by
1551+
the RETS/WebAPI vendor or MLS.
1552+
explode: true
1553+
schema:
1554+
type: array
1555+
items:
1556+
type: string
15351557
features:
15361558
required: false
15371559
in: query

0 commit comments

Comments
 (0)