Skip to content

Commit

Permalink
Add bulk geocoding endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
ianthetechie committed Aug 14, 2024
1 parent efeebfd commit 5208291
Show file tree
Hide file tree
Showing 165 changed files with 3,207 additions and 414 deletions.
12 changes: 12 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ docs/BaseCostingOptions.md
docs/BaseTraceRequest.md
docs/BicycleCostingOptions.md
docs/BikeNetwork.md
docs/BulkRequest.md
docs/BulkSearchResponse.md
docs/Contour.md
docs/Coordinate.md
docs/CostingModel.md
Expand Down Expand Up @@ -82,6 +84,10 @@ docs/RoutingApi.md
docs/RoutingResponseWaypoint.md
docs/RoutingWaypoint.md
docs/RoutingWaypointAllOfSearchFilter.md
docs/SearchBulkQuery.md
docs/SearchQuery.md
docs/SearchStructuredBulkQuery.md
docs/SearchStructuredQuery.md
docs/SimpleRoutingWaypoint.md
docs/Speeds.md
docs/TraceAttributeFilterOptions.md
Expand Down Expand Up @@ -120,6 +126,8 @@ stadiamaps/models/base_costing_options.py
stadiamaps/models/base_trace_request.py
stadiamaps/models/bicycle_costing_options.py
stadiamaps/models/bike_network.py
stadiamaps/models/bulk_request.py
stadiamaps/models/bulk_search_response.py
stadiamaps/models/contour.py
stadiamaps/models/coordinate.py
stadiamaps/models/costing_model.py
Expand Down Expand Up @@ -190,6 +198,10 @@ stadiamaps/models/route_trip.py
stadiamaps/models/routing_response_waypoint.py
stadiamaps/models/routing_waypoint.py
stadiamaps/models/routing_waypoint_all_of_search_filter.py
stadiamaps/models/search_bulk_query.py
stadiamaps/models/search_query.py
stadiamaps/models/search_structured_bulk_query.py
stadiamaps/models/search_structured_query.py
stadiamaps/models/simple_routing_waypoint.py
stadiamaps/models/speeds.py
stadiamaps/models/trace_attribute_filter_options.py
Expand Down
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.5.0
7.7.0
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Version 3.2.0 - 2024-08-15

### Added

- Add support for bulk geocoding

### Fixed

- Isochrone request models now support all costing models

## Version 3.1.0 - 2024-05-11

### Added
Expand Down
6 changes: 1 addition & 5 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,6 @@ When making schema changes, you may need to temporarily remove [README.md](READM

### Generator bugs

The following info is current as of v7.4.0.

The current release of the generator's `python` generator does not generate entirely valid code.
Specifically the handling of enums is not correct, and they will not serialize to the expected values.
We have added workarounds to api_client.py.
The following info is current as of v7.7.0.

The auto-generated code does not pass flake8, so we have disabled the checks.
4 changes: 2 additions & 2 deletions docs/BaseTraceRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**units** | [**DistanceUnit**](DistanceUnit.md) | | [optional]
**language** | [**ValhallaLanguages**](ValhallaLanguages.md) | | [optional]
**units** | [**DistanceUnit**](DistanceUnit.md) | | [optional] [default to DistanceUnit.KM]
**language** | [**ValhallaLanguages**](ValhallaLanguages.md) | | [optional] [default to ValhallaLanguages.EN_MINUS_US]
**directions_type** | **str** | The level of directional narrative to include. Locations and times will always be returned, but narrative generation verbosity can be controlled with this parameter. | [optional] [default to 'instructions']
**id** | **str** | An identifier to disambiguate requests (echoed by the server). | [optional]
**shape** | [**List[MapMatchWaypoint]**](MapMatchWaypoint.md) | REQUIRED if `encoded_polyline` is not present. Note that `break` type locations are only supported when `shape_match` is set to `map_match`. | [optional]
Expand Down
30 changes: 30 additions & 0 deletions docs/BulkRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# BulkRequest


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**endpoint** | **str** | | [optional]
**query** | [**SearchStructuredQuery**](SearchStructuredQuery.md) | | [optional]

## Example

```python
from stadiamaps.models.bulk_request import BulkRequest

# TODO update the JSON string below
json = "{}"
# create an instance of BulkRequest from a JSON string
bulk_request_instance = BulkRequest.from_json(json)
# print the JSON string representation of the object
print(BulkRequest.to_json())

# convert the object into a dict
bulk_request_dict = bulk_request_instance.to_dict()
# create an instance of BulkRequest from a dict
bulk_request_from_dict = BulkRequest.from_dict(bulk_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


30 changes: 30 additions & 0 deletions docs/BulkSearchRequestInner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# BulkSearchRequestInner


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**endpoint** | **str** | | [optional]
**query** | [**SearchStructuredQuery**](SearchStructuredQuery.md) | | [optional]

## Example

```python
from stadiamaps.models.bulk_search_request_inner import BulkSearchRequestInner

# TODO update the JSON string below
json = "{}"
# create an instance of BulkSearchRequestInner from a JSON string
bulk_search_request_inner_instance = BulkSearchRequestInner.from_json(json)
# print the JSON string representation of the object
print(BulkSearchRequestInner.to_json())

# convert the object into a dict
bulk_search_request_inner_dict = bulk_search_request_inner_instance.to_dict()
# create an instance of BulkSearchRequestInner from a dict
bulk_search_request_inner_from_dict = BulkSearchRequestInner.from_dict(bulk_search_request_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


31 changes: 31 additions & 0 deletions docs/BulkSearchResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# BulkSearchResponse


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **int** | |
**response** | [**PeliasResponse**](PeliasResponse.md) | | [optional]
**msg** | **str** | An error message describing what went wrong (if the status is not 200). | [optional]

## Example

```python
from stadiamaps.models.bulk_search_response import BulkSearchResponse

# TODO update the JSON string below
json = "{}"
# create an instance of BulkSearchResponse from a JSON string
bulk_search_response_instance = BulkSearchResponse.from_json(json)
# print the JSON string representation of the object
print(BulkSearchResponse.to_json())

# convert the object into a dict
bulk_search_response_dict = bulk_search_response_instance.to_dict()
# create an instance of BulkSearchResponse from a dict
bulk_search_response_from_dict = BulkSearchResponse.from_dict(bulk_search_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


23 changes: 20 additions & 3 deletions docs/CostingModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,27 @@

A model which influences the routing based on the type of travel. The costing model affects parameters ranging from which roads are legally accessible to preferences based on comfort or speed. See https://valhalla.github.io/valhalla/api/turn-by-turn/api-reference/#costing-models for in-depth descriptions of each costing model.

## Properties
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `AUTO` (value: `'auto'`)

* `BUS` (value: `'bus'`)

* `TAXI` (value: `'taxi'`)

* `TRUCK` (value: `'truck'`)

* `BICYCLE` (value: `'bicycle'`)

* `BIKESHARE` (value: `'bikeshare'`)

* `MOTOR_SCOOTER` (value: `'motor_scooter'`)

* `MOTORCYCLE` (value: `'motorcycle'`)

* `PEDESTRIAN` (value: `'pedestrian'`)

* `LOW_SPEED_VEHICLE` (value: `'low_speed_vehicle'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
4 changes: 2 additions & 2 deletions docs/DirectionsOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**units** | [**DistanceUnit**](DistanceUnit.md) | | [optional]
**language** | [**ValhallaLanguages**](ValhallaLanguages.md) | | [optional]
**units** | [**DistanceUnit**](DistanceUnit.md) | | [optional] [default to DistanceUnit.KM]
**language** | [**ValhallaLanguages**](ValhallaLanguages.md) | | [optional] [default to ValhallaLanguages.EN_MINUS_US]
**directions_type** | **str** | The level of directional narrative to include. Locations and times will always be returned, but narrative generation verbosity can be controlled with this parameter. | [optional] [default to 'instructions']

## Example
Expand Down
7 changes: 4 additions & 3 deletions docs/DistanceUnit.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# DistanceUnit


## Properties
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `KM` (value: `'km'`)

* `MI` (value: `'mi'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
65 changes: 62 additions & 3 deletions docs/EdgeUse.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,69 @@

The use for the edge.

## Properties
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `ROAD` (value: `'road'`)

* `RAMP` (value: `'ramp'`)

* `TURN_CHANNEL` (value: `'turn_channel'`)

* `TRACK` (value: `'track'`)

* `DRIVEWAY` (value: `'driveway'`)

* `ALLEY` (value: `'alley'`)

* `PARKING_AISLE` (value: `'parking_aisle'`)

* `EMERGENCY_ACCESS` (value: `'emergency_access'`)

* `DRIVE_THROUGH` (value: `'drive_through'`)

* `CULDESAC` (value: `'culdesac'`)

* `LIVING_STREET` (value: `'living_street'`)

* `SERVICE_ROAD` (value: `'service_road'`)

* `CYCLEWAY` (value: `'cycleway'`)

* `MOUNTAIN_BIKE` (value: `'mountain_bike'`)

* `SIDEWALK` (value: `'sidewalk'`)

* `FOOTWAY` (value: `'footway'`)

* `STEPS` (value: `'steps'`)

* `PATH` (value: `'path'`)

* `PEDESTRIAN` (value: `'pedestrian'`)

* `PEDESTRIAN_CROSSING` (value: `'pedestrian_crossing'`)

* `BRIDLEWAY` (value: `'bridleway'`)

* `REST_AREA` (value: `'rest_area'`)

* `SERVICE_AREA` (value: `'service_area'`)

* `OTHER` (value: `'other'`)

* `FERRY` (value: `'ferry'`)

* `RAIL_MINUS_FERRY` (value: `'rail-ferry'`)

* `RAIL` (value: `'rail'`)

* `BUS` (value: `'bus'`)

* `EGRESS_CONNECTION` (value: `'egress_connection'`)

* `PLATFORM_CONNECTION` (value: `'platform_connection'`)

* `TRANSIT_CONNECTION` (value: `'transit_connection'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
Loading

0 comments on commit 5208291

Please sign in to comment.