Skip to content

Commit

Permalink
docs(status): update status response documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jhaeu committed Dec 11, 2024
1 parent f32dea8 commit 8486540
Showing 1 changed file with 41 additions and 12 deletions.
53 changes: 41 additions & 12 deletions docs/api-reference/endpoints/status/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,13 @@ This endpoint is not available in the public API, but you can use it when runnin
The GET request http://localhost:8082/ors/v2/status (host and port are dependent on the setup) returns basic information about the running instance:

* `languages`: available languages
* `engine`: the build date and version of the openrouteservice
* `profiles`: available routing profiles, info about storages and configured limits
* `engine`: the build date and version of the openrouteservice.
`graph_version` is the version of the graph structure and build logic determining the graph repository address
if [graph management](/run-instance/configuration/engine/graph-management.md) is enabled
* `profiles`: available routing profiles,
info about the graph's build (start) date (`graph_build_date`),
timestamp of the osm pbf file that was used for building the graph (`osm_date`),
storages and configured limits
* `services`: activated services

[//]: # (TODO: engine git die ORS version aus, nicht die eigentliche engine version, die wir dann auch im graph management verwenden, oder?)
Expand All @@ -20,6 +25,8 @@ The GET request http://localhost:8082/ors/v2/status (host and port are dependent
"languages": [
"cs",
"cs-cz",
"da",
"da-dk",
"de",
"de-de",
"en",
Expand All @@ -28,6 +35,8 @@ The GET request http://localhost:8082/ors/v2/status (host and port are dependent
"eo-eo",
"es",
"es-es",
"fi",
"fi-fi",
"fr",
"fr-fr",
"gr",
Expand All @@ -42,6 +51,8 @@ The GET request http://localhost:8082/ors/v2/status (host and port are dependent
"it-it",
"ja",
"ja-jp",
"nb",
"nb-no",
"ne",
"ne-np",
"nl",
Expand All @@ -56,32 +67,50 @@ The GET request http://localhost:8082/ors/v2/status (host and port are dependent
"ru-ru",
"tr",
"tr-tr",
"ua",
"ua-ua",
"vi",
"vi-vn",
"zh",
"zh-cn"
],
"engine": {
"build_date": "2023-12-15T14:31:27Z",
"version": "8.0"
"build_date": "2024-12-11T12:44:36Z",
"graph_version": "1",
"version": "9.1.0"
},
"profiles": {
"profile 1": {
"car": {
"storages": {
"WayCategory": {
"gh_profile": "car_ors_fastest_with_turn_costs"
"enabled": true
},
"HeavyVehicle": {
"gh_profile": "car_ors_fastest_with_turn_costs"
"restrictions": true,
"enabled": true
},
"WaySurfaceType": {
"gh_profile": "car_ors_fastest_with_turn_costs"
"enabled": true
},
"RoadAccessRestrictions": {
"gh_profile": "car_ors_fastest_with_turn_costs",
"use_for_warnings": "true"
"useForWarnings": true,
"enabled": true
}
},
"profiles": "driving-car",
"creation_date": "",
"encoder_name": "driving-car",
"graph_build_date": "2024-10-28T14:42:49Z",
"osm_date": "2023-10-11T20:21:48Z",
"limits": {
"maximum_distance": 100000,
"maximum_waypoints": 50,
"maximum_distance_dynamic_weights": 100000,
"maximum_distance_avoid_areas": 100000
}
},
"pedestrian": {
"encoder_name": "foot-walking",
"graph_build_date": "2024-10-11T11:08:44Z",
"osm_date": "2024-01-22T21:21:14Z",
"limits": {
"maximum_distance": 100000,
"maximum_waypoints": 50,
Expand Down

0 comments on commit 8486540

Please sign in to comment.