offset
diff --git a/dist/documentation/parameters/woosmap_http_parameters_zones.md b/dist/documentation/parameters/woosmap_http_parameters_zones.md
index 160555fe..c3f142c0 100644
--- a/dist/documentation/parameters/woosmap_http_parameters_zones.md
+++ b/dist/documentation/parameters/woosmap_http_parameters_zones.md
@@ -6,7 +6,7 @@
- limit
- To limit number of zones retrieved (max 50).
+ To limit number of zones retrieved (Default is 10, max is 50).
- offset
diff --git a/dist/documentation/schemas/woosmap_http_schema_assetaddressresponse.html b/dist/documentation/schemas/woosmap_http_schema_assetaddressresponse.html
index 04b941a5..de5df628 100644
--- a/dist/documentation/schemas/woosmap_http_schema_assetaddressresponse.html
+++ b/dist/documentation/schemas/woosmap_http_schema_assetaddressresponse.html
@@ -21,8 +21,8 @@ AssetAddressResponse
city
- optional |
- string |
+ required |
+ string,null |
A City where belongs an Asset
@@ -38,7 +38,7 @@ AssetAddressResponse
country_code
|
- optional |
+ required |
string,null |
@@ -63,18 +63,12 @@ AssetAddressResponse
lines
|
- optional |
-
- AssetAddressLines
- |
+ required |
+ array,null |
- See
- AssetAddressLines
- for more information.
+
+ An Array for lines of an Asset Address
+ |
@@ -86,8 +80,8 @@ AssetAddressResponse
zipcode
- optional |
- string |
+ required |
+ string,null |
An Zipcode / Postal code of an Asset Address
diff --git a/dist/documentation/schemas/woosmap_http_schema_assetaddressresponse.md b/dist/documentation/schemas/woosmap_http_schema_assetaddressresponse.md
index f79ad0de..0da0a34e 100644
--- a/dist/documentation/schemas/woosmap_http_schema_assetaddressresponse.md
+++ b/dist/documentation/schemas/woosmap_http_schema_assetaddressresponse.md
@@ -4,12 +4,12 @@
An object containing the separate components applicable to this address.
-| Field | Required | Type | Description |
-| :-------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| city
| optional | string | A City where belongs an Asset |
-| country_code
| optional | string,null | |
-| lines
| optional | [AssetAddressLines](#AssetAddressLines "AssetAddressLines") | See [AssetAddressLines](#AssetAddressLines "AssetAddressLines") for more information. |
-| zipcode
| optional | string | An Zipcode / Postal code of an Asset Address |
+| Field | Required | Type | Description |
+| :-------------------------------------------------------------------------------------------------------------------- | ------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| city
| **required** | string,null | A City where belongs an Asset |
+| country_code
| **required** | string,null | |
+| lines
| **required** | array,null | An Array for lines of an Asset Address |
+| zipcode
| **required** | string,null | An Zipcode / Postal code of an Asset Address |
Example
diff --git a/dist/documentation/schemas/woosmap_http_schema_assetautocompleteprediction.html b/dist/documentation/schemas/woosmap_http_schema_assetautocompleteprediction.html
new file mode 100644
index 00000000..991dece4
--- /dev/null
+++ b/dist/documentation/schemas/woosmap_http_schema_assetautocompleteprediction.html
@@ -0,0 +1,142 @@
+
+
+
+ AssetAutocompletePrediction
+
+ An Asset matching the autocomplete query.
+
+
+
+ | Field |
+ Required |
+ Type |
+ Description |
+
+
+
+
+
+
+ highlighted
+
+ |
+ required |
+ string |
+
+
+
+ an HTML formatted string with, if it exists, the matched
+ substring(s) in bold font.
+
+ |
+
+
+
+
+ matched_substrings
+
+ |
+ required |
+
+ Array<MatchedSubstring>
+ |
+
+ See
+ MatchedSubstring
+ for more information.
+ |
+
+
+
+
+ name
+
+ |
+ required |
+ string |
+
+
+
+ The name property of each prediction will be filled
+ with the localized name of your asset in the
+ language you provided in your query if it exists, or
+ else the default name property.
+
+ |
+
+
+
+
+ store_id
+
+ |
+ required |
+ AssetId |
+
+ See AssetId for more information.
+ |
+
+
+
+
+ types
+
+ |
+ required |
+ AssetTypes |
+
+ See AssetTypes for more
+ information.
+ |
+
+
+
+
+ Generated from the
+ OpenAPI specification.
+ ✎ Edit
+ bug_report Report bug
+
+
+
diff --git a/dist/documentation/schemas/woosmap_http_schema_assetautocompleteprediction.md b/dist/documentation/schemas/woosmap_http_schema_assetautocompleteprediction.md
new file mode 100644
index 00000000..84edd0ba
--- /dev/null
+++ b/dist/documentation/schemas/woosmap_http_schema_assetautocompleteprediction.md
@@ -0,0 +1,20 @@
+
+
+ AssetAutocompletePrediction
+
+An Asset matching the autocomplete query.
+
+| Field | Required | Type | Description |
+| :--------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| highlighted
| **required** | string | an HTML formatted string with, if it exists, the matched substring(s) in bold font. |
+| matched_substrings
| **required** | Array\<[MatchedSubstring](#MatchedSubstring "MatchedSubstring")\> | See [MatchedSubstring](#MatchedSubstring "MatchedSubstring") for more information. |
+| name
| **required** | string | The name property of each prediction will be filled with the localized name of your asset in the language you provided in your query if it exists, or else the default name property. |
+| store_id
| **required** | [AssetId](#AssetId "AssetId") | See [AssetId](#AssetId "AssetId") for more information. |
+| types
| **required** | [AssetTypes](#AssetTypes "AssetTypes") | See [AssetTypes](#AssetTypes "AssetTypes") for more information. |
+
+ Generated from the OpenAPI specification.
+✎ Edit
+bug_report Report bug
+
+
+
diff --git a/dist/documentation/schemas/woosmap_http_schema_assetautocompleteresponse.html b/dist/documentation/schemas/woosmap_http_schema_assetautocompleteresponse.html
index 73ea2447..a980298a 100644
--- a/dist/documentation/schemas/woosmap_http_schema_assetautocompleteresponse.html
+++ b/dist/documentation/schemas/woosmap_http_schema_assetautocompleteresponse.html
@@ -23,15 +23,28 @@
predictions
|
- optional |
- |
+ required |
- |
+
+
A list of predictions based on similarity in all the
localizedNames passed in query (or similarity to
store_name if no localizedNames exist)
+
+ See
+ AssetAutocompletePrediction
+ for more information.
+
|
diff --git a/dist/documentation/schemas/woosmap_http_schema_assetautocompleteresponse.md b/dist/documentation/schemas/woosmap_http_schema_assetautocompleteresponse.md
index 6d4ba40a..d02359bc 100644
--- a/dist/documentation/schemas/woosmap_http_schema_assetautocompleteresponse.md
+++ b/dist/documentation/schemas/woosmap_http_schema_assetautocompleteresponse.md
@@ -4,9 +4,9 @@
Asset Autocomplete Response with highlighted results on asset name.
-| Field | Required | Type | Description |
-| :----------------------------------------------------------------------------------------------------------------------- | -------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| predictions
| optional | | A list of predictions based on similarity in all the localizedNames passed in query (or similarity to store_name if no localizedNames exist)
predictions
| **required** | Array\<[AssetAutocompletePrediction](#AssetAutocompletePrediction "AssetAutocompletePrediction")\> | A list of predictions based on similarity in all the localizedNames passed in query (or similarity to store_name if no localizedNames exist)
See AssetAutocompletePrediction for more information.
Example
diff --git a/dist/documentation/schemas/woosmap_http_schema_assetfeaturecollectionresponse.html b/dist/documentation/schemas/woosmap_http_schema_assetfeaturecollectionresponse.html
index eb9b8069..ed985f58 100644
--- a/dist/documentation/schemas/woosmap_http_schema_assetfeaturecollectionresponse.html
+++ b/dist/documentation/schemas/woosmap_http_schema_assetfeaturecollectionresponse.html
@@ -26,7 +26,7 @@
features
- optional |
+ required |
Array<
pagination
|
- optional |
+ required |
Pagination |
See Pagination for more
@@ -69,7 +69,7 @@
type
|
- optional |
+ required |
string |
diff --git a/dist/documentation/schemas/woosmap_http_schema_assetfeaturecollectionresponse.md b/dist/documentation/schemas/woosmap_http_schema_assetfeaturecollectionresponse.md
index bc1f558a..31136914 100644
--- a/dist/documentation/schemas/woosmap_http_schema_assetfeaturecollectionresponse.md
+++ b/dist/documentation/schemas/woosmap_http_schema_assetfeaturecollectionresponse.md
@@ -4,11 +4,11 @@
Assets Collection Response as a GeoJSon FeatureCollection with Asset properties
-| Field | Required | Type | Description |
-| :-------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| features
| optional | Array\<[AssetFeatureResponse](#AssetFeatureResponse "AssetFeatureResponse")\> | |
-| | optional | [Pagination](#Pagination "Pagination") | See [Pagination](#Pagination "Pagination") for more information. |
-| type
| optional | string | the Geojson Type (only 'FeatureCollection') The allowed values include: and `FeatureCollection` |
+| Field | Required | Type | Description |
+| :-------------------------------------------------------------------------------------------------------------------------- | ------------ | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| features
| **required** | Array\<[AssetFeatureResponse](#AssetFeatureResponse "AssetFeatureResponse")\> | |
+| | **required** | [Pagination](#Pagination "Pagination") | See [Pagination](#Pagination "Pagination") for more information. |
+| type
| **required** | string | the Geojson Type (only 'FeatureCollection') The allowed values include: and `FeatureCollection` |
Example
diff --git a/dist/documentation/schemas/woosmap_http_schema_assetfeatureresponse.html b/dist/documentation/schemas/woosmap_http_schema_assetfeatureresponse.html
index 0e897088..6aa72481 100644
--- a/dist/documentation/schemas/woosmap_http_schema_assetfeatureresponse.html
+++ b/dist/documentation/schemas/woosmap_http_schema_assetfeatureresponse.html
@@ -21,7 +21,7 @@ AssetFeatureResponse
geometry
|
- optional |
+ required |
GeoJsonPoint |
See GeoJsonPoint for
@@ -37,7 +37,7 @@ AssetFeatureResponse
properties
|
- optional |
+ required |
AssetResponse |
See AssetResponse for
@@ -53,7 +53,7 @@ AssetFeatureResponse
type
|
- optional |
+ required |
string |
diff --git a/dist/documentation/schemas/woosmap_http_schema_assetfeatureresponse.md b/dist/documentation/schemas/woosmap_http_schema_assetfeatureresponse.md
index 4ba2feec..dc18f826 100644
--- a/dist/documentation/schemas/woosmap_http_schema_assetfeatureresponse.md
+++ b/dist/documentation/schemas/woosmap_http_schema_assetfeatureresponse.md
@@ -4,11 +4,11 @@
Asset Response as a GeoJSon Feature with Asset properties
-| Field | Required | Type | Description |
-| :---------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| geometry
| optional | [GeoJsonPoint](#GeoJsonPoint "GeoJsonPoint") | See [GeoJsonPoint](#GeoJsonPoint "GeoJsonPoint") for more information. |
-| properties
| optional | [AssetResponse](#AssetResponse "AssetResponse") | See [AssetResponse](#AssetResponse "AssetResponse") for more information. |
-| type
| optional | string | the Geojson Type (only 'Feature') The allowed values include: and `Feature` |
+| Field | Required | Type | Description |
+| :---------------------------------------------------------------------------------------------------------------- | ------------ | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| geometry
| **required** | [GeoJsonPoint](#GeoJsonPoint "GeoJsonPoint") | See [GeoJsonPoint](#GeoJsonPoint "GeoJsonPoint") for more information. |
+| properties
| **required** | [AssetResponse](#AssetResponse "AssetResponse") | See [AssetResponse](#AssetResponse "AssetResponse") for more information. |
+| type
| **required** | string | the Geojson Type (only 'Feature') The allowed values include: and `Feature` |
Example
diff --git a/dist/documentation/schemas/woosmap_http_schema_assetopenresponse.html b/dist/documentation/schemas/woosmap_http_schema_assetopenresponse.html
index 2804a03a..8d6ada02 100644
--- a/dist/documentation/schemas/woosmap_http_schema_assetopenresponse.html
+++ b/dist/documentation/schemas/woosmap_http_schema_assetopenresponse.html
@@ -15,102 +15,105 @@ AssetOpenResponse
- current_slice
+ open_hours
|
- optional |
+ required |
- AssetOpeningHoursPeriod
+ >>
|
- See
- AssetOpeningHoursPeriod
- for more information.
+
|
- next_opening
+ open_now
|
- optional |
- object |
+ required |
+ boolean |
- the next opening hours period
+ Boolean value indicating the status of the opening hours
|
- open_hours
+ week_day
|
- optional |
-
- Array<AssetOpeningHoursPeriod>
- |
+ required |
+ integer |
-
- the opening hours for the day
-
- See
- AssetOpeningHoursPeriod for
- more information.
-
+
+ the day of the week starting from 1 to 7
|
- open_now
+ current_slice
|
optional |
- boolean |
-
- Boolean value indicating the status of the opening hours
- |
+
+ See
+ AssetOpeningHoursPeriod
+ for more information.
|
- week_day
+ next_opening
|
optional |
- integer |
+ object,null |
- the day of the week starting from 1 to 7
+
+ the next opening hours period, returned when the asset is closed.
+ null when the asset does not open in the next days.
+
|
diff --git a/dist/documentation/schemas/woosmap_http_schema_assetopenresponse.md b/dist/documentation/schemas/woosmap_http_schema_assetopenresponse.md
index 202793e8..a0e70225 100644
--- a/dist/documentation/schemas/woosmap_http_schema_assetopenresponse.md
+++ b/dist/documentation/schemas/woosmap_http_schema_assetopenresponse.md
@@ -4,13 +4,13 @@
The Current opening status for an Asset
-| Field | Required | Type | Description |
-| :------------------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| current_slice
| optional | [AssetOpeningHoursPeriod](#AssetOpeningHoursPeriod "AssetOpeningHoursPeriod") | See [AssetOpeningHoursPeriod](#AssetOpeningHoursPeriod "AssetOpeningHoursPeriod") for more information. |
-| next_opening
| optional | object | the next opening hours period |
-| open_hours
| optional | Array\<[AssetOpeningHoursPeriod](#AssetOpeningHoursPeriod "AssetOpeningHoursPeriod")\> | |
-| open_now
| optional | boolean | Boolean value indicating the status of the opening hours |
-| week_day
| optional | integer | the day of the week starting from 1 to 7 |
+| Field | Required | Type | Description |
+| :------------------------------------------------------------------------------------------------------------------- | ------------ | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| open_hours
| **required** | Array\<[AssetOpeningHoursPeriod](#AssetOpeningHoursPeriod "AssetOpeningHoursPeriod")\> | |
+| open_now
| **required** | boolean | Boolean value indicating the status of the opening hours |
+| week_day
| **required** | integer | the day of the week starting from 1 to 7 |
+| current_slice
| optional | [AssetOpeningHoursPeriod](#AssetOpeningHoursPeriod "AssetOpeningHoursPeriod") | See [AssetOpeningHoursPeriod](#AssetOpeningHoursPeriod "AssetOpeningHoursPeriod") for more information. |
+| next_opening
| optional | object,null | the next opening hours period, returned when the asset is closed. null when the asset does not open in the next days. |
Example
diff --git a/dist/documentation/schemas/woosmap_http_schema_assetresponse.html b/dist/documentation/schemas/woosmap_http_schema_assetresponse.html
index 59bdb797..4bf14eb5 100644
--- a/dist/documentation/schemas/woosmap_http_schema_assetresponse.html
+++ b/dist/documentation/schemas/woosmap_http_schema_assetresponse.html
@@ -21,7 +21,7 @@ AssetResponse
address
|
- optional |
+ required |
AssetAddressResponseAssetResponse
contact
|
- optional |
+ required |
AssetContact |
See AssetContact for
more information.
|
-
-
-
- distance
-
- |
- optional |
- number |
-
-
-
- The distance in meters from the geolocated position or searched
- position if exist
-
- |
-
AssetResponse
last_updated
|
- optional |
+ required |
string,null |
@@ -94,7 +74,7 @@
name
|
- optional |
+ required |
AssetName |
See AssetName for more
@@ -103,109 +83,149 @@
|
-
- open
+
+ store_id
|
- optional |
+ required |
+ AssetId |
- AssetOpenResponse
+ See AssetId for more information.
|
+
+
+ |
+
+ |
+ required |
+ AssetTags |
- See
- AssetOpenResponse
- for more information.
+ See AssetTags for more
+ information.
|
- opening_hours
+ types
|
- optional |
+ required |
+ AssetTypes |
- AssetOpeningHoursAssetTypes for more
+ information.
+ |
+
+
+
+
+ user_properties
+
|
+ required |
+ object |
- See
- AssetOpeningHours
- for more information.
+
+
+ Contains all additional information relative to an Asset. Empty
+ object when not set.
+
+ |
- store_id
+ distance
|
optional |
- AssetId |
+ number |
- See AssetId for more information.
+
+
+ The distance in meters from the geolocated position or searched
+ position if exist
+
+ |
|
- |
optional |
- AssetTags |
+ object |
- See AssetTags for more
- information.
+
+
+ Alternate names of the Asset, keyed by language. Only returned when
+ set.
+
+ |
-
- types
+
+ open
|
optional |
- AssetTypes |
- See AssetTypes for more
- information.
+ AssetOpenResponse
+ |
+
+ See
+ AssetOpenResponse
+ for more information.
|
- user_properties
+ opening_hours
|
optional |
- object,null |
-
-
- Contains all additional information relative to an Asset. If not set
- it returns null value.
-
- |
+
+ See
+ AssetOpeningHours
+ for more information.
|
diff --git a/dist/documentation/schemas/woosmap_http_schema_assetresponse.md b/dist/documentation/schemas/woosmap_http_schema_assetresponse.md
index 22fdc792..4e7cda39 100644
--- a/dist/documentation/schemas/woosmap_http_schema_assetresponse.md
+++ b/dist/documentation/schemas/woosmap_http_schema_assetresponse.md
@@ -4,20 +4,21 @@
Attributes describing an Asset.
-| Field | Required | Type | Description |
-| :------------------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
-| address
| optional | [AssetAddressResponse](#AssetAddressResponse "AssetAddressResponse") | See [AssetAddressResponse](#AssetAddressResponse "AssetAddressResponse") for more information. |
-| | optional | [AssetContact](#AssetContact "AssetContact") | See [AssetContact](#AssetContact "AssetContact") for more information. |
-| distance
| optional | number | The distance in meters from the geolocated position or searched position if exist
last_updated
| optional | string,null | the previous date timestamp when the asset has been updated
name
| optional | [AssetName](#AssetName "AssetName") | See [AssetName](#AssetName "AssetName") for more information. |
-| open
| optional | [AssetOpenResponse](#AssetOpenResponse "AssetOpenResponse") | See [AssetOpenResponse](#AssetOpenResponse "AssetOpenResponse") for more information. |
-| opening_hours
| optional | [AssetOpeningHours](#AssetOpeningHours "AssetOpeningHours") | See [AssetOpeningHours](#AssetOpeningHours "AssetOpeningHours") for more information. |
-| store_id
| optional | [AssetId](#AssetId "AssetId") | See [AssetId](#AssetId "AssetId") for more information. |
-| | optional | [AssetTags](#AssetTags "AssetTags") | See [AssetTags](#AssetTags "AssetTags") for more information. |
-| types
| optional | [AssetTypes](#AssetTypes "AssetTypes") | See [AssetTypes](#AssetTypes "AssetTypes") for more information. |
-| user_properties
| optional | object,null | Contains all additional information relative to an Asset. If not set it returns null value.
weekly_opening
| optional | [AssetWeeklyOpeningResponse](#AssetWeeklyOpeningResponse "AssetWeeklyOpeningResponse") | See [AssetWeeklyOpeningResponse](#AssetWeeklyOpeningResponse "AssetWeeklyOpeningResponse") for more information. |
+| Field | Required | Type | Description |
+| :------------------------------------------------------------------------------------------------------------------- | ------------ | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| address
| **required** | [AssetAddressResponse](#AssetAddressResponse "AssetAddressResponse") | See [AssetAddressResponse](#AssetAddressResponse "AssetAddressResponse") for more information. |
+| | **required** | [AssetContact](#AssetContact "AssetContact") | See [AssetContact](#AssetContact "AssetContact") for more information. |
+| last_updated
| **required** | string,null | the previous date timestamp when the asset has been updated
name
| **required** | [AssetName](#AssetName "AssetName") | See [AssetName](#AssetName "AssetName") for more information. |
+| store_id
| **required** | [AssetId](#AssetId "AssetId") | See [AssetId](#AssetId "AssetId") for more information. |
+| | **required** | [AssetTags](#AssetTags "AssetTags") | See [AssetTags](#AssetTags "AssetTags") for more information. |
+| types
| **required** | [AssetTypes](#AssetTypes "AssetTypes") | See [AssetTypes](#AssetTypes "AssetTypes") for more information. |
+| user_properties
| **required** | object | Contains all additional information relative to an Asset. Empty object when not set.
distance
| optional | number | The distance in meters from the geolocated position or searched position if exist
localized_names
| optional | object | Alternate names of the Asset, keyed by language. Only returned when set.
open
| optional | [AssetOpenResponse](#AssetOpenResponse "AssetOpenResponse") | See [AssetOpenResponse](#AssetOpenResponse "AssetOpenResponse") for more information. |
+| opening_hours
| optional | [AssetOpeningHours](#AssetOpeningHours "AssetOpeningHours") | See [AssetOpeningHours](#AssetOpeningHours "AssetOpeningHours") for more information. |
+| weekly_opening
| optional | [AssetWeeklyOpeningResponse](#AssetWeeklyOpeningResponse "AssetWeeklyOpeningResponse") | See [AssetWeeklyOpeningResponse](#AssetWeeklyOpeningResponse "AssetWeeklyOpeningResponse") for more information. |
Generated from the OpenAPI specification.
✎ Edit
diff --git a/dist/documentation/schemas/woosmap_http_schema_boundsresponse.html b/dist/documentation/schemas/woosmap_http_schema_boundsresponse.html
index b5b2fe0c..d65f52be 100644
--- a/dist/documentation/schemas/woosmap_http_schema_boundsresponse.html
+++ b/dist/documentation/schemas/woosmap_http_schema_boundsresponse.html
@@ -21,10 +21,12 @@
BoundsResponse
bounds
- optional |
+ required |
object |
-
+
+ The bounds object, empty when no asset matches.
+ |
diff --git a/dist/documentation/schemas/woosmap_http_schema_boundsresponse.md b/dist/documentation/schemas/woosmap_http_schema_boundsresponse.md
index e185c71a..5ff13531 100644
--- a/dist/documentation/schemas/woosmap_http_schema_boundsresponse.md
+++ b/dist/documentation/schemas/woosmap_http_schema_boundsresponse.md
@@ -4,9 +4,9 @@
Message returned to a success Search Bounds request
-| Field | Required | Type | Description |
-| :-------------------------------------------------------------------------------------------------- | -------- | ------ | ----------------------------------------------------------------------- |
-| bounds
| optional | object | |
+| Field | Required | Type | Description |
+| :-------------------------------------------------------------------------------------------------- | ------------ | ------ | ----------------------------------------------------------------------------------------------------- |
+| bounds
| **required** | object | The bounds object, empty when no asset matches.
Generated from the OpenAPI specification.
✎ Edit
diff --git a/dist/documentation/schemas/woosmap_http_schema_geojsonpoint.html b/dist/documentation/schemas/woosmap_http_schema_geojsonpoint.html
index cfde98fa..0c710373 100644
--- a/dist/documentation/schemas/woosmap_http_schema_geojsonpoint.html
+++ b/dist/documentation/schemas/woosmap_http_schema_geojsonpoint.html
@@ -21,7 +21,7 @@
GeoJsonPoint
coordinates
- optional |
+ required |
LatLngArrayString
type
|
- optional |
+ required |
string |
diff --git a/dist/documentation/schemas/woosmap_http_schema_geojsonpoint.md b/dist/documentation/schemas/woosmap_http_schema_geojsonpoint.md
index 2ab47b27..b624422d 100644
--- a/dist/documentation/schemas/woosmap_http_schema_geojsonpoint.md
+++ b/dist/documentation/schemas/woosmap_http_schema_geojsonpoint.md
@@ -4,10 +4,10 @@
GeoJSon Point Geometry
-| Field | Required | Type | Description |
-| :---------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| coordinates
| optional | [LatLngArrayString](#LatLngArrayString "LatLngArrayString") | See [LatLngArrayString](#LatLngArrayString "LatLngArrayString") for more information. |
-| type
| optional | string | the geometry type The allowed values include: and `Point` |
+| Field | Required | Type | Description |
+| :---------------------------------------------------------------------------------------------------------- | ------------ | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| coordinates
| **required** | [LatLngArrayString](#LatLngArrayString "LatLngArrayString") | See [LatLngArrayString](#LatLngArrayString "LatLngArrayString") for more information. |
+| type
| **required** | string | the geometry type The allowed values include: and `Point` |
Example
diff --git a/dist/documentation/schemas/woosmap_http_schema_matchedsubstring.html b/dist/documentation/schemas/woosmap_http_schema_matchedsubstring.html
index 96a3cdcf..662cde0d 100644
--- a/dist/documentation/schemas/woosmap_http_schema_matchedsubstring.html
+++ b/dist/documentation/schemas/woosmap_http_schema_matchedsubstring.html
@@ -20,8 +20,8 @@ MatchedSubstring
length
|
- optional |
- number |
+ required |
+ integer |
Length of the matched substring in the prediction result text.
@@ -37,8 +37,8 @@ MatchedSubstring
offset
|
- optional |
- number |
+ required |
+ integer |
diff --git a/dist/documentation/schemas/woosmap_http_schema_matchedsubstring.md b/dist/documentation/schemas/woosmap_http_schema_matchedsubstring.md
index aaaf7ca0..156874cb 100644
--- a/dist/documentation/schemas/woosmap_http_schema_matchedsubstring.md
+++ b/dist/documentation/schemas/woosmap_http_schema_matchedsubstring.md
@@ -2,10 +2,10 @@
MatchedSubstring
-| Field | Required | Type | Description |
-| :---------------------------------------------------------------------------------------------------- | -------- | ------ | ---------------------------------------------------------------------------------------------------------------------------- |
-| length
| optional | number | Length of the matched substring in the prediction result text. |
-| offset
| optional | number | Start location of the matched substring in the prediction result text. |
+| Field | Required | Type | Description |
+| :---------------------------------------------------------------------------------------------------- | ------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| length
| **required** | integer | Length of the matched substring in the prediction result text. |
+| offset
| **required** | integer | Start location of the matched substring in the prediction result text. |
Example
diff --git a/dist/documentation/schemas/woosmap_http_schema_pagination.html b/dist/documentation/schemas/woosmap_http_schema_pagination.html
index 002e50d9..3c08bc14 100644
--- a/dist/documentation/schemas/woosmap_http_schema_pagination.html
+++ b/dist/documentation/schemas/woosmap_http_schema_pagination.html
@@ -18,7 +18,7 @@
|
- optional |
+ required |
integer |
@@ -33,7 +33,7 @@
|
- optional |
+ required |
integer |
diff --git a/dist/documentation/schemas/woosmap_http_schema_pagination.md b/dist/documentation/schemas/woosmap_http_schema_pagination.md
index 893122cb..4068e19d 100644
--- a/dist/documentation/schemas/woosmap_http_schema_pagination.md
+++ b/dist/documentation/schemas/woosmap_http_schema_pagination.md
@@ -4,10 +4,10 @@
Pagination to reach all returned assets. max 300 assets par page.
-| Field | Required | Type | Description |
-| :---------------------------------------------------------------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------- |
-| | optional | integer | |
-| | optional | integer | the number of available pages |
+| Field | Required | Type | Description |
+| :---------------------------------------------------------------------------------------------------- | ------------ | ------- | ----------------------------------------------------------------------------------- |
+| | **required** | integer | |
+| | **required** | integer | the number of available pages |
Generated from the OpenAPI specification.
✎ Edit
diff --git a/dist/woosmap-openapi3.json b/dist/woosmap-openapi3.json
index e0aad758..aa208939 100755
--- a/dist/woosmap-openapi3.json
+++ b/dist/woosmap-openapi3.json
@@ -1712,7 +1712,10 @@
"$ref": "#/components/parameters/radius"
},
{
- "$ref": "#/components/parameters/encoded_polyline"
+ "$ref": "#/components/parameters/polyline"
+ },
+ {
+ "$ref": "#/components/parameters/bounds"
},
{
"$ref": "#/components/parameters/stores_by_page"
@@ -2005,7 +2008,7 @@
"tags": [
"Store Search"
],
- "description": "Autocomplete on `localizedNames` with highlighted results on asset name. Use the field `localized` in your query parameter to search for localized names.\n",
+ "description": "Autocomplete on `localizedNames` with highlighted results on asset name. Use the field `localized` in your query parameter to search for localized names. Without `query`, the response has no predictions.\n",
"security": [
{
"PublicApiKeyAuth": [],
@@ -3098,7 +3101,7 @@
},
"lat": {
"name": "lat",
- "description": "Latitude bias for the results. Should be pass with `lng`.\n",
+ "description": "Latitude bias for the results. Must be passed with `lng`.\n",
"schema": {
"type": "number",
"example": 5.2
@@ -3107,7 +3110,7 @@
},
"lng": {
"name": "lng",
- "description": "Longitude bias for the results. Should be pass with `lat`.\n",
+ "description": "Longitude bias for the results. Must be passed with `lat`.\n",
"schema": {
"type": "number",
"example": 3.5
@@ -3116,22 +3119,31 @@
},
"radius": {
"name": "radius",
- "description": "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).\n",
+ "description": "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.\n",
"schema": {
"type": "number",
"example": 3000
},
"in": "query"
},
- "encoded_polyline": {
- "name": "encoded_polyline",
- "description": "Find assets nearby an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) and inside a defined radius.\n",
+ "polyline": {
+ "name": "polyline",
+ "description": "Find assets nearby an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) and inside a defined radius. Requires `radius`.\n",
"schema": {
"type": "string",
"example": "_p~iF~ps|U_ulLnnqC_mqNvxq`@"
},
"in": "query"
},
+ "bounds": {
+ "name": "bounds",
+ "description": "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`.\n",
+ "schema": {
+ "type": "string",
+ "example": "2.29,48.85,2.35,48.87"
+ },
+ "in": "query"
+ },
"stores_by_page": {
"name": "stores_by_page",
"description": "If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is 100, max is 300).\n",
@@ -3139,6 +3151,7 @@
"type": "integer",
"minimum": 1,
"maximum": 300,
+ "default": 100,
"example": 150
},
"in": "query"
@@ -3148,6 +3161,8 @@
"description": "Page number when accessing paginated assets feature collection\n",
"schema": {
"type": "integer",
+ "minimum": 1,
+ "default": 1,
"example": 2
},
"in": "query"
@@ -3177,17 +3192,19 @@
"type": "integer",
"minimum": 1,
"maximum": 50,
+ "default": 5,
"example": 15
},
"in": "query"
},
"limit-3": {
"name": "limit",
- "description": "To limit number of zones retrieved (max 50).\n",
+ "description": "To limit number of zones retrieved (Default is 10, max is 50).\n",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 50,
+ "default": 10,
"example": 10
},
"in": "query"
@@ -3197,7 +3214,8 @@
"description": "To retrieve zones starting from an offset value.\n",
"schema": {
"type": "integer",
- "minimum": 1,
+ "minimum": 0,
+ "default": 0,
"example": 20
},
"in": "query"
@@ -3401,26 +3419,30 @@
"type": "string",
"example": "STORE_ID_12345"
},
- "AssetAddressLines": {
- "title": "AssetAddressLines",
- "description": "An Array for lines of an Asset Address",
- "type": "array",
- "example": [
- "Building Centre",
- "26 Store Street"
- ],
- "items": {
- "type": "string",
- "example": "26 Store Street"
- }
- },
"AssetAddressResponse": {
"title": "AssetAddressResponse",
"type": "object",
"description": "An object containing the separate components applicable to this address.",
+ "required": [
+ "lines",
+ "country_code",
+ "city",
+ "zipcode"
+ ],
"properties": {
"lines": {
- "$ref": "#/components/schemas/AssetAddressLines"
+ "description": "An Array for lines of an Asset Address",
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "Building Centre",
+ "26 Store Street"
+ ]
},
"country_code": {
"description": "An ISO_3166-1 Country Code where the Asset is located (see for full list)",
@@ -3432,12 +3454,18 @@
},
"city": {
"description": "A City where belongs an Asset",
- "type": "string",
+ "type": [
+ "string",
+ "null"
+ ],
"example": "London"
},
"zipcode": {
"description": "An Zipcode / Postal code of an Asset Address",
- "type": "string",
+ "type": [
+ "string",
+ "null"
+ ],
"example": "WC1E 7BT"
}
},
@@ -3506,6 +3534,11 @@
"title": "AssetOpenResponse",
"type": "object",
"description": "The Current opening status for an Asset",
+ "required": [
+ "open_now",
+ "open_hours",
+ "week_day"
+ ],
"properties": {
"current_slice": {
"$ref": "#/components/schemas/AssetOpeningHoursPeriod"
@@ -3522,19 +3555,29 @@
"type": "boolean"
},
"next_opening": {
- "description": "the next opening hours period",
- "type": "object",
+ "description": "the next opening hours period, returned when the asset is closed. `null` when the asset does not open in the next days.",
+ "type": [
+ "object",
+ "null"
+ ],
+ "required": [
+ "day"
+ ],
"properties": {
"end": {
- "description": "the hours of next opening",
+ "description": "the hours of next closing",
"type": "string",
"example": "17:30"
},
"start": {
- "description": "the hours of next closing",
+ "description": "the hours of next opening",
"type": "string",
"example": "06:00"
},
+ "all-day": {
+ "description": "true when the asset is open all day, in place of `start` and `end`",
+ "type": "boolean"
+ },
"day": {
"type": "string",
"description": "the day of next opening",
@@ -3835,6 +3878,16 @@
"title": "AssetResponse",
"type": "object",
"description": "Attributes describing an Asset.",
+ "required": [
+ "store_id",
+ "name",
+ "address",
+ "contact",
+ "types",
+ "tags",
+ "last_updated",
+ "user_properties"
+ ],
"properties": {
"name": {
"$ref": "#/components/schemas/AssetName"
@@ -3869,11 +3922,8 @@
"example": "2022-11-08T15:48:08.556803+00:00"
},
"user_properties": {
- "description": "Contains all additional information relative to an Asset. If not set it returns null value.",
- "type": [
- "object",
- "null"
- ],
+ "description": "Contains all additional information relative to an Asset. Empty object when not set.",
+ "type": "object",
"additionalProperties": true,
"example": {
"some_user_properties": "some_value"
@@ -3882,6 +3932,17 @@
"opening_hours": {
"$ref": "#/components/schemas/AssetOpeningHours"
},
+ "localized_names": {
+ "description": "Alternate names of the Asset, keyed by language. Only returned when set.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "example": {
+ "fr": "Centre Commercial Velizy",
+ "it": "Centro Commerciale Velizy"
+ }
+ },
"distance": {
"description": "The distance in meters from the geolocated position or searched position if exist",
"type": "number",
@@ -3907,6 +3968,10 @@
"title": "GeoJsonPoint",
"type": "object",
"description": "GeoJSon Point Geometry",
+ "required": [
+ "type",
+ "coordinates"
+ ],
"properties": {
"type": {
"type": "string",
@@ -3931,6 +3996,11 @@
"title": "AssetFeatureResponse",
"type": "object",
"description": "Asset Response as a GeoJSon Feature with Asset properties",
+ "required": [
+ "type",
+ "properties",
+ "geometry"
+ ],
"properties": {
"type": {
"description": "the Geojson Type (only 'Feature')",
@@ -4127,6 +4197,10 @@
"title": "Pagination",
"type": "object",
"description": "Pagination to reach all returned assets. max 300 assets par page.",
+ "required": [
+ "page",
+ "pageCount"
+ ],
"properties": {
"page": {
"type": "integer",
@@ -4144,6 +4218,11 @@
"title": "AssetFeatureCollectionResponse",
"type": "object",
"description": "Assets Collection Response as a GeoJSon FeatureCollection with Asset properties",
+ "required": [
+ "type",
+ "features",
+ "pagination"
+ ],
"properties": {
"type": {
"description": "the Geojson Type (only 'FeatureCollection')",
@@ -4625,6 +4704,19 @@
"dst_offset": 3600
}
},
+ "AssetAddressLines": {
+ "title": "AssetAddressLines",
+ "description": "An Array for lines of an Asset Address",
+ "type": "array",
+ "example": [
+ "Building Centre",
+ "26 Store Street"
+ ],
+ "items": {
+ "type": "string",
+ "example": "26 Store Street"
+ }
+ },
"AssetAddressRequest": {
"title": "AssetAddressRequest",
"type": "object",
@@ -4879,14 +4971,18 @@
"MatchedSubstring": {
"title": "MatchedSubstring",
"type": "object",
+ "required": [
+ "offset",
+ "length"
+ ],
"properties": {
"length": {
"description": "Length of the matched substring in the prediction result text.",
- "type": "number"
+ "type": "integer"
},
"offset": {
"description": "Start location of the matched substring in the prediction result text.",
- "type": "number"
+ "type": "integer"
}
},
"example": {
@@ -4894,39 +4990,55 @@
"length": 4
}
},
+ "AssetAutocompletePrediction": {
+ "title": "AssetAutocompletePrediction",
+ "type": "object",
+ "description": "An Asset matching the autocomplete query.",
+ "required": [
+ "store_id",
+ "name",
+ "types",
+ "matched_substrings",
+ "highlighted"
+ ],
+ "properties": {
+ "name": {
+ "description": "The `name` property of each prediction will be filled with the localized name of your asset in the `language` you provided in your query if it exists, or else the default name property.\n",
+ "type": "string",
+ "example": "Centro Commerciale Deria"
+ },
+ "highlighted": {
+ "type": "string",
+ "description": "an HTML formatted string with, if it exists, the matched substring(s) in bold font.",
+ "example": "Centro Commerciale Deria"
+ },
+ "store_id": {
+ "$ref": "#/components/schemas/AssetId"
+ },
+ "types": {
+ "$ref": "#/components/schemas/AssetTypes"
+ },
+ "matched_substrings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MatchedSubstring"
+ }
+ }
+ }
+ },
"AssetAutocompleteResponse": {
"title": "AssetAutocompleteResponse",
"type": "object",
"description": "Asset Autocomplete Response with highlighted results on asset name.",
+ "required": [
+ "predictions"
+ ],
"properties": {
"predictions": {
"description": "A list of predictions based on similarity in all the `localizedNames` passed in query (or similarity to `store_name` if no `localizedNames` exist)",
+ "type": "array",
"items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The `name` property of each prediction will be filled with the localized name of your asset in the `language` you provided in your query if it exists, or else the default name property.\n",
- "type": "string",
- "example": "Centro Commerciale Deria"
- },
- "highlighted": {
- "type": "string",
- "description": "an HTML formatted string with, if it exists, the matched substring(s) in bold font.",
- "example": "Centro Commerciale Deria"
- },
- "store_id": {
- "$ref": "#/components/schemas/AssetId"
- },
- "types": {
- "$ref": "#/components/schemas/AssetTypes"
- },
- "matched_substrings": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MatchedSubstring"
- }
- }
- }
+ "$ref": "#/components/schemas/AssetAutocompletePrediction"
}
}
},
@@ -4981,9 +5093,12 @@
"title": "BoundsResponse",
"type": "object",
"description": "Message returned to a success Search Bounds request",
+ "required": [
+ "bounds"
+ ],
"properties": {
"bounds": {
- "description": "The bounds object",
+ "description": "The bounds object, empty when no asset matches.",
"type": "object",
"properties": {
"west": {
diff --git a/dist/woosmap-openapi3.yml b/dist/woosmap-openapi3.yml
index 88e7d1d6..4f58235a 100755
--- a/dist/woosmap-openapi3.yml
+++ b/dist/woosmap-openapi3.yml
@@ -2051,7 +2051,8 @@ paths:
- $ref: '#/components/parameters/lat'
- $ref: '#/components/parameters/lng'
- $ref: '#/components/parameters/radius'
- - $ref: '#/components/parameters/encoded_polyline'
+ - $ref: '#/components/parameters/polyline'
+ - $ref: '#/components/parameters/bounds'
- $ref: '#/components/parameters/stores_by_page'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/zone'
@@ -2248,7 +2249,7 @@ paths:
tags:
- Store Search
description: |
- Autocomplete on `localizedNames` with highlighted results on asset name. Use the field `localized` in your query parameter to search for localized names.
+ Autocomplete on `localizedNames` with highlighted results on asset name. Use the field `localized` in your query parameter to search for localized names. Without `query`, the response has no predictions.
security:
- PublicApiKeyAuth: []
RefererHeader: []
@@ -3297,7 +3298,7 @@ components:
lat:
name: lat
description: |
- Latitude bias for the results. Should be pass with `lng`.
+ Latitude bias for the results. Must be passed with `lng`.
schema:
type: number
example: 5.2
@@ -3305,7 +3306,7 @@ components:
lng:
name: lng
description: |
- Longitude bias for the results. Should be pass with `lat`.
+ Longitude bias for the results. Must be passed with `lat`.
schema:
type: number
example: 3.5
@@ -3313,19 +3314,27 @@ components:
radius:
name: radius
description: |
- 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.
schema:
type: number
example: 3000
in: query
- encoded_polyline:
- name: encoded_polyline
+ polyline:
+ name: polyline
description: |
- Find assets nearby an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) and inside a defined radius.
+ Find assets nearby an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) and inside a defined radius. Requires `radius`.
schema:
type: string
example: _p~iF~ps|U_ulLnnqC_mqNvxq`@
in: query
+ bounds:
+ name: bounds
+ description: |
+ 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`.
+ schema:
+ type: string
+ example: 2.29,48.85,2.35,48.87
+ in: query
stores_by_page:
name: stores_by_page
description: |
@@ -3334,6 +3343,7 @@ components:
type: integer
minimum: 1
maximum: 300
+ default: 100
example: 150
in: query
page:
@@ -3342,6 +3352,8 @@ components:
Page number when accessing paginated assets feature collection
schema:
type: integer
+ minimum: 1
+ default: 1
example: 2
in: query
zone:
@@ -3368,16 +3380,18 @@ components:
type: integer
minimum: 1
maximum: 50
+ default: 5
example: 15
in: query
limit-3:
name: limit
description: |
- To limit number of zones retrieved (max 50).
+ To limit number of zones retrieved (Default is 10, max is 50).
schema:
type: integer
minimum: 1
maximum: 50
+ default: 10
example: 10
in: query
offset:
@@ -3386,7 +3400,8 @@ components:
To retrieve zones starting from an offset value.
schema:
type: integer
- minimum: 1
+ minimum: 0
+ default: 0
example: 20
in: query
schemas:
@@ -3543,23 +3558,26 @@ components:
A textual identifier that uniquely identifies an Asset. It must matches the following regexp `[A-Za-z0-9]+`
type: string
example: STORE_ID_12345
- AssetAddressLines:
- title: AssetAddressLines
- description: An Array for lines of an Asset Address
- type: array
- example:
- - Building Centre
- - 26 Store Street
- items:
- type: string
- example: 26 Store Street
AssetAddressResponse:
title: AssetAddressResponse
type: object
description: An object containing the separate components applicable to this address.
+ required:
+ - lines
+ - country_code
+ - city
+ - zipcode
properties:
lines:
- $ref: '#/components/schemas/AssetAddressLines'
+ description: An Array for lines of an Asset Address
+ type:
+ - array
+ - 'null'
+ items:
+ type: string
+ example:
+ - Building Centre
+ - 26 Store Street
country_code:
description: An ISO_3166-1 Country Code where the Asset is located (see for full list)
type:
@@ -3568,11 +3586,15 @@ components:
example: UK
city:
description: A City where belongs an Asset
- type: string
+ type:
+ - string
+ - 'null'
example: London
zipcode:
description: An Zipcode / Postal code of an Asset Address
- type: string
+ type:
+ - string
+ - 'null'
example: WC1E 7BT
example:
lines:
@@ -3624,6 +3646,10 @@ components:
title: AssetOpenResponse
type: object
description: The Current opening status for an Asset
+ required:
+ - open_now
+ - open_hours
+ - week_day
properties:
current_slice:
$ref: '#/components/schemas/AssetOpeningHoursPeriod'
@@ -3636,17 +3662,24 @@ components:
description: Boolean value indicating the status of the opening hours
type: boolean
next_opening:
- description: the next opening hours period
- type: object
+ description: the next opening hours period, returned when the asset is closed. `null` when the asset does not open in the next days.
+ type:
+ - object
+ - 'null'
+ required:
+ - day
properties:
end:
- description: the hours of next opening
+ description: the hours of next closing
type: string
example: '17:30'
start:
- description: the hours of next closing
+ description: the hours of next opening
type: string
example: '06:00'
+ all-day:
+ description: true when the asset is open all day, in place of `start` and `end`
+ type: boolean
day:
type: string
description: the day of next opening
@@ -3847,6 +3880,15 @@ components:
title: AssetResponse
type: object
description: Attributes describing an Asset.
+ required:
+ - store_id
+ - name
+ - address
+ - contact
+ - types
+ - tags
+ - last_updated
+ - user_properties
properties:
name:
$ref: '#/components/schemas/AssetName'
@@ -3871,15 +3913,21 @@ components:
description: the previous date timestamp when the asset has been updated
example: '2022-11-08T15:48:08.556803+00:00'
user_properties:
- description: Contains all additional information relative to an Asset. If not set it returns null value.
- type:
- - object
- - 'null'
+ description: Contains all additional information relative to an Asset. Empty object when not set.
+ type: object
additionalProperties: true
example:
some_user_properties: some_value
opening_hours:
$ref: '#/components/schemas/AssetOpeningHours'
+ localized_names:
+ description: Alternate names of the Asset, keyed by language. Only returned when set.
+ type: object
+ additionalProperties:
+ type: string
+ example:
+ fr: Centre Commercial Velizy
+ it: Centro Commerciale Velizy
distance:
description: The distance in meters from the geolocated position or searched position if exist
type: number
@@ -3899,6 +3947,9 @@ components:
title: GeoJsonPoint
type: object
description: GeoJSon Point Geometry
+ required:
+ - type
+ - coordinates
properties:
type:
type: string
@@ -3916,6 +3967,10 @@ components:
title: AssetFeatureResponse
type: object
description: Asset Response as a GeoJSon Feature with Asset properties
+ required:
+ - type
+ - properties
+ - geometry
properties:
type:
description: the Geojson Type (only 'Feature')
@@ -4039,6 +4094,9 @@ components:
title: Pagination
type: object
description: Pagination to reach all returned assets. max 300 assets par page.
+ required:
+ - page
+ - pageCount
properties:
page:
type: integer
@@ -4052,6 +4110,10 @@ components:
title: AssetFeatureCollectionResponse
type: object
description: Assets Collection Response as a GeoJSon FeatureCollection with Asset properties
+ required:
+ - type
+ - features
+ - pagination
properties:
type:
description: the Geojson Type (only 'FeatureCollection')
@@ -4372,6 +4434,16 @@ components:
timezone_name: CEST
raw_offset: 3600
dst_offset: 3600
+ AssetAddressLines:
+ title: AssetAddressLines
+ description: An Array for lines of an Asset Address
+ type: array
+ example:
+ - Building Centre
+ - 26 Store Street
+ items:
+ type: string
+ example: 26 Store Street
AssetAddressRequest:
title: AssetAddressRequest
type: object
@@ -4549,43 +4621,59 @@ components:
MatchedSubstring:
title: MatchedSubstring
type: object
+ required:
+ - offset
+ - length
properties:
length:
description: Length of the matched substring in the prediction result text.
- type: number
+ type: integer
offset:
description: Start location of the matched substring in the prediction result text.
- type: number
+ type: integer
example:
offset: 0
length: 4
+ AssetAutocompletePrediction:
+ title: AssetAutocompletePrediction
+ type: object
+ description: An Asset matching the autocomplete query.
+ required:
+ - store_id
+ - name
+ - types
+ - matched_substrings
+ - highlighted
+ properties:
+ name:
+ description: |
+ The `name` property of each prediction will be filled with the localized name of your asset in the `language` you provided in your query if it exists, or else the default name property.
+ type: string
+ example: Centro Commerciale Deria
+ highlighted:
+ type: string
+ description: an HTML formatted string with, if it exists, the matched substring(s) in bold font.
+ example: Centro Commerciale Deria
+ store_id:
+ $ref: '#/components/schemas/AssetId'
+ types:
+ $ref: '#/components/schemas/AssetTypes'
+ matched_substrings:
+ type: array
+ items:
+ $ref: '#/components/schemas/MatchedSubstring'
AssetAutocompleteResponse:
title: AssetAutocompleteResponse
type: object
description: Asset Autocomplete Response with highlighted results on asset name.
+ required:
+ - predictions
properties:
predictions:
description: A list of predictions based on similarity in all the `localizedNames` passed in query (or similarity to `store_name` if no `localizedNames` exist)
+ type: array
items:
- type: object
- properties:
- name:
- description: |
- The `name` property of each prediction will be filled with the localized name of your asset in the `language` you provided in your query if it exists, or else the default name property.
- type: string
- example: Centro Commerciale Deria
- highlighted:
- type: string
- description: an HTML formatted string with, if it exists, the matched substring(s) in bold font.
- example: Centro Commerciale Deria
- store_id:
- $ref: '#/components/schemas/AssetId'
- types:
- $ref: '#/components/schemas/AssetTypes'
- matched_substrings:
- type: array
- items:
- $ref: '#/components/schemas/MatchedSubstring'
+ $ref: '#/components/schemas/AssetAutocompletePrediction'
example:
predictions:
- store_id: '2670'
@@ -4616,9 +4704,11 @@ components:
title: BoundsResponse
type: object
description: Message returned to a success Search Bounds request
+ required:
+ - bounds
properties:
bounds:
- description: The bounds object
+ description: The bounds object, empty when no asset matches.
type: object
properties:
west:
diff --git a/specification/parameters/_index.yml b/specification/parameters/_index.yml
index 7e58172f..87ec8b85 100755
--- a/specification/parameters/_index.yml
+++ b/specification/parameters/_index.yml
@@ -22,8 +22,10 @@ search_lat:
$ref: "./search/lat.yml"
search_language:
$ref: "./search/language.yml"
-search_encoded_polyline:
- $ref: "./search/encoded_polyline.yml"
+search_polyline:
+ $ref: "./search/polyline.yml"
+search_bounds:
+ $ref: "./search/bounds.yml"
geolocation_limit:
$ref: "./geolocation/limit.yml"
geolocation_ip_address:
diff --git a/specification/parameters/search/bounds.yml b/specification/parameters/search/bounds.yml
new file mode 100644
index 00000000..8331c81e
--- /dev/null
+++ b/specification/parameters/search/bounds.yml
@@ -0,0 +1,7 @@
+name: bounds
+description: >
+ 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`.
+schema:
+ type: string
+ example: "2.29,48.85,2.35,48.87"
+in: query
diff --git a/specification/parameters/search/lat.yml b/specification/parameters/search/lat.yml
index 8e3c6afb..938106e1 100644
--- a/specification/parameters/search/lat.yml
+++ b/specification/parameters/search/lat.yml
@@ -1,6 +1,6 @@
name: lat
description: >
- Latitude bias for the results. Should be pass with `lng`.
+ Latitude bias for the results. Must be passed with `lng`.
schema:
type: number
example: 5.2
diff --git a/specification/parameters/search/limit.yml b/specification/parameters/search/limit.yml
index 2c56b962..38df9fd3 100644
--- a/specification/parameters/search/limit.yml
+++ b/specification/parameters/search/limit.yml
@@ -5,5 +5,6 @@ schema:
type: integer
minimum: 1
maximum: 50
+ default: 5
example: 15
in: query
\ No newline at end of file
diff --git a/specification/parameters/search/lng.yml b/specification/parameters/search/lng.yml
index 2a4132db..a2073500 100644
--- a/specification/parameters/search/lng.yml
+++ b/specification/parameters/search/lng.yml
@@ -1,6 +1,6 @@
name: lng
description: >
- Longitude bias for the results. Should be pass with `lat`.
+ Longitude bias for the results. Must be passed with `lat`.
schema:
type: number
example: 3.5
diff --git a/specification/parameters/search/page.yml b/specification/parameters/search/page.yml
index d3c684e1..a703363c 100644
--- a/specification/parameters/search/page.yml
+++ b/specification/parameters/search/page.yml
@@ -3,5 +3,7 @@ description: >
Page number when accessing paginated assets feature collection
schema:
type: integer
+ minimum: 1
+ default: 1
example: 2
in: query
\ No newline at end of file
diff --git a/specification/parameters/search/encoded_polyline.yml b/specification/parameters/search/polyline.yml
similarity index 79%
rename from specification/parameters/search/encoded_polyline.yml
rename to specification/parameters/search/polyline.yml
index e23ee136..be93cfbb 100644
--- a/specification/parameters/search/encoded_polyline.yml
+++ b/specification/parameters/search/polyline.yml
@@ -1,6 +1,6 @@
-name: encoded_polyline
+name: polyline
description: >
- Find assets nearby an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) and inside a defined radius.
+ Find assets nearby an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) and inside a defined radius. Requires `radius`.
schema:
type: string
example: '_p~iF~ps|U_ulLnnqC_mqNvxq`@'
diff --git a/specification/parameters/search/radius.yml b/specification/parameters/search/radius.yml
index 44ac823c..1bbe80e2 100644
--- a/specification/parameters/search/radius.yml
+++ b/specification/parameters/search/radius.yml
@@ -1,6 +1,6 @@
name: radius
description: >
- 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.
schema:
type: number
example: 3000
diff --git a/specification/parameters/search/stores_by_page.yml b/specification/parameters/search/stores_by_page.yml
index 63187fb0..778260f9 100644
--- a/specification/parameters/search/stores_by_page.yml
+++ b/specification/parameters/search/stores_by_page.yml
@@ -5,5 +5,6 @@ schema:
type: integer
minimum: 1
maximum: 300
+ default: 100
example: 150
in: query
\ No newline at end of file
diff --git a/specification/parameters/zones/limit.yml b/specification/parameters/zones/limit.yml
index 9eeae8ed..3518433d 100644
--- a/specification/parameters/zones/limit.yml
+++ b/specification/parameters/zones/limit.yml
@@ -1,9 +1,10 @@
name: limit
description: >
- To limit number of zones retrieved (max 50).
+ To limit number of zones retrieved (Default is 10, max is 50).
schema:
type: integer
minimum: 1
maximum: 50
+ default: 10
example: 10
in: query
diff --git a/specification/parameters/zones/offset.yml b/specification/parameters/zones/offset.yml
index 8424fefc..6504d33b 100644
--- a/specification/parameters/zones/offset.yml
+++ b/specification/parameters/zones/offset.yml
@@ -3,6 +3,7 @@ description: >
To retrieve zones starting from an offset value.
schema:
type: integer
- minimum: 1
+ minimum: 0
+ default: 0
example: 20
in: query
diff --git a/specification/paths/search/storesAutocomplete.yml b/specification/paths/search/storesAutocomplete.yml
index 1d17bb97..1731e2cf 100644
--- a/specification/paths/search/storesAutocomplete.yml
+++ b/specification/paths/search/storesAutocomplete.yml
@@ -5,6 +5,7 @@ tags:
description: >
Autocomplete on `localizedNames` with highlighted results on asset name.
Use the field `localized` in your query parameter to search for localized names.
+ Without `query`, the response has no predictions.
security:
- PublicApiKeyAuth: []
RefererHeader: []
diff --git a/specification/paths/search/storesSearch.yml b/specification/paths/search/storesSearch.yml
index 691af168..1cfc4640 100644
--- a/specification/paths/search/storesSearch.yml
+++ b/specification/paths/search/storesSearch.yml
@@ -14,7 +14,8 @@ parameters:
- $ref: "../../parameters/search/lat.yml"
- $ref: "../../parameters/search/lng.yml"
- $ref: "../../parameters/search/radius.yml"
- - $ref: "../../parameters/search/encoded_polyline.yml"
+ - $ref: "../../parameters/search/polyline.yml"
+ - $ref: "../../parameters/search/bounds.yml"
- $ref: "../../parameters/search/stores_by_page.yml"
- $ref: "../../parameters/search/page.yml"
- $ref: "../../parameters/search/zone.yml"
diff --git a/specification/schemas/AssetAddressResponse.yml b/specification/schemas/AssetAddressResponse.yml
index e3beae25..cacaf270 100644
--- a/specification/schemas/AssetAddressResponse.yml
+++ b/specification/schemas/AssetAddressResponse.yml
@@ -1,20 +1,29 @@
title: AssetAddressResponse
type: object
description: An object containing the separate components applicable to this address.
+required:
+ - lines
+ - country_code
+ - city
+ - zipcode
properties:
lines:
- $ref: "./AssetAddressLines.yml"
+ description: An Array for lines of an Asset Address
+ type: [array, "null"]
+ items:
+ type: string
+ example: ["Building Centre", "26 Store Street"]
country_code:
description: An ISO_3166-1 Country Code where the Asset is located (see for full list)
type: [string, "null"]
example: "UK"
city:
description: A City where belongs an Asset
- type: string
+ type: [string, "null"]
example: "London"
zipcode:
description: An Zipcode / Postal code of an Asset Address
- type: string
+ type: [string, "null"]
example: "WC1E 7BT"
example: {
"lines": [
diff --git a/specification/schemas/AssetAutocompletePrediction.yml b/specification/schemas/AssetAutocompletePrediction.yml
new file mode 100644
index 00000000..418f32f0
--- /dev/null
+++ b/specification/schemas/AssetAutocompletePrediction.yml
@@ -0,0 +1,28 @@
+title: AssetAutocompletePrediction
+type: object
+description: An Asset matching the autocomplete query.
+required:
+ - store_id
+ - name
+ - types
+ - matched_substrings
+ - highlighted
+properties:
+ name:
+ description: >
+ The `name` property of each prediction will be filled with the localized name of your asset in the `language` you provided in your query if it exists,
+ or else the default name property.
+ type: string
+ example: "Centro Commerciale Deria"
+ highlighted:
+ type: string
+ description: an HTML formatted string with, if it exists, the matched substring(s) in bold font.
+ example: "Centro Commerciale Deria"
+ store_id:
+ $ref: "./AssetId.yml"
+ types:
+ $ref: "./AssetTypes.yml"
+ matched_substrings:
+ type: array
+ items:
+ $ref: "./MatchedSubstring.yml"
diff --git a/specification/schemas/AssetAutocompleteResponse.yml b/specification/schemas/AssetAutocompleteResponse.yml
index 156cc808..e34299a7 100644
--- a/specification/schemas/AssetAutocompleteResponse.yml
+++ b/specification/schemas/AssetAutocompleteResponse.yml
@@ -1,29 +1,13 @@
title: AssetAutocompleteResponse
type: object
description: Asset Autocomplete Response with highlighted results on asset name.
+required:
+ - predictions
properties:
predictions:
description: A list of predictions based on similarity in all the `localizedNames` passed in query (or similarity to `store_name` if no `localizedNames` exist)
+ type: array
items:
- type: object
- properties:
- name:
- description: >
- The `name` property of each prediction will be filled with the localized name of your asset in the `language` you provided in your query if it exists,
- or else the default name property.
- type: string
- example: "Centro Commerciale Deria"
- highlighted:
- type: string
- description: an HTML formatted string with, if it exists, the matched substring(s) in bold font.
- example: "Centro Commerciale Deria"
- store_id:
- $ref: "./AssetId.yml"
- types:
- $ref: "./AssetTypes.yml"
- matched_substrings:
- type: array
- items:
- $ref: "./MatchedSubstring.yml"
+ $ref: "./AssetAutocompletePrediction.yml"
example:
$ref: "../responses/woosmap_http_asset_autocomplete_feature_collection_response.yml"
diff --git a/specification/schemas/AssetFeatureCollectionResponse.yml b/specification/schemas/AssetFeatureCollectionResponse.yml
index 9d65a77f..001ed311 100644
--- a/specification/schemas/AssetFeatureCollectionResponse.yml
+++ b/specification/schemas/AssetFeatureCollectionResponse.yml
@@ -1,6 +1,10 @@
title: AssetFeatureCollectionResponse
type: object
description: Assets Collection Response as a GeoJSon FeatureCollection with Asset properties
+required:
+ - type
+ - features
+ - pagination
properties:
type:
description: the Geojson Type (only 'FeatureCollection')
diff --git a/specification/schemas/AssetFeatureResponse.yml b/specification/schemas/AssetFeatureResponse.yml
index 65e94645..f9fce1e6 100644
--- a/specification/schemas/AssetFeatureResponse.yml
+++ b/specification/schemas/AssetFeatureResponse.yml
@@ -1,6 +1,10 @@
title: AssetFeatureResponse
type: object
description: Asset Response as a GeoJSon Feature with Asset properties
+required:
+ - type
+ - properties
+ - geometry
properties:
type:
description: the Geojson Type (only 'Feature')
diff --git a/specification/schemas/AssetOpenResponse.yml b/specification/schemas/AssetOpenResponse.yml
index f1145261..eadc9e2d 100644
--- a/specification/schemas/AssetOpenResponse.yml
+++ b/specification/schemas/AssetOpenResponse.yml
@@ -1,6 +1,10 @@
title: AssetOpenResponse
type: object
description: The Current opening status for an Asset
+required:
+ - open_now
+ - open_hours
+ - week_day
properties:
current_slice:
$ref: "./AssetOpeningHoursPeriod.yml"
@@ -13,17 +17,22 @@ properties:
description: Boolean value indicating the status of the opening hours
type: boolean
next_opening:
- description: the next opening hours period
- type: object
+ description: the next opening hours period, returned when the asset is closed. `null` when the asset does not open in the next days.
+ type: [object, "null"]
+ required:
+ - day
properties:
end:
- description: the hours of next opening
+ description: the hours of next closing
type: string
example: "17:30"
start:
- description: the hours of next closing
+ description: the hours of next opening
type: string
example: "06:00"
+ all-day:
+ description: true when the asset is open all day, in place of `start` and `end`
+ type: boolean
day:
type: string
description: the day of next opening
diff --git a/specification/schemas/AssetResponse.yml b/specification/schemas/AssetResponse.yml
index d0fff868..fbe7625c 100644
--- a/specification/schemas/AssetResponse.yml
+++ b/specification/schemas/AssetResponse.yml
@@ -1,6 +1,15 @@
title: AssetResponse
type: object
description: Attributes describing an Asset.
+required:
+ - store_id
+ - name
+ - address
+ - contact
+ - types
+ - tags
+ - last_updated
+ - user_properties
properties:
name:
$ref: "./AssetName.yml"
@@ -23,12 +32,18 @@ properties:
description: the previous date timestamp when the asset has been updated
example: "2022-11-08T15:48:08.556803+00:00"
user_properties:
- description: Contains all additional information relative to an Asset. If not set it returns null value.
- type: [object, "null"]
+ description: Contains all additional information relative to an Asset. Empty object when not set.
+ type: object
additionalProperties: true
example: { "some_user_properties": "some_value" }
opening_hours:
$ref: "./AssetOpeningHours.yml"
+ localized_names:
+ description: Alternate names of the Asset, keyed by language. Only returned when set.
+ type: object
+ additionalProperties:
+ type: string
+ example: { "fr": "Centre Commercial Velizy", "it": "Centro Commerciale Velizy" }
distance:
description: The distance in meters from the geolocated position or searched position if exist
type: number
diff --git a/specification/schemas/BoundsResponse.yml b/specification/schemas/BoundsResponse.yml
index 4b98247e..85393054 100644
--- a/specification/schemas/BoundsResponse.yml
+++ b/specification/schemas/BoundsResponse.yml
@@ -1,9 +1,11 @@
title: BoundsResponse
type: object
description: Message returned to a success Search Bounds request
+required:
+ - bounds
properties:
bounds:
- description: The bounds object
+ description: The bounds object, empty when no asset matches.
type: object
properties:
west:
diff --git a/specification/schemas/GeoJsonPoint.yml b/specification/schemas/GeoJsonPoint.yml
index 8b02252d..fe9a5c40 100644
--- a/specification/schemas/GeoJsonPoint.yml
+++ b/specification/schemas/GeoJsonPoint.yml
@@ -1,6 +1,9 @@
title: GeoJsonPoint
type: object
description: GeoJSon Point Geometry
+required:
+ - type
+ - coordinates
properties:
type:
type: string
diff --git a/specification/schemas/MatchedSubstring.yml b/specification/schemas/MatchedSubstring.yml
index 209129d7..4cd1f0f9 100644
--- a/specification/schemas/MatchedSubstring.yml
+++ b/specification/schemas/MatchedSubstring.yml
@@ -1,10 +1,13 @@
title: MatchedSubstring
type: object
+required:
+ - offset
+ - length
properties:
length:
description: Length of the matched substring in the prediction result text.
- type: number
+ type: integer
offset:
description: Start location of the matched substring in the prediction result text.
- type: number
+ type: integer
example: { "offset": 0, length: 4 }
diff --git a/specification/schemas/Pagination.yml b/specification/schemas/Pagination.yml
index b1948b28..fbe1f5ef 100644
--- a/specification/schemas/Pagination.yml
+++ b/specification/schemas/Pagination.yml
@@ -1,6 +1,9 @@
title: Pagination
type: object
description: Pagination to reach all returned assets. max 300 assets par page.
+required:
+ - page
+ - pageCount
properties:
page:
type: integer
diff --git a/specification/schemas/_index.yml b/specification/schemas/_index.yml
index 622e6a7f..712a30b3 100644
--- a/specification/schemas/_index.yml
+++ b/specification/schemas/_index.yml
@@ -16,6 +16,8 @@ AssetFeatureCollectionResponse:
$ref: "./AssetFeatureCollectionResponse.yml"
AssetAutocompleteResponse:
$ref: "./AssetAutocompleteResponse.yml"
+AssetAutocompletePrediction:
+ $ref: "./AssetAutocompletePrediction.yml"
Pagination:
$ref: "./Pagination.yml"
MatchedSubstring:
|