Generated update. Please review before merging.

GIScience · Apr 10, 2024 · 5f9ddd6 · 5f9ddd6
1 parent 8d52e26
commit 5f9ddd6
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 113 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,9 @@
-# openrouteservice
+# openrouteservice-py
+> [!IMPORTANT]  
+> The new version of `openrouteservice-py` is generated using swagger-codegen and is **not compatible** with the old SDK. However the methods of the old client are still available and marked as deprecated in the new SDK during a transition phase.  
+>  
+> Please migrate your project to the new SDK to be able to access all new features of the openrouteservice!
+
 The openrouteservice library gives you painless access to the [openrouteservice](https://openrouteservice.org) (ORS) routing API's. This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) using our latest API specifications.
 
 | API Version    | Package version    | Build package      |

diff --git a/docs/DirectionsServiceApi.md b/docs/DirectionsServiceApi.md
@@ -1,5 +1,8 @@
 # openrouteservice.DirectionsServiceApi
 
+> [!NOTE]  
+> This documentation is automatically generated. Code examples might not work out of the box as not all required parameters are passed.
+
 All URIs are relative to *https://api.openrouteservice.org*
 
 Method | HTTP request | Description
@@ -22,14 +25,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.DirectionsServiceApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.DirectionsServiceApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 body = openrouteservice.DirectionsServiceBody() # DirectionsServiceBody | 
 profile = 'profile_example' # str | Specifies the route profile.
 
@@ -78,14 +75,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.DirectionsServiceApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.DirectionsServiceApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 body = openrouteservice.DirectionsServiceBody() # DirectionsServiceBody | 
 profile = 'profile_example' # str | Specifies the route profile.
 

diff --git a/docs/ElevationApi.md b/docs/ElevationApi.md
@@ -1,5 +1,8 @@
 # openrouteservice.ElevationApi
 
+> [!NOTE]  
+> This documentation is automatically generated. Code examples might not work out of the box as not all required parameters are passed.
+
 All URIs are relative to *https://api.openrouteservice.org*
 
 Method | HTTP request | Description
@@ -23,14 +26,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.ElevationApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.ElevationApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 body = openrouteservice.ElevationLineBody() # ElevationLineBody | Query the elevation of a line in various formats.
 
 try:
@@ -77,14 +74,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.ElevationApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.ElevationApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 geometry = [3.4] # list[float] | The point to be queried, in comma-separated lon,lat values, e.g. [13.349762, 38.11295]
 format_out = 'geojson' # str | The output format to be returned. (optional) (default to geojson)
 dataset = 'srtm' # str | The elevation dataset to be used. (optional) (default to srtm)
@@ -135,14 +126,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.ElevationApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.ElevationApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 body = openrouteservice.ElevationPointBody() # ElevationPointBody | Query the elevation of a point in various formats.
 
 try:

diff --git a/docs/GeocodeApi.md b/docs/GeocodeApi.md
@@ -1,5 +1,8 @@
 # openrouteservice.GeocodeApi
 
+> [!NOTE]  
+> This documentation is automatically generated. Code examples might not work out of the box as not all required parameters are passed.
+
 All URIs are relative to *https://api.openrouteservice.org*
 
 Method | HTTP request | Description
@@ -24,14 +27,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.GeocodeApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.GeocodeApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 text = 'text_example' # str | Name of location, street address or postal code. 
 focus_point_lon = 3.4 # float | Longitude of the `focus.point`. Specify the focus point to order results by linear distance to this point. Works for up to 100 kilometers distance.  Use with `focus.point.lat`.  (optional)
 focus_point_lat = 3.4 # float | Latitude of the `focus.point`. Specify the focus point to order results by linear distance to this point. Works for up to 100 kilometers distance. Use with `focus.point.lon`.  (optional)
@@ -96,14 +93,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.GeocodeApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.GeocodeApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 point_lon = 3.4 # float | Longitude of the coordinate to query. 
 point_lat = 48.858268 # float | Latitude of the coordinate to query.  (default to 48.858268)
 boundary_circle_radius = 1 # float | Restrict search to circular region around `point.lat/point.lon`. Value in kilometers.  (optional) (default to 1)
@@ -162,14 +153,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.GeocodeApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.GeocodeApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 text = 'text_example' # str | Name of location, street address or postal code. 
 focus_point_lon = 3.4 # float | Longitude of the `focus.point`. Specify the focus point to order results by linear distance to this point. Works for up to 100 kilometers distance.  Use with `focus.point.lat`.  (optional)
 focus_point_lat = 3.4 # float | Latitude of the `focus.point`. Specify the focus point to order results by linear distance to this point. Works for up to 100 kilometers distance. Use with `focus.point.lon`.  (optional)
@@ -244,14 +229,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.GeocodeApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.GeocodeApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 address = 'address_example' # str | Search for full address with house number or only a street name.  (optional)
 neighbourhood = 'neighbourhood_example' # str | Search for neighbourhoods. Neighbourhoods are vernacular geographic entities that may not necessarily be official administrative divisions but are important nonetheless. Example: `Notting Hill`.  (optional)
 country = 'country_example' # str | Search for full country name, [alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) or [alpha 3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) codes.  (optional)

diff --git a/docs/IsochronesServiceApi.md b/docs/IsochronesServiceApi.md
@@ -1,5 +1,8 @@
 # openrouteservice.IsochronesServiceApi
 
+> [!NOTE]  
+> This documentation is automatically generated. Code examples might not work out of the box as not all required parameters are passed.
+
 All URIs are relative to *https://api.openrouteservice.org*
 
 Method | HTTP request | Description
@@ -21,14 +24,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.IsochronesServiceApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.IsochronesServiceApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 body = openrouteservice.IsochronesProfileBody() # IsochronesProfileBody | 
 profile = 'profile_example' # str | Specifies the route profile.
 

diff --git a/docs/MatrixServiceApi.md b/docs/MatrixServiceApi.md
@@ -1,5 +1,8 @@
 # openrouteservice.MatrixServiceApi
 
+> [!NOTE]  
+> This documentation is automatically generated. Code examples might not work out of the box as not all required parameters are passed.
+
 All URIs are relative to *https://api.openrouteservice.org*
 
 Method | HTTP request | Description
@@ -21,14 +24,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.MatrixServiceApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.MatrixServiceApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 body = openrouteservice.MatrixProfileBody() # MatrixProfileBody | 
 profile = 'profile_example' # str | Specifies the matrix profile.
 

diff --git a/docs/OptimizationApi.md b/docs/OptimizationApi.md
@@ -1,5 +1,8 @@
 # openrouteservice.OptimizationApi
 
+> [!NOTE]  
+> This documentation is automatically generated. Code examples might not work out of the box as not all required parameters are passed.
+
 All URIs are relative to *https://api.openrouteservice.org*
 
 Method | HTTP request | Description
@@ -21,14 +24,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.OptimizationApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.OptimizationApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 body = openrouteservice.OptimizationBody() # OptimizationBody | The request body of the optimization request.
 
 try:

diff --git a/docs/PoisApi.md b/docs/PoisApi.md
@@ -1,5 +1,8 @@
 # openrouteservice.PoisApi
 
+> [!NOTE]  
+> This documentation is automatically generated. Code examples might not work out of the box as not all required parameters are passed.
+
 All URIs are relative to *https://api.openrouteservice.org*
 
 Method | HTTP request | Description
@@ -21,14 +24,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.PoisApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.PoisApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 body = openrouteservice.OpenpoiservicePoiRequest() # OpenpoiservicePoiRequest | body for a post request
 
 try:

diff --git a/docs/SnappingServiceApi.md b/docs/SnappingServiceApi.md
@@ -1,5 +1,8 @@
 # openrouteservice.SnappingServiceApi
 
+> [!NOTE]  
+> This documentation is automatically generated. Code examples might not work out of the box as not all required parameters are passed.
+
 All URIs are relative to *https://api.openrouteservice.org*
 
 Method | HTTP request | Description
@@ -23,14 +26,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.SnappingServiceApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.SnappingServiceApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 body = openrouteservice.SnapProfileBody() # SnapProfileBody | 
 profile = 'profile_example' # str | Specifies the route profile.
 
@@ -79,14 +76,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.SnappingServiceApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.SnappingServiceApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 body = openrouteservice.ProfileGeojsonBody() # ProfileGeojsonBody | 
 profile = 'profile_example' # str | Specifies the profile.
 
@@ -135,14 +126,8 @@ import openrouteservice
 from openrouteservice.rest import ApiException
 from pprint import pprint
 
-# Configure API key authorization: ApiKeyAuth
-configuration = openrouteservice.Configuration()
-configuration.api_key['Authorization'] = 'YOUR_API_KEY'
-# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-# configuration.api_key_prefix['Authorization'] = 'Bearer'
-
 # create an instance of the API class
-api_instance = openrouteservice.SnappingServiceApi(openrouteservice.ApiClient(configuration))
+api_instance = openrouteservice.SnappingServiceApi(openrouteservice.apiClient(apiKey='YOUR_API_KEY'))
 body = openrouteservice.ProfileJsonBody() # ProfileJsonBody | 
 profile = 'profile_example' # str | Specifies the profile.