From 3fc87682348900d6447d84ac85a61313889c7161 Mon Sep 17 00:00:00 2001
From: "duncan.macleod" <duncan.macleod@ligo.org>
Date: Mon, 6 Nov 2023 20:59:22 -0800
Subject: [PATCH] api: add v1 API implementation
this is functionally the same as the `LDR` api, just with a different prefix
---
gwdatafind/api/__init__.py | 1 +
gwdatafind/api/v1.py | 107 +++++++++++++++++++++++++++++++++++++
2 files changed, 108 insertions(+)
create mode 100644 gwdatafind/api/v1.py
diff --git a/gwdatafind/api/__init__.py b/gwdatafind/api/__init__.py
index 1fc7e50..0dbab9e 100644
--- a/gwdatafind/api/__init__.py
+++ b/gwdatafind/api/__init__.py
@@ -20,4 +20,5 @@
# list of APIs
APIS = (
"ldr",
+ "v1",
)
diff --git a/gwdatafind/api/v1.py b/gwdatafind/api/v1.py
new file mode 100644
index 0000000..f29eb6a
--- /dev/null
+++ b/gwdatafind/api/v1.py
@@ -0,0 +1,107 @@
+# Copyright (C) 2025 Cardiff University
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation; either version 2 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 General
+# Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+"""GWDataFind API v1 implementation."""
+
+from functools import wraps
+from os.path import basename
+
+from .common import version_path
+
+__author__ = "Duncan Macleod <duncan.macleod@ligo.org>"
+
+DEFAULT_EXT = "gwf"
+DEFAULT_SERVICE_PREFIX = "api/v1"
+
+
+def _prefix(func):
+ """Wrap ``func`` to prepend the path prefix automatically.
+
+ This just simplifies the functional constructions below.
+ """
+ @wraps(func)
+ def wrapped(*args, **kwargs):
+ prefix = kwargs.pop("prefix", DEFAULT_SERVICE_PREFIX)
+ suffix = func(*args, **kwargs)
+ return f"{prefix}/{suffix}"
+
+ return wrapped
+
+
+def ping_path(ext=None):
+ """Return the API path to ping the server."""
+ return version_path()
+
+
+@_prefix
+def find_observatories_path(ext=DEFAULT_EXT):
+ """Return the API path to query for all observatories."""
+ return f"{ext}.json"
+
+
+@_prefix
+def find_types_path(site=None, ext=DEFAULT_EXT):
+ """Return the API path to query for datasets for one or all sites."""
+ if site:
+ return f"{ext}/{site[0]}.json"
+ return f"{ext}/all.json"
+
+
+@_prefix
+def find_times_path(site, frametype, start, end, ext=DEFAULT_EXT):
+ """Return the API path to query for data availability segments."""
+ if start is None and end is None:
+ return f"{ext}/{site}/{frametype}/segments.json"
+ return f"{ext}/{site}/{frametype}/segments/{start},{end}.json"
+
+
+@_prefix
+def find_url_path(framefile):
+ """Return the API path to query for the URL of a specific filename."""
+ filename = basename(framefile)
+ ext = filename.split(".", 1)[1]
+ site, frametype, _ = filename.split("-", 2)
+ return f"{ext}/{site}/{frametype}/{filename}.json"
+
+
+@_prefix
+def find_latest_path(site, frametype, urltype, ext=DEFAULT_EXT):
+ """Return the API path to query for the latest file in a dataset."""
+ stub = f"{ext}/{site}/{frametype}/latest"
+ if urltype:
+ return f"{stub}/{urltype}.json"
+ return stub + ".json"
+
+
+@_prefix
+def find_urls_path(
+ site,
+ frametype,
+ start,
+ end,
+ urltype=None,
+ match=None,
+ ext=DEFAULT_EXT,
+):
+ """Return the API path to query for all URLs for a dataset in an interval."""
+ stub = f"{ext}/{site}/{frametype}/{start},{end}"
+ if urltype:
+ path = f"{stub}/{urltype}.json"
+ else:
+ path = stub + ".json"
+ if match:
+ path += f"?match={match}"
+ return path
--
GitLab