Skip to content

Commit

Permalink
Add a simple readiness endpoint (#575)
Browse files Browse the repository at this point in the history
* Add simple readiness endpoint

* doc string typos
  • Loading branch information
DavidMStraub authored Nov 20, 2024
1 parent 9a4d62a commit daa5bf5
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
4 changes: 4 additions & 0 deletions gramps_webapi/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,4 +193,8 @@ def close_user_db_connection(exception) -> None:
if app.config.get("VECTOR_EMBEDDING_MODEL"):
load_model(app.config["VECTOR_EMBEDDING_MODEL"])

@app.route("/ready", methods=["GET"])
def ready():
return {"status": "ready"}, 200

return app
39 changes: 39 additions & 0 deletions tests/test_endpoints/test_ready.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
#
# Gramps Web API - A RESTful API for the Gramps genealogy program
#
# Copyright (C) 2024 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
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
#

"""Tests for the /ready endpoint."""

import unittest

from . import get_test_client


class TestBookmarks(unittest.TestCase):
"""Test cases for the /api/ready endpoint."""

@classmethod
def setUpClass(cls):
"""Test class setup."""
cls.client = get_test_client()

def test_ready(self):
"""Test authorization required."""
rv = self.client.get("/ready")
assert rv.status_code == 200
assert rv.json == {"status": "ready"}

0 comments on commit daa5bf5

Please sign in to comment.