Skip to content

Commit

Permalink
Document pool query parameter / fix field name
Browse files Browse the repository at this point in the history
  • Loading branch information
CodyReichert committed Jun 2, 2022
1 parent e5cfd8b commit edb0164
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion api/simplyrets-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,7 @@ paths:
- "$ref": "#/components/parameters/postalCodes"
- "$ref": "#/components/parameters/features"
- "$ref": "#/components/parameters/exteriorFeatures"
- "$ref": "#/components/parameters/pool"
- "$ref": "#/components/parameters/water"
- "$ref": "#/components/parameters/neighborhoods"
- "$ref": "#/components/parameters/cities"
Expand Down Expand Up @@ -986,6 +987,7 @@ paths:
- "$ref": "#/components/parameters/postalCodes"
- "$ref": "#/components/parameters/features"
- "$ref": "#/components/parameters/exteriorFeatures"
- "$ref": "#/components/parameters/pool"
- "$ref": "#/components/parameters/water"
- "$ref": "#/components/parameters/neighborhoods"
- "$ref": "#/components/parameters/cities"
Expand Down Expand Up @@ -1576,6 +1578,27 @@ components:
type: array
items:
type: string
pool:
required: false
in: query
name: pool
description: >
Filter listings on pool features (`.property.pool`). There
are multiple ways to use this parameter:
- `pool=true`: Return listings where `.property.water` is NOT
`false` or `null`.
- `pool=false`: Return listings where `.property.water` IS
`false` or `null`.
- `pool=QUERY`: Return listings with a matching
`.property.pool` value. Example: `?pool=Private`.
If this parameter is used multiple times in a single query,
return listings that match any of the provided values.
schema:
type: array
items:
type: string
water:
required: false
in: query
Expand Down Expand Up @@ -1991,7 +2014,7 @@ components:
foundation:
type: string
nullable: true
poolFeatures:
pool:
type: string
nullable: true
laundryFeatures:
Expand Down

0 comments on commit edb0164

Please sign in to comment.