Skip to content

Commit

Permalink
feat: regenerate using latest v7.1.1 docs
Browse files Browse the repository at this point in the history
- Add snapping service
- Adapt MatrixServiceApi test to new client
- Remove unimplemented test templates
  • Loading branch information
Jakob Stolze committed Mar 11, 2024
1 parent 959bcb0 commit 7827c15
Show file tree
Hide file tree
Showing 275 changed files with 6,305 additions and 4,597 deletions.
23 changes: 23 additions & 0 deletions .swagger-codegen-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Swagger Codegen Ignore
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
1 change: 1 addition & 0 deletions .swagger-codegen/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.0.54
13 changes: 13 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# ref: https://docs.travis-ci.com/user/languages/python
language: python
python:
- "3.2"
- "3.3"
- "3.4"
- "3.5"
#- "3.5-dev" # 3.5 development branch
#- "nightly" # points to the latest development branch e.g. 3.6-dev
# command to install dependencies
install: "pip install -r requirements.txt"
# command to run tests
script: nosetests
42 changes: 32 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ The openrouteservice library gives you painless access to the [openrouteservice]

| API Version | Package version | Build package |
| -------------- | ------------------ | ------------------ |
| 7.1.0 | 7.1.0.post6 | io.swagger.codegen.v3.generators.python.PythonClientCodegen |
| 7.1.1 | 7.1.1 | io.swagger.codegen.v3.generators.python.PythonClientCodegen |

For further details, please visit:
- our [homepage](https://openrouteservice.org)
Expand Down Expand Up @@ -49,10 +49,10 @@ Please follow the [installation procedure](#installation--usage) before running

### Examples
These examples show common usages of this library.
- [Avoid construction sites dynamically](docs/examples/Avoid_ConstructionSites)
- [Dieselgate Routing](docs/examples/Dieselgate_Routing)
- [Route optimization of pub crawl](docs/examples/ortools_pubcrawl)
- [Routing optimization in humanitarian context](docs/examples/Routing_Optimization_Idai)
- [Avoid construction sites dynamically](examples/Avoid_ConstructionSites.ipynb)
- [Dieselgate Routing](examples/Dieselgate_Routing.ipynb)
- [Route optimization of pub crawl](examples/ortools_pubcrawl.ipynb)
- [Routing optimization in humanitarian context](examples/Routing_Optimization_Idai.ipynb)

### Basic example
```python
Expand Down Expand Up @@ -119,9 +119,12 @@ Class | Method | HTTP request | Description
*GeocodeApi* | [**geocode_search_get**](docs/GeocodeApi.md#geocode_search_get) | **GET** /geocode/search | Forward Geocode Service
*GeocodeApi* | [**geocode_search_structured_get**](docs/GeocodeApi.md#geocode_search_structured_get) | **GET** /geocode/search/structured | Structured Forward Geocode Service (beta)
*IsochronesServiceApi* | [**get_default_isochrones**](docs/IsochronesServiceApi.md#get_default_isochrones) | **POST** /v2/isochrones/{profile} | Isochrones Service
*MatrixServiceApi* | [**get_default**](docs/MatrixServiceApi.md#get_default) | **POST** /v2/matrix/{profile} | Matrix Service
*MatrixServiceApi* | [**get_default1**](docs/MatrixServiceApi.md#get_default1) | **POST** /v2/matrix/{profile} | Matrix Service
*OptimizationApi* | [**optimization_post**](docs/OptimizationApi.md#optimization_post) | **POST** /optimization | Optimization Service
*PoisApi* | [**pois_post**](docs/PoisApi.md#pois_post) | **POST** /pois | Pois Service
*SnappingServiceApi* | [**get_default**](docs/SnappingServiceApi.md#get_default) | **POST** /v2/snap/{profile} | Snapping Service
*SnappingServiceApi* | [**get_geo_json_snapping**](docs/SnappingServiceApi.md#get_geo_json_snapping) | **POST** /v2/snap/{profile}/geojson | Snapping Service GeoJSON
*SnappingServiceApi* | [**get_json_snapping**](docs/SnappingServiceApi.md#get_json_snapping) | **POST** /v2/snap/{profile}/json | Snapping Service JSON

## Documentation For Models

Expand All @@ -131,6 +134,9 @@ Class | Method | HTTP request | Description
- [ElevationLineBody](docs/ElevationLineBody.md)
- [ElevationPointBody](docs/ElevationPointBody.md)
- [EngineInfo](docs/EngineInfo.md)
- [GeoJSONFeature](docs/GeoJSONFeature.md)
- [GeoJSONFeatureGeometry](docs/GeoJSONFeatureGeometry.md)
- [GeoJSONFeatureProperties](docs/GeoJSONFeatureProperties.md)
- [GeoJSONFeaturesObject](docs/GeoJSONFeaturesObject.md)
- [GeoJSONGeometryObject](docs/GeoJSONGeometryObject.md)
- [GeoJSONIsochroneBase](docs/GeoJSONIsochroneBase.md)
Expand All @@ -139,12 +145,16 @@ Class | Method | HTTP request | Description
- [GeoJSONIsochronesResponseFeatures](docs/GeoJSONIsochronesResponseFeatures.md)
- [GeoJSONIsochronesResponseMetadata](docs/GeoJSONIsochronesResponseMetadata.md)
- [GeoJSONIsochronesResponseMetadataEngine](docs/GeoJSONIsochronesResponseMetadataEngine.md)
- [GeoJSONPointGeometry](docs/GeoJSONPointGeometry.md)
- [GeoJSONPropertiesObject](docs/GeoJSONPropertiesObject.md)
- [GeoJSONPropertiesObjectCategoryIds](docs/GeoJSONPropertiesObjectCategoryIds.md)
- [GeoJSONPropertiesObjectCategoryIdsCategoryId](docs/GeoJSONPropertiesObjectCategoryIdsCategoryId.md)
- [GeoJSONPropertiesObjectOsmTags](docs/GeoJSONPropertiesObjectOsmTags.md)
- [GeoJSONRouteResponse](docs/GeoJSONRouteResponse.md)
- [GeoJSONRouteResponseMetadata](docs/GeoJSONRouteResponseMetadata.md)
- [GeoJSONSnappingResponse](docs/GeoJSONSnappingResponse.md)
- [GeoJSONSnappingResponseFeatures](docs/GeoJSONSnappingResponseFeatures.md)
- [GeoJSONSnappingResponseMetadata](docs/GeoJSONSnappingResponseMetadata.md)
- [GeocodeResponse](docs/GeocodeResponse.md)
- [Gpx](docs/Gpx.md)
- [GraphExportService](docs/GraphExportService.md)
Expand All @@ -156,10 +166,13 @@ Class | Method | HTTP request | Description
- [InlineResponse2002Steps](docs/InlineResponse2002Steps.md)
- [InlineResponse2002Summary](docs/InlineResponse2002Summary.md)
- [InlineResponse2002Unassigned](docs/InlineResponse2002Unassigned.md)
- [InlineResponse2002Violations](docs/InlineResponse2002Violations.md)
- [InlineResponse2003](docs/InlineResponse2003.md)
- [InlineResponse2004](docs/InlineResponse2004.md)
- [InlineResponse2005](docs/InlineResponse2005.md)
- [InlineResponse2006](docs/InlineResponse2006.md)
- [InlineResponse2007](docs/InlineResponse2007.md)
- [InlineResponse2008](docs/InlineResponse2008.md)
- [InlineResponse200Geometry](docs/InlineResponse200Geometry.md)
- [IsochronesProfileBody](docs/IsochronesProfileBody.md)
- [IsochronesRequest](docs/IsochronesRequest.md)
Expand All @@ -178,6 +191,7 @@ Class | Method | HTTP request | Description
- [JSONIndividualRouteResponseSummary](docs/JSONIndividualRouteResponseSummary.md)
- [JSONIndividualRouteResponseWarnings](docs/JSONIndividualRouteResponseWarnings.md)
- [JSONLeg](docs/JSONLeg.md)
- [JSONLocation](docs/JSONLocation.md)
- [JSONObject](docs/JSONObject.md)
- [JSONPtStop](docs/JSONPtStop.md)
- [JSONRouteResponse](docs/JSONRouteResponse.md)
Expand All @@ -204,11 +218,18 @@ Class | Method | HTTP request | Description
- [OpenpoiservicePoiRequest](docs/OpenpoiservicePoiRequest.md)
- [OpenpoiservicePoiResponse](docs/OpenpoiservicePoiResponse.md)
- [OptimizationBody](docs/OptimizationBody.md)
- [OptimizationBreaks](docs/OptimizationBreaks.md)
- [OptimizationCosts](docs/OptimizationCosts.md)
- [OptimizationJobs](docs/OptimizationJobs.md)
- [OptimizationMatrices](docs/OptimizationMatrices.md)
- [OptimizationMatricesCyclingelectric](docs/OptimizationMatricesCyclingelectric.md)
- [OptimizationOptions](docs/OptimizationOptions.md)
- [OptimizationSteps](docs/OptimizationSteps.md)
- [OptimizationVehicles](docs/OptimizationVehicles.md)
- [PoisFilters](docs/PoisFilters.md)
- [PoisGeometry](docs/PoisGeometry.md)
- [ProfileGeojsonBody](docs/ProfileGeojsonBody.md)
- [ProfileJsonBody](docs/ProfileJsonBody.md)
- [ProfileParameters](docs/ProfileParameters.md)
- [ProfileParametersRestrictions](docs/ProfileParametersRestrictions.md)
- [ProfileWeightings](docs/ProfileWeightings.md)
Expand All @@ -218,10 +239,11 @@ Class | Method | HTTP request | Description
- [RouteOptionsAvoidPolygons](docs/RouteOptionsAvoidPolygons.md)
- [RouteResponseInfo](docs/RouteResponseInfo.md)
- [Rte](docs/Rte.md)
- [V2directionsprofilegeojsonScheduleDuration](docs/V2directionsprofilegeojsonScheduleDuration.md)
- [V2directionsprofilegeojsonScheduleDurationDuration](docs/V2directionsprofilegeojsonScheduleDurationDuration.md)
- [V2directionsprofilegeojsonScheduleDurationUnits](docs/V2directionsprofilegeojsonScheduleDurationUnits.md)
- [V2directionsprofilegeojsonWalkingTime](docs/V2directionsprofilegeojsonWalkingTime.md)
- [SnapProfileBody](docs/SnapProfileBody.md)
- [SnappingRequest](docs/SnappingRequest.md)
- [SnappingResponse](docs/SnappingResponse.md)
- [SnappingResponseInfo](docs/SnappingResponseInfo.md)
- [SnappingResponseLocations](docs/SnappingResponseLocations.md)

## Author

Expand Down
4 changes: 2 additions & 2 deletions docs/DirectionsService.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ Name | Type | Description | Notes
**radiuses** | **list[float]** | A list of maximum distances (measured in metres) that limit the search of nearby road segments to every given waypoint. The values must be greater than 0, the value of -1 specifies using the maximum possible search radius. The number of radiuses correspond to the number of waypoints. If only a single value is given, it will be applied to all waypoints. | [optional]
**roundabout_exits** | **bool** | Provides bearings of the entrance and all passed roundabout exits. Adds the `exit_bearings` array to the step object in the response. | [optional] [default to False]
**schedule** | **bool** | If true, return a public transport schedule starting at <departure> for the next <schedule_duration> minutes. | [optional] [default to False]
**schedule_duration** | [**V2directionsprofilegeojsonScheduleDuration**](V2directionsprofilegeojsonScheduleDuration.md) | | [optional]
**schedule_duration** | **str** | The time window when requesting a public transport schedule. The format is passed as ISO 8601 duration: https://en.wikipedia.org/wiki/ISO_8601#Durations | [optional]
**schedule_rows** | **int** | The maximum amount of entries that should be returned when requesting a schedule. | [optional]
**skip_segments** | **list[int]** | Specifies the segments that should be skipped in the route calculation. A segment is the connection between two given coordinates and the counting starts with 1 for the connection between the first and second coordinate. | [optional]
**suppress_warnings** | **bool** | Suppress warning messages in the response | [optional]
**units** | **str** | Specifies the distance unit. | [optional] [default to 'm']
**walking_time** | [**V2directionsprofilegeojsonWalkingTime**](V2directionsprofilegeojsonWalkingTime.md) | | [optional]
**walking_time** | **str** | Maximum duration for walking access and egress of public transport. The value is passed in ISO 8601 duration format: https://en.wikipedia.org/wiki/ISO_8601#Durations | [optional] [default to 'PT15M']

[[Back to Model list]](../README.md#documentation_for_models) [[Back to API list]](../README.md#documentation_for_api_endpoints) [[Back to README]](../README.md)

4 changes: 2 additions & 2 deletions docs/DirectionsService1.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ Name | Type | Description | Notes
**radiuses** | **list[float]** | A list of maximum distances (measured in metres) that limit the search of nearby road segments to every given waypoint. The values must be greater than 0, the value of -1 specifies using the maximum possible search radius. The number of radiuses correspond to the number of waypoints. If only a single value is given, it will be applied to all waypoints. | [optional]
**roundabout_exits** | **bool** | Provides bearings of the entrance and all passed roundabout exits. Adds the `exit_bearings` array to the step object in the response. | [optional] [default to False]
**schedule** | **bool** | If true, return a public transport schedule starting at <departure> for the next <schedule_duration> minutes. | [optional] [default to False]
**schedule_duration** | [**V2directionsprofilegeojsonScheduleDuration**](V2directionsprofilegeojsonScheduleDuration.md) | | [optional]
**schedule_duration** | **str** | The time window when requesting a public transport schedule. The format is passed as ISO 8601 duration: https://en.wikipedia.org/wiki/ISO_8601#Durations | [optional]
**schedule_rows** | **int** | The maximum amount of entries that should be returned when requesting a schedule. | [optional]
**skip_segments** | **list[int]** | Specifies the segments that should be skipped in the route calculation. A segment is the connection between two given coordinates and the counting starts with 1 for the connection between the first and second coordinate. | [optional]
**suppress_warnings** | **bool** | Suppress warning messages in the response | [optional]
**units** | **str** | Specifies the distance unit. | [optional] [default to 'm']
**walking_time** | [**V2directionsprofilegeojsonWalkingTime**](V2directionsprofilegeojsonWalkingTime.md) | | [optional]
**walking_time** | **str** | Maximum duration for walking access and egress of public transport. The value is passed in ISO 8601 duration format: https://en.wikipedia.org/wiki/ISO_8601#Durations | [optional] [default to 'PT15M']

[[Back to Model list]](../README.md#documentation_for_models) [[Back to API list]](../README.md#documentation_for_api_endpoints) [[Back to README]](../README.md)

8 changes: 4 additions & 4 deletions docs/ElevationApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Method | HTTP request | Description
Elevation Line Service

This endpoint can take planar 2D line objects and enrich them with elevation from a variety of datasets. The input and output formats are: * GeoJSON * Polyline * <a href="https://developers.google.com/maps/documentation/utilities/polylinealgorithm">Google's Encoded polyline</a> with coordinate precision 5 or 6 Example: ``` # POST LineString as polyline curl -XPOST https://api.openrouteservice.org/elevation/line -H 'Content-Type: application/json' \\ -H 'Authorization: INSERT_YOUR_KEY -d '{ \"format_in\": \"polyline\", \"format_out\": \"encodedpolyline5\", \"geometry\": [[13.349762, 38.112952], [12.638397, 37.645772]] }' ```
This endpoint can take planar 2D line objects and enrich them with elevation from a variety of datasets. The input and output formats are: * GeoJSON * Polyline * <a href=\"https://developers.google.com/maps/documentation/utilities/polylinealgorithm\">Google's Encoded polyline</a> with coordinate precision 5 or 6 Example: ``` # POST LineString as polyline curl -XPOST https://api.openrouteservice.org/elevation/line -H 'Content-Type: application/json' \\ -H 'Authorization: INSERT_YOUR_KEY -d '{ \"format_in\": \"polyline\", \"format_out\": \"encodedpolyline5\", \"geometry\": [[13.349762, 38.112952], [12.638397, 37.645772]] }' ```

### Example
```python
Expand Down Expand Up @@ -58,7 +58,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json
- **Accept**: application/json, */*

[[Back to top]](#) [[Back to API list]](../README.md#documentation_for_api_endpoints) [[Back to Model list]](../README.md#documentation_for_models) [[Back to README]](../README.md)

Expand Down Expand Up @@ -116,7 +116,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json
- **Accept**: application/json, */*

[[Back to top]](#) [[Back to API list]](../README.md#documentation_for_api_endpoints) [[Back to Model list]](../README.md#documentation_for_models) [[Back to README]](../README.md)

Expand Down Expand Up @@ -170,7 +170,7 @@ Name | Type | Description | Notes
### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json
- **Accept**: application/json, */*

[[Back to top]](#) [[Back to API list]](../README.md#documentation_for_api_endpoints) [[Back to Model list]](../README.md#documentation_for_models) [[Back to README]](../README.md)

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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**geometry** | [**GeoJSONFeatureGeometry**](GeoJSONFeatureGeometry.md) | | [optional]
**properties** | [**GeoJSONFeatureProperties**](GeoJSONFeatureProperties.md) | | [optional]
**type** | **str** | GeoJSON type | [optional] [default to 'Feature']

[[Back to Model list]](../README.md#documentation_for_models) [[Back to API list]](../README.md#documentation_for_api_endpoints) [[Back to README]](../README.md)

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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**coordinates** | **list[float]** | Lon/Lat coordinates of the snapped location | [optional]
**type** | **str** | GeoJSON type | [optional] [default to 'Point']

[[Back to Model list]](../README.md#documentation_for_models) [[Back to API list]](../README.md#documentation_for_api_endpoints) [[Back to README]](../README.md)

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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | \&quot;Name of the street the closest accessible point is situated on. Only for &#x60;resolve_locations&#x3D;true&#x60; and only if name is available. | [optional]
**snapped_distance** | **float** | Distance between the &#x60;source/destination&#x60; Location and the used point on the routing graph in meters. | [optional]
**source_id** | **int** | Index of the requested location | [optional]

[[Back to Model list]](../README.md#documentation_for_models) [[Back to API list]](../README.md#documentation_for_api_endpoints) [[Back to README]](../README.md)

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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**coordinates** | **list[float]** | Lon/Lat coordinates of the snapped location | [optional]
**type** | **str** | GeoJSON type | [optional] [default to 'Point']

[[Back to Model list]](../README.md#documentation_for_models) [[Back to API list]](../README.md#documentation_for_api_endpoints) [[Back to README]](../README.md)

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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bbox** | **list[float]** | Bounding box that covers all returned snapping points | [optional]
**features** | [**list[GeoJSONSnappingResponseFeatures]**](GeoJSONSnappingResponseFeatures.md) | Information about the service and request | [optional]
**metadata** | [**GeoJSONSnappingResponseMetadata**](GeoJSONSnappingResponseMetadata.md) | | [optional]
**type** | **str** | GeoJSON type | [optional] [default to 'FeatureCollection']

[[Back to Model list]](../README.md#documentation_for_models) [[Back to API list]](../README.md#documentation_for_api_endpoints) [[Back to README]](../README.md)

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

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**geometry** | [**GeoJSONFeatureGeometry**](GeoJSONFeatureGeometry.md) | | [optional]
**properties** | [**GeoJSONFeatureProperties**](GeoJSONFeatureProperties.md) | | [optional]
**type** | **str** | GeoJSON type | [optional] [default to 'Feature']

[[Back to Model list]](../README.md#documentation_for_models) [[Back to API list]](../README.md#documentation_for_api_endpoints) [[Back to README]](../README.md)

Loading

0 comments on commit 7827c15

Please sign in to comment.