X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/8c3a0efe8b75a06279998e66a932d8a56c483961..381c9395747a04672acba395e0bd14332d1a9db9:/docs/api/Status.md diff --git a/docs/api/Status.md b/docs/api/Status.md index 0241b6fa..1a5ff0a8 100644 --- a/docs/api/Status.md +++ b/docs/api/Status.md @@ -35,10 +35,16 @@ will return HTTP code 200 and a structure { "status": 0, "message": "OK", - "data_updated": "2020-05-04T14:47:00+00:00" + "data_updated": "2020-05-04T14:47:00+00:00", + "software_version": "3.6.0-0", + "database_version": "3.6.0-0" } ``` +The `software_version` field contains the version of Nominatim used to serve +the API. The `database_version` field contains the version of the data format +in the database. + On error will also return HTTP status code 200 and a structure with error code and message, e.g. @@ -51,10 +57,11 @@ code and message, e.g. Possible status codes are - | | message | notes | - |-----|----------------------|---------------------------------------------------| - | 700 | "No database" | connection failed | - | 701 | "Module failed" | database could not load nominatim.so | - | 702 | "Module call failed" | nominatim.so loaded but calling a function failed | - | 703 | "Query failed" | test query against a database table failed | - | 704 | "No value" | test query worked but returned no results | +| | message | notes | +| --- | ------------------------------ | ----------------------------------------------------------------- | +| 700 | "No database" | connection failed | +| 701 | "Module failed" | database could not load nominatim.so | +| 702 | "Module call failed" | nominatim.so loaded but calling a function failed | +| 703 | "Query failed" | test query against a database table failed | +| 704 | "No value" | test query worked but returned no results | +| 705 | "Import date is not available" | No import dates were returned (enabling replication can fix this) |