Skip to content

fix(stores): align response schemas and parameters with the API #222

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
gaelsimon wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix(stores): align response schemas and parameters with the API #222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e46ee4
fix(stores): align response schemas and parameters with the API
gaelsimon Oct 2, 2026
f598151
fix(stores): type autocomplete predictions as an array
gaelsimon Oct 2, 2026
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
34 changes: 22 additions & 12 deletions dist/documentation/parameters/woosmap_http_parameters_storessearch.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 9 additions & 5 deletions dist/documentation/parameters/woosmap_http_parameters_storessearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,26 @@

<h2 id="optional-parameters">Optional parameters</h2>

- <h3 class="parameter-name" id="encoded_polyline">encoded_polyline</h3>
- <h3 class="parameter-name" id="bounds">bounds</h3>

Find assets nearby an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) and inside a defined radius.
Restricts the results to the Assets inside a bounding box, as `west,south,east,north` in decimal degrees. Takes precedence over `lat`/`lng` and `polyline`.

- <h3 class="parameter-name" id="lat">lat</h3>

Latitude bias for the results. Should be pass with `lng`.
Latitude bias for the results. Must be passed with `lng`.

- <h3 class="parameter-name" id="lng">lng</h3>

Longitude bias for the results. Should be pass with `lat`.
Longitude bias for the results. Must be passed with `lat`.

- <h3 class="parameter-name" id="page">page</h3>

Page number when accessing paginated assets feature collection

- <h3 class="parameter-name" id="polyline">polyline</h3>

Find assets nearby an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) and inside a defined radius. Requires `radius`.

- <h3 class="parameter-name" id="query">query</h3>

Search query combining one or more search clauses. Each search clause is made up of three parts structured as `field` `:` `operator` `value`. , e.g. `name:="My cool store"`
Expand Down Expand Up @@ -80,7 +84,7 @@

- <h3 class="parameter-name" id="radius">radius</h3>

Unit in meters. Used to combine with lat/lng or encoded polyline. To bias the results within a given circular area. 3000 means to search for Assets that are at the most far from 3kms to search area (latlng or polyline).
Unit in meters. Used to combine with lat/lng or polyline. To bias the results within a given circular area. 3000 means to search for Assets that are at the most far from 3kms to search area (latlng or polyline). Without `radius`, `lat`/`lng` only sort the Assets by distance.

- <h3 class="parameter-name" id="stores_by_page">stores_by_page</h3>

Expand Down
12 changes: 7 additions & 5 deletions dist/documentation/parameters/woosmap_http_parameters_storessearchbounds.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions dist/documentation/parameters/woosmap_http_parameters_storessearchbounds.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

- <h3 class="parameter-name" id="lat">lat</h3>

Latitude bias for the results. Should be pass with `lng`.
Latitude bias for the results. Must be passed with `lng`.

- <h3 class="parameter-name" id="lng">lng</h3>

Longitude bias for the results. Should be pass with `lat`.
Longitude bias for the results. Must be passed with `lat`.

- <h3 class="parameter-name" id="query">query</h3>

Expand Down Expand Up @@ -72,7 +72,7 @@

- <h3 class="parameter-name" id="radius">radius</h3>

Unit in meters. Used to combine with lat/lng or encoded polyline. To bias the results within a given circular area. 3000 means to search for Assets that are at the most far from 3kms to search area (latlng or polyline).
Unit in meters. Used to combine with lat/lng or polyline. To bias the results within a given circular area. 3000 means to search for Assets that are at the most far from 3kms to search area (latlng or polyline). Without `radius`, `lat`/`lng` only sort the Assets by distance.


<p style="text-align: right; font-size: smaller;">Generated from the <a data-label="openapi-github" href="https://github.com/woosmap/openapi-specification" title="Woosmap OpenAPI Specification" class="external">OpenAPI specification</a>.
Expand Down
2 changes: 1 addition & 1 deletion dist/documentation/parameters/woosmap_http_parameters_zones.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/documentation/parameters/woosmap_http_parameters_zones.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

- <h3 class="parameter-name" id="limit">limit</h3>

To limit number of zones retrieved (max 50).
To limit number of zones retrieved (Default is 10, max is 50).

- <h3 class="parameter-name" id="offset">offset</h3>

Expand Down
26 changes: 10 additions & 16 deletions dist/documentation/schemas/woosmap_http_schema_assetaddressresponse.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions dist/documentation/schemas/woosmap_http_schema_assetaddressresponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

An object containing the separate components applicable to this address.

| Field | Required | Type | Description |
| :-------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <h4 id="AssetAddressResponse-city" class="add-link schema-object-property-key"><code>city</code></h4> | optional | string | <div class="nonref-property-description"><p>A City where belongs an Asset</p></div> |
| <h4 id="AssetAddressResponse-country_code" class="add-link schema-object-property-key"><code>country_code</code></h4> | optional | string,null | <div class="nonref-property-description"><p>An ISO_3166-1 Country Code where the Asset is located (see <a href="https://en.wikipedia.org/wiki/ISO_3166-1">https://en.wikipedia.org/wiki/ISO_3166-1</a> for full list)</p></div> |
| <h4 id="AssetAddressResponse-lines" class="add-link schema-object-property-key"><code>lines</code></h4> | optional | [AssetAddressLines](#AssetAddressLines "AssetAddressLines") | See [AssetAddressLines](#AssetAddressLines "AssetAddressLines") for more information. |
| <h4 id="AssetAddressResponse-zipcode" class="add-link schema-object-property-key"><code>zipcode</code></h4> | optional | string | <div class="nonref-property-description"><p>An Zipcode / Postal code of an Asset Address</p></div> |
| Field | Required | Type | Description |
| :-------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <h4 id="AssetAddressResponse-city" class="add-link schema-object-property-key"><code>city</code></h4> | **required** | string,null | <div class="nonref-property-description"><p>A City where belongs an Asset</p></div> |
| <h4 id="AssetAddressResponse-country_code" class="add-link schema-object-property-key"><code>country_code</code></h4> | **required** | string,null | <div class="nonref-property-description"><p>An ISO_3166-1 Country Code where the Asset is located (see <a href="https://en.wikipedia.org/wiki/ISO_3166-1">https://en.wikipedia.org/wiki/ISO_3166-1</a> for full list)</p></div> |
| <h4 id="AssetAddressResponse-lines" class="add-link schema-object-property-key"><code>lines</code></h4> | **required** | array,null | <div class="nonref-property-description"><p>An Array for lines of an Asset Address</p></div> |
| <h4 id="AssetAddressResponse-zipcode" class="add-link schema-object-property-key"><code>zipcode</code></h4> | **required** | string,null | <div class="nonref-property-description"><p>An Zipcode / Postal code of an Asset Address</p></div> |

<h4 class="schema-object-example" id="AssetAddressResponse-example">Example</h4>

Expand Down
142 changes: 142 additions & 0 deletions dist/documentation/schemas/woosmap_http_schema_assetautocompleteprediction.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading