diff --git a/api/simplyrets-openapi.yaml b/api/simplyrets-openapi.yaml index 51e7993..2687379 100644 --- a/api/simplyrets-openapi.yaml +++ b/api/simplyrets-openapi.yaml @@ -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" @@ -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" @@ -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 @@ -1993,7 +2016,7 @@ components: foundation: type: string nullable: true - poolFeatures: + pool: type: string nullable: true laundryFeatures: