elapi 2.4.3__tar.gz → 2.4.5__tar.gz

{elapi-2.4.3 → elapi-2.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: elapi
-Version: 2.4.3
+Version: 2.4.5
 Summary: elAPI is a powerful, extensible API client for eLabFTW.
 Keywords: elabftw,api
 Author: Alexander Haller, Mahadi Xion
@@ -30,6 +30,7 @@ Requires-Dist: mistune==3.1.3
 Requires-Dist: click>=8.1.8,<8.2
 Requires-Dist: httpx-limiter>=0.3.0,<0.4.0
 Requires-Dist: httpx-aiohttp>=0.1.8,<0.2
+Requires-Dist: pydantic>=2.12.3
 Requires-Dist: jinja2>=3.1.6,<3.2 ; extra == 'mail'
 Requires-Dist: nameparser>=1.1.3 ; extra == 'mail'
 Requires-Dist: yagmail>=0.15.293,<0.16 ; extra == 'mail'
@@ -56,8 +57,8 @@ Description-Content-Type: text/markdown
 <img alt="Package version" src="https://badge.fury.io/py/elapi.svg/?branch=main" />
    </a>
 <a href="#compatibility">
-   <img alt="Static Badge" src="https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13-%230d7dbe">
-   <img alt="Static Badge" src="https://img.shields.io/badge/eLabFTW%20support-4.5%2B%20%7C%205.0%20%7C%205.1-%2323b3be">
+   <img alt="Static Badge" src="https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-%230d7dbe">
+   <img alt="Static Badge" src="https://img.shields.io/badge/eLabFTW%20support-5.1%20%7C%205.2%20%7C%205.3+-%2323b3be">
 </a>
 </p>
 
@@ -140,9 +141,19 @@ your configuration details.
 
 ## Compatibility
 
-elAPI is compatible with the following Python versions: `3.11`, `3.12`. elAPI supports
+elAPI is compatible with the following Python versions: `3.11`, `3.12`, `3.13`, `3.14`. elAPI supports
 the [eLabFTW REST API v2](https://doc.elabftw.net/api/v2/), and can be used with the following eLabFTW
-versions: `4.5`, `4.6`, `4.7`, `4.8`, `4.9`, `4.10`, `5.0`, `5.1`, `5.2`, and above.
+versions: `5.3.6`, `5.3.5`, `5.3.4`, `5.3.3`, `5.3.2`, `5.3.1`, `5.3.0`, `5.2.8`, `5.2.7`, `5.2.6`, `5.2.5`, `5.2.4`,
+`5.2.3`, `5.2.2`, `5.2.1`, `5.2.0`, `5.1.1`.
+
+### elAPI strict version support
+
+Starting from elAPI version **2.4.5**, elAPI maintains a [strict set of supported eLabFTW versions](#compatibility).
+elAPI will throw an error if the detected eLabFTW version is not supported. This is to prevent unexpected behavior when
+eLabFTW introduces breaking changes to the REST API. If your eLab version is supported, elAPI will cache it, and show
+the valid endpoint names for your server in `--help` page (e.g., `elapi get --help`). You can clear this cache with
+`elapi clear-cache`. You can also control what elAPI should do when an unsupported eLab version is used with
+`elab_strict_version_match` configuration field. See [advanced configuration](#advanced-configuration) for more details.
 
 ## Configuration
 
@@ -175,6 +186,7 @@ host: <host API url>
 api_token: <token with at least read-access>
 # "A.k.a API key". You can generate an API token from eLabFTW user panel -> API keys tab.
 export_dir: ~/Downloads/elAPI
+elab_strict_version_match: "warn"
 unsafe_api_token_warning: true
 enable_http2: false
 verify_ssl: true
@@ -188,6 +200,15 @@ development_mode: false
 - When `unsafe_api_token_warning` is `True`, elAPI will show a warning if you're storing `elapi.yml` in the current
   working directory, as it typically happens that developers accidentally commit and push configuration files with
   secrets.
+- `elab_strict_version_match` controls what elAPI should do if an unsupported eLabFTW version is detected. eLabFTW does
+  introduce breaking API change from time to time. Starting from elAPI 2.4.5, elAPI maintains [a strict set of eLabFTW
+  versions](#compatibility), i.e., elAPI and its plugins are expected to work for these versions. This is to prevent
+  unexpected behavior due to the breaking changes. If the detected eLabFTW server version is not supported, elAPI by
+  default (`elab_strict_version_match: warn`) will throw a warning
+  message and continue to run any command/plugin. When `elab_strict_version_match` is set to `abort`, elAPI will show an
+  `ERROR`
+  message and abort immediately. When `elab_strict_version_match` is set to `yolo`, elAPI will ignore any version
+  support conflict.
 - `enable_http2` enables HTTP/2 protocol support which by default is turned off. Be aware
   of [known issues](https://github.com/encode/httpx/discussions/2112) with HTTP/2 if you are making async requests with
   a heavy load.
@@ -285,6 +306,11 @@ of the team with team ID 1.
 $ elapi get -H teams --id 1
 ```
 
+elAPI runs a weak endpoint name validation against your eLabFTW API version. Run `elapi get --help` to see the
+supported endpoint names for your eLabFTW server:
+
+![elAPI endpoint names in --help](https://heibox.uni-heidelberg.de/f/067f5ec9f489493a8ec9/?dl=1)
+
 ### `POST` requests
 
 Create a new user by the name 'John Doe':
@@ -353,8 +379,8 @@ $ elapi experiments upload-attachment --id <experiment ID> --path <path to attac
 
 Sometimes when a script has finished, you and your team would want to receive an email about its success/failure. elAPI
 offers a no-code solution for this: the `mail` plugin. The `mail` plugin is not enabled by default. To enable it,
-install elAPI with the optional dependency `mail`: `pip install elapi[mail]` or `uv add elapi[mail]`. [__See the wiki
-__](https://github.com/uhd-urz/elAPI/wiki/mail-plugin) to read more about how to configure the `mail` plugin with your
+install elAPI with the optional dependency `mail`: `pip install elapi[mail]` or `uv add elapi[mail]`. [__See the wiki__](https://github.com/uhd-urz/elAPI/wiki/mail-plugin) 
+to read more about how to configure the `mail` plugin with your
 mail server configuration and trigger conditions. In a
 nutshell, the `mail` plugin will scan the logs when a script/plugin is done to look for pre-configured trigger
 conditions, and if found, it will send an email. The trigger conditions can be atomic and scope-based, i.e., an email

{elapi-2.4.3 → elapi-2.4.5}/README.md

@@ -7,8 +7,8 @@
 <img alt="Package version" src="https://badge.fury.io/py/elapi.svg/?branch=main" />
    </a>
 <a href="#compatibility">
-   <img alt="Static Badge" src="https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13-%230d7dbe">
-   <img alt="Static Badge" src="https://img.shields.io/badge/eLabFTW%20support-4.5%2B%20%7C%205.0%20%7C%205.1-%2323b3be">
+   <img alt="Static Badge" src="https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-%230d7dbe">
+   <img alt="Static Badge" src="https://img.shields.io/badge/eLabFTW%20support-5.1%20%7C%205.2%20%7C%205.3+-%2323b3be">
 </a>
 </p>
 
@@ -91,9 +91,19 @@ your configuration details.
 
 ## Compatibility
 
-elAPI is compatible with the following Python versions: `3.11`, `3.12`. elAPI supports
+elAPI is compatible with the following Python versions: `3.11`, `3.12`, `3.13`, `3.14`. elAPI supports
 the [eLabFTW REST API v2](https://doc.elabftw.net/api/v2/), and can be used with the following eLabFTW
-versions: `4.5`, `4.6`, `4.7`, `4.8`, `4.9`, `4.10`, `5.0`, `5.1`, `5.2`, and above.
+versions: `5.3.6`, `5.3.5`, `5.3.4`, `5.3.3`, `5.3.2`, `5.3.1`, `5.3.0`, `5.2.8`, `5.2.7`, `5.2.6`, `5.2.5`, `5.2.4`,
+`5.2.3`, `5.2.2`, `5.2.1`, `5.2.0`, `5.1.1`.
+
+### elAPI strict version support
+
+Starting from elAPI version **2.4.5**, elAPI maintains a [strict set of supported eLabFTW versions](#compatibility).
+elAPI will throw an error if the detected eLabFTW version is not supported. This is to prevent unexpected behavior when
+eLabFTW introduces breaking changes to the REST API. If your eLab version is supported, elAPI will cache it, and show
+the valid endpoint names for your server in `--help` page (e.g., `elapi get --help`). You can clear this cache with
+`elapi clear-cache`. You can also control what elAPI should do when an unsupported eLab version is used with
+`elab_strict_version_match` configuration field. See [advanced configuration](#advanced-configuration) for more details.
 
 ## Configuration
 
@@ -126,6 +136,7 @@ host: <host API url>
 api_token: <token with at least read-access>
 # "A.k.a API key". You can generate an API token from eLabFTW user panel -> API keys tab.
 export_dir: ~/Downloads/elAPI
+elab_strict_version_match: "warn"
 unsafe_api_token_warning: true
 enable_http2: false
 verify_ssl: true
@@ -139,6 +150,15 @@ development_mode: false
 - When `unsafe_api_token_warning` is `True`, elAPI will show a warning if you're storing `elapi.yml` in the current
   working directory, as it typically happens that developers accidentally commit and push configuration files with
   secrets.
+- `elab_strict_version_match` controls what elAPI should do if an unsupported eLabFTW version is detected. eLabFTW does
+  introduce breaking API change from time to time. Starting from elAPI 2.4.5, elAPI maintains [a strict set of eLabFTW
+  versions](#compatibility), i.e., elAPI and its plugins are expected to work for these versions. This is to prevent
+  unexpected behavior due to the breaking changes. If the detected eLabFTW server version is not supported, elAPI by
+  default (`elab_strict_version_match: warn`) will throw a warning
+  message and continue to run any command/plugin. When `elab_strict_version_match` is set to `abort`, elAPI will show an
+  `ERROR`
+  message and abort immediately. When `elab_strict_version_match` is set to `yolo`, elAPI will ignore any version
+  support conflict.
 - `enable_http2` enables HTTP/2 protocol support which by default is turned off. Be aware
   of [known issues](https://github.com/encode/httpx/discussions/2112) with HTTP/2 if you are making async requests with
   a heavy load.
@@ -236,6 +256,11 @@ of the team with team ID 1.
 $ elapi get -H teams --id 1
 ```
 
+elAPI runs a weak endpoint name validation against your eLabFTW API version. Run `elapi get --help` to see the
+supported endpoint names for your eLabFTW server:
+
+![elAPI endpoint names in --help](https://heibox.uni-heidelberg.de/f/067f5ec9f489493a8ec9/?dl=1)
+
 ### `POST` requests
 
 Create a new user by the name 'John Doe':
@@ -304,8 +329,8 @@ $ elapi experiments upload-attachment --id <experiment ID> --path <path to attac
 
 Sometimes when a script has finished, you and your team would want to receive an email about its success/failure. elAPI
 offers a no-code solution for this: the `mail` plugin. The `mail` plugin is not enabled by default. To enable it,
-install elAPI with the optional dependency `mail`: `pip install elapi[mail]` or `uv add elapi[mail]`. [__See the wiki
-__](https://github.com/uhd-urz/elAPI/wiki/mail-plugin) to read more about how to configure the `mail` plugin with your
+install elAPI with the optional dependency `mail`: `pip install elapi[mail]` or `uv add elapi[mail]`. [__See the wiki__](https://github.com/uhd-urz/elAPI/wiki/mail-plugin) 
+to read more about how to configure the `mail` plugin with your
 mail server configuration and trigger conditions. In a
 nutshell, the `mail` plugin will scan the logs when a script/plugin is done to look for pre-configured trigger
 conditions, and if found, it will send an email. The trigger conditions can be atomic and scope-based, i.e., an email

{elapi-2.4.3 → elapi-2.4.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "elapi"
-version = "2.4.3"
+version = "2.4.5"
 description = "elAPI is a powerful, extensible API client for eLabFTW."
 authors = [{ name = "Alexander Haller, Mahadi Xion", email = "elabftw@uni-heidelberg.de" }]
 requires-python = ">=3.11.0,<4"
@@ -35,6 +35,7 @@ dependencies = [
     "click>=8.1.8,<8.2",
     "httpx-limiter>=0.3.0,<0.4.0",
     "httpx-aiohttp>=0.1.8,<0.2",
+    "pydantic>=2.12.3",
 ]
 license-files = [
     "LICENSE",
@@ -68,6 +69,7 @@ build-backend = "uv_build"
 
 [dependency-groups]
 dev = [
+    "mypy>=1.18.2",
     "pip>=25.1.1", # vendy requires pip
     "ptpython>=3.0.23,<4",
     "vendy>=0.0.3",

elapi-2.4.5/src/elapi/VERSION

@@ -0,0 +1 @@
+2.4.5

{elapi-2.4.3 → elapi-2.4.5}/src/elapi/_core_init/__init__.py

@@ -16,11 +16,14 @@ __all__ = [
     "GlobalCLIGracefulCallback",
     "LogItemList",
     "PatternNotFoundError",
+    "get_cached_data",
+    "update_cache",
 ]
 import logging
 
 from .._vendor import haggis
 from .._vendor.haggis.logs import add_logging_level
+from ._cache import get_cached_data, update_cache
 from ._loggers import (
     BaseHandler,
     DefaultLogLevels,

elapi-2.4.5/src/elapi/_core_init/_cache.py

@@ -0,0 +1,53 @@
+import json
+from datetime import datetime
+from json import JSONDecodeError
+
+from pydantic import ValidationError
+
+from .._names import CacheFileProperties, CacheModel, CACHE_PATH
+from ._loggers import Logger
+
+logger = Logger()
+
+
+def get_cached_data() -> CacheModel:
+    def _new_cache() -> CacheModel:
+        cache_ = CacheModel(date=datetime.now())
+        update_cache(cache_)
+        return cache_
+
+    try:
+        raw_cache = json.loads(
+            CACHE_PATH.read_text(encoding=CacheFileProperties.encoding)
+        )
+    except (FileNotFoundError, JSONDecodeError, UnicodeDecodeError):
+        raw_cache = {}
+    try:
+        cache = CacheModel(**raw_cache)
+    except ValidationError:
+        logger.debug(
+            f"Cache found in '{CACHE_PATH}' is either empty or invalid. "
+            f"New cache will be created."
+        )
+        return _new_cache()
+    else:
+        if (datetime.now() - cache.date).seconds > CacheFileProperties.expires_in_days:
+            logger.debug(
+                f"Cache found in '{CACHE_PATH}' is older than "
+                f"{CacheFileProperties.expires_in_days} days. "
+                f"New cache will be created."
+            )
+            return _new_cache()
+        else:
+            return cache
+
+
+def update_cache(cache: CacheModel) -> None:
+    cache.date = datetime.now()
+    if not CACHE_PATH.exists():
+        CACHE_PATH.parent.mkdir(parents=True, exist_ok=True)
+        CACHE_PATH.touch(exist_ok=True)
+    CACHE_PATH.write_text(
+        cache.model_dump_json(indent=CacheFileProperties.indent),
+        encoding=CacheFileProperties.encoding,
+    )

{elapi-2.4.3 → elapi-2.4.5}/src/elapi/_core_init/_loggers/handlers/callback.py

@@ -16,6 +16,10 @@ class ResultCallbackHandler(Handler):
         cls._store_okay = True
         cls._client_count += 1
 
+    @classmethod
+    def disable_store_okay(cls) -> None:
+        cls._store_okay = False
+
     @classmethod
     def is_store_okay(cls) -> bool:
         return cls._store_okay
@@ -25,6 +29,6 @@ class ResultCallbackHandler(Handler):
         return cls._client_count
 
     def emit(self, record):
-        if self._store_okay:
+        if ResultCallbackHandler._store_okay:
             if record.levelno >= self.level:
                 self.log_container.append(record)

{elapi-2.4.3 → elapi-2.4.5}/src/elapi/_names.py

@@ -1,5 +1,11 @@
 import os
+from dataclasses import dataclass
+from datetime import datetime
+from enum import StrEnum
 from pathlib import Path
+from typing import ClassVar
+
+from pydantic import BaseModel
 
 # variables with leading underscores here indicate that they are to be overwritten by config.py
 # In which case, import their counterparts from src/config.py
@@ -53,6 +59,33 @@ KEY_TIMEOUT: str = "TIMEOUT"
 KEY_ASYNC_RATE_LIMIT: str = "ASYNC_RATE_LIMIT"
 KEY_DEVELOPMENT_MODE: str = "DEVELOPMENT_MODE"
 KEY_PLUGIN_KEY_NAME: str = "PLUGINS"
+KEY_ELAB_STRICT_VERSION_MATCH: str = "ELAB_STRICT_VERSION_MATCH"
+
+
+class ElabStrictVersionMatchModes(StrEnum):
+    abort = "abort"
+    warn = "warn"
+    yolo = "yolo"
+
 
 # Log data directory with root permission
 LOG_DIR_ROOT: Path = Path(f"/var/log/{APP_NAME}")
+
+
+class _ElabHostsCacheModel(BaseModel):
+    url: str
+
+
+class CacheModel(BaseModel):
+    date: datetime
+    elab_hosts: dict[str, str] = {}
+
+
+@dataclass(frozen=True)
+class CacheFileProperties:
+    expires_in_days: ClassVar[int] = 6 * 60 * 60
+    encoding: ClassVar[str] = "utf-8"
+    indent: ClassVar[int] = 4
+
+
+CACHE_PATH: Path = Path("~/.cache").expanduser() / APP_NAME / f"{APP_NAME}.json"

{elapi-2.4.3 → elapi-2.4.5}/src/elapi/api/__init__.py

@@ -15,8 +15,15 @@ __all__ = [
     "AsyncDELETERequest",
     "FixedEndpoint",
     "FixedAsyncEndpoint",
+    "handle_new_user_teams",
+    "ElabUserGroups",
+    "ElabScopes",
+    "ElabVersionDefaults",
+    "ElabFTWUnsupportedVersion"
 ]
 
+from ._handle_unexp_response import handle_new_user_teams
+from ._names import ElabScopes, ElabUserGroups, ElabVersionDefaults
 from .api import (
     APIRequest,
     AsyncDELETERequest,
@@ -24,6 +31,7 @@ from .api import (
     AsyncPATCHRequest,
     AsyncPOSTRequest,
     DELETERequest,
+    ElabFTWUnsupportedVersion,
     ElabFTWURL,
     ElabFTWURLError,
     GETRequest,

elapi-2.4.5/src/elapi/api/_handle_unexp_response.py

@@ -0,0 +1,58 @@
+import json
+
+from ..loggers import Logger
+from ..utils import UnexpectedAPIResponseType
+from ._names import ElabUserGroups
+
+logger = Logger()
+NewUserTeamsType = list[dict[str, int | bool | str]]
+
+_DEBUG_LOG_EMIT_ONCE: bool = False
+
+
+def handle_new_user_teams(user_teams: str | NewUserTeamsType) -> NewUserTeamsType:
+    global _DEBUG_LOG_EMIT_ONCE
+
+    struct_user_teams: list[dict[str, int | bool | str]] = []
+    match user_teams:
+        case list():
+            struct_user_teams = user_teams
+        case str():
+            try:
+                struct_user_teams = json.loads(user_teams)
+            except json.JSONDecodeError as e:
+                raise UnexpectedAPIResponseType(
+                    "Given user_teams is a string, but it could not be "
+                    f"parsed as a valid JSON. Exception: {e}"
+                ) from e
+        case _:
+            raise UnexpectedAPIResponseType(
+                f"Given user_teams type '{type(user_teams)}' is not supported."
+            )
+    for user_team in struct_user_teams:
+        try:
+            user_group = user_team["usergroup"]
+        except KeyError:
+            try:
+                user_group = ElabUserGroups.get_group_from_admin_status(
+                    bool(user_team["is_admin"])
+                )
+            except KeyError as e:
+                raise UnexpectedAPIResponseType(
+                    "user_team doesn't have 'usergroup', so a "
+                    "'is_admin' field was expected. "
+                    f"But no 'is_admin' is found either! User team: {user_team}"
+                ) from e
+            else:
+                if _DEBUG_LOG_EMIT_ONCE is False:
+                    logger.debug(
+                        "Field 'usergroup' is not found in user team info. "
+                        "This likely means the eLabFTW version is using a "
+                        "newer API version. 'is_admin' field is found and has "
+                        "been used instead."
+                    )
+                _DEBUG_LOG_EMIT_ONCE = True
+                user_team["usergroup"] = user_group
+        else:
+            pass
+    return struct_user_teams

elapi-2.4.5/src/elapi/api/_names.py

@@ -0,0 +1,55 @@
+from enum import IntEnum
+from pathlib import Path
+
+
+class ElabUserGroups(IntEnum):
+    """eLabFTW's default permission groups.
+    See: https://github.com/elabftw/elabftw/blob/master/src/Enums/Usergroup.php
+    """
+
+    sysadmin = 1
+    admin = 2
+    user = 4
+
+    @classmethod
+    def group_names(cls) -> list[str]:
+        return [_.name for _ in cls]
+
+    @classmethod
+    def group_values(cls) -> list[int]:
+        return [_.value for _ in cls]
+
+    @classmethod
+    def get_group_from_admin_status(cls, status: bool) -> int:
+        return cls.admin.value if status else cls.user.value
+
+
+class ElabScopes(IntEnum):
+    self = 1
+    team = 2
+    everything = 3
+
+
+class ElabVersionDefaults:
+    supported_versions: tuple[str, ...] = (
+        "5.3.7",
+        "5.3.6",
+        "5.3.5",
+        "5.3.4",
+        "5.3.3",
+        "5.3.2",
+        "5.3.1",
+        "5.3.0",
+        "5.2.8",
+        "5.2.7",
+        "5.2.6",
+        "5.2.5",
+        "5.2.4",
+        "5.2.3",
+        "5.2.2",
+        "5.2.1",
+        "5.2.0",
+        "5.1.15",
+    )
+    versions_dir: Path = Path(__file__).parent / "_supported_versions"
+    file_ext: str = "json"

elapi-2.4.5/src/elapi/api/_openapi_parser.py

@@ -0,0 +1,100 @@
+import json
+import re
+from collections import defaultdict
+from typing import Any
+
+import httpx
+import yaml
+from httpx import HTTPError
+
+from .._names import ELAB_BRAND_NAME
+from ..loggers import Logger
+from ..utils import OpenAPISpecificationException
+from ._names import ElabVersionDefaults
+
+logger = Logger()
+
+
+def read_openapi_spec(url: str) -> dict[str, Any]:
+    try:
+        spec = httpx.get(url)
+    except HTTPError as e:
+        raise OpenAPISpecificationException(
+            f"{ELAB_BRAND_NAME} OpenAPI specification URL could not be fetched. "
+            f"Exception details: {e}"
+        ) from e
+    else:
+        try:
+            spec_yaml = yaml.safe_load(spec.text)
+        except yaml.YAMLError as e:
+            raise OpenAPISpecificationException(
+                f"{ELAB_BRAND_NAME} OpenAPI specification could not parsed "
+                f"as a valid YAML. Exception details: {e}"
+            ) from e
+        else:
+            return spec_yaml
+
+
+def parse_openapi_spec(spec: dict[str, Any]) -> dict[str, list[str]]:
+    endpoints: dict[str, set[str]] = defaultdict(set)
+    try:
+        spec_paths = spec["paths"]
+    except KeyError as e:
+        raise OpenAPISpecificationException(
+            "The OpenAPI specification does not contain the 'paths' field! "
+        ) from e
+    for path in spec_paths:
+        endpoints_pattern = re.compile(r"^/([{}\w\-]+)(/{id}/([\w\-]+)(/{subid})?)?")
+        if match := endpoints_pattern.match(path):
+            main_endpoint_name, sub_endpoint_name = match.group(1, 3)
+            match main_endpoint_name:
+                case "{entity_type}":
+                    try:
+                        for parameter in spec_paths[path]["parameters"]:
+                            match parameter["name"]:
+                                case "entity_type":
+                                    entities = parameter["schema"]["enum"]
+                                    for entity in entities:
+                                        match sub_endpoint_name:
+                                            case None:
+                                                endpoints[entity] = set()
+                                            case _:
+                                                endpoints[entity].add(sub_endpoint_name)
+                                    break
+                                case _:
+                                    continue
+                    except KeyError as e:
+                        raise OpenAPISpecificationException(
+                            f"'entity_type' parameter is found in the OpenAPI specification "
+                            f"path '{path}' but other expected field names were not found!"
+                        ) from e
+                case _:
+                    match sub_endpoint_name:
+                        case None:
+                            endpoints[main_endpoint_name] = set()
+                        case _:
+                            endpoints[main_endpoint_name].add(sub_endpoint_name)
+        else:
+            raise OpenAPISpecificationException(
+                f"The OpenAPI specification path '{path}' does not match "
+                f"the expected pattern. This likely means a new type of endpoint "
+                f"path has been added to the specification that needs to be "
+                f"re-considered.."
+            )
+    return {k: sorted(list(v)) for k, v in sorted(endpoints.items())}
+
+
+if __name__ == "__main__":
+    versions_dir = ElabVersionDefaults.versions_dir
+    for version in ElabVersionDefaults.supported_versions:
+        version_file = versions_dir / f"{version}.{ElabVersionDefaults.file_ext}"
+        if version_file.exists():
+            logger.info(f"Version '{version}' already exists in {versions_dir}.")
+            continue
+        loaded_spec = read_openapi_spec(
+            f"https://raw.githubusercontent.com/elabftw/elabftw/refs/tags/{version}/apidoc/v2/openapi.yaml"
+        )
+        version_file.write_text(
+            json.dumps(parse_openapi_spec(loaded_spec), indent=4), encoding="utf-8"
+        )
+        logger.info(f"Version '{version}' data has been stored in {versions_dir}.")

elapi-2.4.5/src/elapi/api/_supported_versions/5.1.15.json

@@ -0,0 +1,51 @@
+{
+    "apikeys": [],
+    "config": [],
+    "event": [],
+    "events": [],
+    "experiments": [
+        "comments",
+        "experiments_links",
+        "items_links",
+        "revisions",
+        "steps",
+        "tags",
+        "uploads"
+    ],
+    "experiments_templates": [
+        "revisions",
+        "steps",
+        "tags"
+    ],
+    "exports": [],
+    "extra_fields_keys": [],
+    "favtags": [],
+    "idps": [],
+    "import": [],
+    "info": [],
+    "items": [
+        "comments",
+        "experiments_links",
+        "items_links",
+        "revisions",
+        "steps",
+        "tags",
+        "uploads"
+    ],
+    "items_types": [
+        "steps",
+        "tags"
+    ],
+    "teams": [
+        "experiments_categories",
+        "experiments_status",
+        "items_status",
+        "teamgroups"
+    ],
+    "todolist": [],
+    "unfinished_steps": [],
+    "users": [
+        "notifications",
+        "uploads"
+    ]
+}