Add server info to metadata endpoint; version 1.0 (#383)

* Add server block to metadata

* Bump version to v1.0.0

Author: DavidMStraub

gramps_webapi/_version.py

@@ -18,4 +18,4 @@
 #
 
 # make sure to match this version with the one in apispec.yaml
-__version__ = "0.7.0"
+__version__ = "1.0.0"

gramps_webapi/api/resources/metadata.py

@@ -2,6 +2,7 @@
 # Gramps Web API - A RESTful API for the Gramps genealogy program
 #
 # Copyright (C) 2020      Christopher Horn
+# Copyright (C) 2023      David Straub
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as published by
@@ -19,16 +20,14 @@
 
 """Metadata API resource."""
 
-import yaml
-from flask import Response
+from flask import current_app, Response
 from gramps.cli.clidbman import CLIDbManager
 from gramps.gen.const import ENV, GRAMPS_LOCALE
 from gramps.gen.db.base import DbReadBase
 from gramps.gen.dbstate import DbState
 from gramps.gen.utils.grampslocale import INCOMPLETE_TRANSLATIONS
-from pkg_resources import resource_filename
 
-from gramps_webapi.const import VERSION
+from gramps_webapi.const import TREE_MULTI, VERSION
 
 from ..util import get_db_handle
 from . import ProtectedResource
@@ -62,11 +61,23 @@ def get(self) -> Response:
                 if key == db_key:
                     db_type = db_summary[0][key]
 
+        is_multi_tree = current_app.config["TREE"] == TREE_MULTI
+        has_task_queue = bool(current_app.config["CELERY_CONFIG"])
+
         result = {
-            "database": {"id": db_handle.get_dbid(), "name": db_name, "type": db_type,},
+            "database": {
+                "id": db_handle.get_dbid(),
+                "name": db_name,
+                "type": db_type,
+            },
             "default_person": db_handle.get_default_handle(),
-            "gramps": {"version": ENV["VERSION"],},
-            "gramps_webapi": {"schema": VERSION, "version": VERSION,},
+            "gramps": {
+                "version": ENV["VERSION"],
+            },
+            "gramps_webapi": {
+                "schema": VERSION,
+                "version": VERSION,
+            },
             "locale": {
                 "lang": GRAMPS_LOCALE.lang,
                 "language": GRAMPS_LOCALE.language[0],
@@ -88,6 +99,7 @@ def get(self) -> Response:
                 "tags": db_handle.get_number_of_tags(),
             },
             "researcher": db_handle.get_researcher(),
+            "server": {"multi_tree": is_multi_tree, "task_queue": has_task_queue},
             "surnames": db_handle.get_surname_list(),
         }
         data = db_handle.get_summary()

gramps_webapi/data/apispec.yaml

@@ -8,7 +8,7 @@ info:
 
 
     * More about Gramps and the numerous features it provides for genealogists can be found at https://gramps-project.org
-  version: "0.7.0"  # make sure to match this version with the one in _version.py
+  version: "1.0.0"  # make sure to match this version with the one in _version.py
   license:
     name: "GNU Affero General Public License v3.0"
     url: "http://www.gnu.org/licenses/agpl-3.0.html"
@@ -9433,6 +9433,18 @@ definitions:
         $ref: "#/definitions/ObjectCounts"
       researcher:
         $ref: "#/definitions/Researcher"
+      server:
+        description: "Information about the server setup."
+        type: object
+        properties:
+          multi_tree:
+            description: "Indicates whether the server is enabled to host multiple family tree databases."
+            type: boolean
+            example: false
+          task_queue:
+            description: "Indicates whether the server is using a task queue for long running operations."
+            type: boolean
+            example: false
       surnames:
         description: "A list of all surnames found in the database."
         type: array