Skip to content

Document pool query parameter / fix field name #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CodyReichert wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document pool query parameter / fix field name #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion api/simplyrets-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,6 +504,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 @@ -988,6 +989,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 @@ -1578,6 +1580,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.pool` is NOT
`false` or `null`.
- `pool=false`: Return listings where `.property.pool` 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 @@ -1993,7 +2016,7 @@ components:
foundation:
type: string
nullable: true
poolFeatures:
pool:
type: string
nullable: true
laundryFeatures:
Expand Down