add typing information to DB properties

[nominatim.git] / docs / api / Status.md

diff --git a/docs/api/Status.md b/docs/api/Status.md
index 0241b6faa35c6bf93cfa6c3fda383b36fff2c055..8c3e25e94339085b7c2a52bd9cc358b7209f863e 100644 (file)
--- 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.