Skip to content

Commit 2f7b20f

Browse files
committed
Add documentation for style query parameter
1 parent fdd8c30 commit 2f7b20f

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
@@ -502,6 +502,7 @@ paths:
502502
- "$ref": "#/components/parameters/lastId"
503503
- "$ref": "#/components/parameters/vendor"
504504
- "$ref": "#/components/parameters/postalCodes"
505+
- "$ref": "#/components/parameters/style"
505506
- "$ref": "#/components/parameters/features"
506507
- "$ref": "#/components/parameters/exteriorFeatures"
507508
- "$ref": "#/components/parameters/water"
@@ -986,6 +987,7 @@ paths:
986987
- "$ref": "#/components/parameters/lastId"
987988
- "$ref": "#/components/parameters/vendor"
988989
- "$ref": "#/components/parameters/postalCodes"
990+
- "$ref": "#/components/parameters/style"
989991
- "$ref": "#/components/parameters/features"
990992
- "$ref": "#/components/parameters/exteriorFeatures"
991993
- "$ref": "#/components/parameters/water"
@@ -1534,6 +1536,26 @@ components:
15341536
type: array
15351537
items:
15361538
type: string
1539+
style:
1540+
required: false
1541+
in: query
1542+
name: features
1543+
description: >
1544+
Filter the listings by **architectural style**. You can use
1545+
the parameter multiple times to filter by multiple styles. For
1546+
example, to search for `Contemporary` and `Bungalow`:
1547+
1548+
```
1549+
https://simplyrets.com/services?style=Contemporary&style=Bungalow
1550+
```
1551+
1552+
The values available for architectural style is provided by
1553+
the RETS/WebAPI vendor or MLS.
1554+
explode: true
1555+
schema:
1556+
type: array
1557+
items:
1558+
type: string
15371559
features:
15381560
required: false
15391561
in: query

0 commit comments

Comments
 (0)