Skip to content

Commit

Permalink
docs: fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
koebi authored and TheGreatRefrigerator committed Feb 13, 2024
1 parent 5ba4ee0 commit 2c57496
Show file tree
Hide file tree
Showing 28 changed files with 64 additions and 64 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

The **openrouteservice API** provides global spatial services by consuming user-generated and collaboratively collected free geographic data directly from [OpenStreetMap](http://www.openstreetmap.org). It is highly customizable, performant and written in Java.

The following services are available via a HTTP interface served by Tomcat.
The following services are available via an HTTP interface served by Tomcat.
- **Directions** - Returns a route between two or more locations for a selected profile with customizable additional settings and instructions.
- **Isochrones** - Obtains areas of reachability from given locations.
- **Matrix** - Computes one-to-many, many-to-one or many-to-many routes for any mode of transport provided by openrouteservice.
Expand Down Expand Up @@ -65,7 +65,7 @@ For instructions on how to [build from source](https://GIScience.github.io/openr

## Usage

Openrouteservice offers a set of endpoints for different spatial purposes. By default they will be available at
Openrouteservice offers a set of endpoints for different spatial purposes. By default, they will be available at

- `http://localhost:8080/ors/v2/directions`
- `http://localhost:8080/ors/v2/isochrones`
Expand All @@ -75,7 +75,7 @@ You can find more information in the [Installation and Usage Instructions](https

## API Documentation

For an easy and interactive way to test the api, visit our API documentation at [openrouteservice.org](https://openrouteservice.org/dev/#/api-docs).
For an easy and interactive way to test the api, visit our [API Playground](https://openrouteservice.org/dev/#/api-docs).
After obtaining your key you can try out the different endpoints instantly and start firing requests.


Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/endpoints/directions/extra-info/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The following table lists the possible values for the request as well as the key
| waycategory | Specific categories of parts of the route (tollways, highways, fords etc.) | `waycategory` | [Category IDs](waycategory.md) |
| waytype | Types of roads and paths that are used in the route | `waytypes`¹ | [Type IDs](waytype.md) |
| tollways | Any tollways that the route crosses. Whether a way is marked as [tollway](https://wiki.openstreetmap.org/wiki/Key:toll) depends on `profile` | `tollways` | 0 (no tollway) or 1 (tollway) |
| traildifficulty | The difficulty of parts of the way based on sac or mountainbike scales | `traildifficulty` | [Difficulty IDs](trail-difficulty.md) |
| traildifficulty | The difficulty of parts of the way based on sac or mountain bike scales | `traildifficulty` | [Difficulty IDs](trail-difficulty.md) |
| osmid | The [OpenStreetMap way IDs](https://wiki.openstreetmap.org/wiki/Elements#id) of the ways the route uses | `osmId`¹ | |
| roadaccessrestrictions | Information about ways that may have access restrictions (e.g. private roads, destination only) | `roadaccessrestrictions` | [Restrictions IDs](road-access-restrictions.md) |
| countryinfo | Which country parts of the way lies in | `countryinfo` | [Country IDs](/technical-details/country-list.md) |
Expand All @@ -31,9 +31,9 @@ The following table lists the possible values for the request as well as the key
| shadow² | How sunny the parts of the route are are | `shadow` | 0 (completely in the shadow) - 10 (completely in the sun) |
| csv² | Experimental feature: Generic extra information from provided csv file(s) | `csv` | custom values |

*¹) Note the different keys in request and response!*
*¹ Note the different keys in request and response!*

*²) No data available in the public openrouteservice hosted by HeiGIT*
*² No data available in the public openrouteservice hosted by HeiGIT*


## Extra Info Availability
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Value list for the directions response values in
$.routes[*].extras.waycategory.values
```

The exponential assignment of the values is used for [bit fields](http://eddmann.com/posts/using-bit-flags-and-enumsets-in-java/). One route section may belong to different categories. Hence a value of ``97`` would indicate a belonging to ``Paved road``, ``Tunnel`` and ``Highway`` (``64`` + ``32`` + ``1`` ).
The exponential assignment of the values is used for [bit fields](http://eddmann.com/posts/using-bit-flags-and-enumsets-in-java/). One route section may belong to different categories. Hence, a value of ``97`` would indicate a belonging to ``Paved road``, ``Tunnel`` and ``Highway`` (``64`` + ``32`` + ``1`` ).

| Value | Name | Corresponding tag(s) |
|:-----:|:-----------:|:-------------------------------------------:|
Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/endpoints/directions/instruction-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@

The following table contains the encoding of the instruction types present in the `type`-field of a directions response in a step of a segment of a route.

JSONPath in json response:
JSON-Path in json response:
```jsonpath
$.routes[*].segments[*].steps[*].type
```

JSONPath in geojson response:
JSON-Path in geojson response:
```jsonpath
$.features[*].properties.segments[*].steps[*].type
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The **JSON** return type is best suited for further processing.

### GPX

The **GPX** return type is a XML dialect from openrouteservice based on the [GPS Exchange Format](https://www.topografix.com/gpx.asp) with an own [XML Schema](https://raw.githubusercontent.com/GIScience/openrouteservice-schema/main/gpx/v2/ors-gpx.xsd).
The **GPX** return type is an XML dialect from openrouteservice based on the [GPS Exchange Format](https://www.topografix.com/gpx.asp) with an own [XML Schema](https://raw.githubusercontent.com/GIScience/openrouteservice-schema/main/gpx/v2/ors-gpx.xsd).
It is a very old standard for lightweight interchange of GPS data and thus being used by hundreds of software programs and Web services.

### GeoJSON
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Route Attributes

With the request body parameter `attributes`, additional attributes of route segements can be requestd in a directions request:
With the request body parameter `attributes`, additional attributes of route segments can be requested in a directions request:

```json
"attributes":["avgspeed","detourfactor","percentage"]
Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/endpoints/directions/routing-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ An object of additional routing parameters for all profiles except `driving-car`
Weightings will prioritize specified factors over the shortest path.
The value is an object that can have the following properties:

* `steepness_difficulty`: Integer specifying the fitness level for **`cycling-*`** profiles. The prefered gradient increases with the value.
* `steepness_difficulty`: Integer specifying the fitness level for **`cycling-*`** profiles. The preferred gradient increases with the value.

| Value | Fitness level |
|-------|---------------|
Expand Down Expand Up @@ -80,7 +80,7 @@ An object specifying restrictions for `cycling-*`, `driving-hgv` or `wheelchair`
| `length` | Number | Length restriction in meters. |
| `width` | Number | Width restriction in meters. |
| `height` | Number | Height restriction in meters. |
| `axleload` | Number | Axleload restriction in tons. |
| `axleload` | Number | Axle load restriction in tons. |
| `weight` | Number | Weight restriction in tons. |
| `hazmat` | Boolean | Specifies whether to use appropriate routing for delivering hazardous goods and avoiding water protected areas. Default is false. |

Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/endpoints/elevation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ Just like the openrouteservice, the elevation service is also accessible via our

Details on how to use it can be found in our [API Playground](https://openrouteservice.org/dev/#/api-docs/elevation).

If you need deeper insights or want to run your own instance, please visit our Github project [openelevationservice](https://github.com/GIScience/openelevationservice).
If you need deeper insights or want to run your own instance, please visit our GitHub project [openelevationservice](https://github.com/GIScience/openelevationservice).
2 changes: 1 addition & 1 deletion docs/api-reference/endpoints/export/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ curl -X 'POST' \
```

The response contains nodes and edges in the bounding box relevant for this routing profile.
The edge entry `weight` contains the fastest car durations in seconds:
The edge entry `weight` contains the fastest car duration in seconds:

```json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/endpoints/geocoder/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This endpoint is not part of the openrouteservice, but of our public API. It is
:::

The Geocoder Endpoint of our public API is served by a [Pelias](https://www.pelias.io) instance.
It resolves geo coordinates to addresses and vice versa.
It resolves geographic coordinates to addresses and vice versa.

Our public API exposes these endpoints:

Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/endpoints/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ a separate local installation:

* [POI Service](poi/index.md): Stand-Alone service from HeiGIT that returns points of interest in the area surrounding a geometry
* [Elevation Service](elevation/index.md): Stand-Alone service from HeiGIT that returns the elevation for point or line geometries
* [Geocoder Service](geocoder/index.md): Third Party Service ([Pelias](https://www.pelias.io)) hosted by HeiGIT that resolves geo coordinates to addresses and vice versa
* [Optimization Service](optimization/index.md): Third Party Service ([vroom](https://github.com/VROOM-Project/vroom)) hosted by HeiGIT that optimizes routes for vehicle fleets
* [Geocoding Service](geocoder/index.md): Third Party Service ([Pelias](https://www.pelias.io)) hosted by HeiGIT that resolves geographic coordinates to addresses and vice versa
* [Optimization Service](optimization/index.md): Third Party Service ([VROOM](https://github.com/VROOM-Project/vroom)) hosted by HeiGIT that optimizes routes for vehicle fleets
10 changes: 5 additions & 5 deletions docs/api-reference/endpoints/matrix/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@ To specify, from which to which of these locations the metric should be calculat
```

The numbers in both parameter value arrays represent the index of the locations array in the same request.
In the example above, the durations from the first (0) and second (1) location to the third (2) and fourth (3) location will be calculated:
In the example above, the duration from the first (0) and second (1) location to the third (2) and fourth (3) location will be calculated:

0 -> 2
0 -> 3
1 -> 2
1 -> 3

In the response, the results are contained in the node `durations`.
Here, the first array contains the durations from the first source (0) to both destinations (2 and 3),
and the second array contains the durations from the second source (1) to both destinations (2 and 3):
Here, the first array contains the duration from the first source (0) to both destinations (2 and 3),
and the second array contains the duration from the second source (1) to both destinations (2 and 3):

```json
"durations": [
Expand All @@ -51,10 +51,10 @@ and the second array contains the durations from the second source (1) to both d
If `sources` or `destinations` is not specified in the request, each of both defaults to "all locations".
If for example the locations array has 5 entries,
the sources array has only one entry `[0]`,
and `destinations` is missing, then durations are calculated from location 0 to all locations in the location list.
and `destinations` is missing, then duration are calculated from location 0 to all locations in the location list.

The first entry in the result `durations` list represents the duration from location 0 to itself and is `0`.

To specify whether distances or durations (or both) are to be calculated, the `metrics` parameter can be set accordingly.
To specify whether distances or duration (or both) are to be calculated, the `metrics` parameter can be set accordingly.

For details about all request parameters and the response type, see the [API Playground](https://openrouteservice.org/dev/#/api-docs/matrix_service).
2 changes: 1 addition & 1 deletion docs/api-reference/endpoints/optimization/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ good solutions to various real-life vehicle routing problems (VRP) within a smal

Details on how to use it can be found in our [API Playground](https://openrouteservice.org/dev/#/api-docs/optimization).

If you need deeper insights or want to run your own instance, please visit the Github project [vroom](https://github.com/VROOM-Project/vroom).
If you need deeper insights or want to run your own instance, please visit the GitHub project [VROOM](https://github.com/VROOM-Project/vroom).
6 changes: 3 additions & 3 deletions docs/api-reference/endpoints/poi/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
This endpoint is not part of the openrouteservice, but of our public API. It is not available when running an own instance of openrouteservice.
:::

The [openpoiservice](https://github.com/GIScience/openpoiservice) is a Stand-Alone service from HeiGIT that returns
The [openpoiservice](https://github.com/GIScience/openpoiservice) is a stand-alone service from HeiGIT that returns
points of interest in the area surrounding a geometry.

It is a separate flask-based python application and lives in a
separate [github repository](https://github.com/GIScience/openpoiservice), where you can also find more detailed
separate [GitHub repository](https://github.com/GIScience/openpoiservice), where you can also find more detailed
documentation.

A complete and concise overview of all request parameters and return types can be found in
Expand Down Expand Up @@ -267,7 +267,7 @@ Categories listed by group
| car_rental | 589 | | heliport | 599 | | stop_area | 609 |
| car_repair | 590 | | motorcycle_parking | 600 | | station | 610 |

Note, that `station` appears once as a railway station (604) and once as a general public transport station (610).
Note, that `station` appears once as a railway station (604) and once as a public transport station (610).

#### tourism : 620

Expand Down
8 changes: 4 additions & 4 deletions docs/api-reference/error-codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The following table describes the supported HTTP status codes.
| 200 | Standard response for successfully processed requests. |
| 400 | The request is incorrect and therefore can not be processed. |
| 404 | The end point is not available, or a given request completed successfully but found no results. |
| 405 | The specified HTTP method is not supported. For more details, refer to the EndPoint documentation. |
| 405 | The specified HTTP method is not supported. For more details, refer to the Endpoint documentation. |
| 413 | The request is larger than the server is able to process, the data provided in the request exceeds the capacity limit. |
| 500 | An unexpected error was encountered and more detailed internal error code is provided (see [Internal Error Codes](#internal-error-codes)). |
| 501 | Indicates that the server does not support the functionality needed to fulfill the request. |
Expand All @@ -20,7 +20,7 @@ The following table describes the supported HTTP status codes.
## Internal Error Codes

The following sections describes the list of possible internal error codes that might be provided by different ORS
EndPoints.
Endpoints.

### Routing API

Expand All @@ -43,7 +43,7 @@ EndPoints.
| 2013 | Entry not reached. |
| 2014 | Exit not reached. |
| 2015 | Entry not reached. |
| 2016 | No rout beween entry and exit found. |
| 2016 | No route between entry and exit found. |
| 2017 | Maximum number of nodes exceeded. |
| 2099 | Unknown internal error. |

Expand All @@ -63,7 +63,7 @@ EndPoints.
| 3007 | Unsupported export format. |
| 3008 | Empty Element. |
| 3011 | Unknown parameter. |
| 3012 | Parameter value exeeds the minimum allowed limit. |
| 3012 | Parameter value exceeds the minimum allowed limit. |
| 3099 | Unknown internal error. |

### POIs API
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ but can also be shown as json, table or downloaded as file:

::: warning Hint
If you prefer the swagger-ui you can also use the [swagger editor](https://editor-next.swagger.io/) and load
the full OpenApi spec file for our API from https://openrouteservice.org/wp-json/ors-api/v1/api-doc/source/V2.
the full OpenAPI spec file for our API from https://openrouteservice.org/wp-json/ors-api/v1/api-doc/source/V2.
However, some of the displayed endpoints or features won't be accessible with our live API.
:::

Expand Down
Loading

0 comments on commit 2c57496

Please sign in to comment.