All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
This fixes issues in the OpenAPI generated code which result in compiler crashes for users of the Xcode 16 RC. See OpenAPITools/openapi-generator#19564 for details.
- Support for the OSRM format and navigation aids
- BREAKING: To support the new format, the response type of directions APIs has changed
You will now need to match against the response enum, which has variants for each response. This enables you to build your apps in a type-safe manner. Here is an example:
let req = RouteRequest(units: .mi,
format: .osrm,
bannerInstructions: true,
filters: AnnotationFilters(action: .include, attributes: [
.speedLimit,
]),
id: "route",
locations: [
RoutingWaypoint(lat: locationA.lat, lon: locationA.lon),
RoutingWaypoint(lat: locationB.lat, lon: locationB.lon),
],
costing: .auto,
costingOptions: CostingOptions(auto: AutoCostingOptions(useHighways: 0.3)))
guard case let .typeOsrmRouteResponse(res) = try await RoutingAPI.route(routeRequest: req) else {
XCTFail("Expected an OSRM format route response")
return
}
- Simplified bulk geocoding request models
- Add support for bulk geocoding
- Isochrone request models now support all costing models
- Remove optional id field which was always null
- Add support for elevation in route responses
- Add support for low-speed vehicle routing
- The matrix endpoint now accepts its own model rather than coordinate. This includes a search cutoff and paves the way for future expansion.
- Improved the documentation of the matrix endpoint failure modes
- The time and distance field on matrix source to target models are now marked as nullable
ignore_
options for ignoring various restrictions (useful for certain map matching applications)
- BREAKING: Directions Options are moved from a nested object to the root of all turn-by-turn directions APIs. Simply remove the nesting and apply any quick fixes regarding argument ordering.
- BREAKING: The OpenAPI generator has reordered several arguments in the shuffle. Quick fixes in Xcode should help.
- FIXED: Reflect upstream changes to the time/distance matrix API returning a single dimensional list of sources and targets; the extra layer of nesting is removed and may break existing code (this was a bug fix).
- Improved documentation strings.
- Alley factor for auto costing
- Resample distance parameter to height (elevation) requests
- Support for requesting alternate routes
- Missing cases to the travel type enum
- Minor improvements to docs
Initial release!