feat: add service info endpoint

deployment/config.yaml

@@ -48,6 +48,34 @@ api:
           swagger_ui: True
           serve_spec: True
 
+# Custom configuration
+# Cf. https://foca.readthedocs.io/en/latest/modules/foca.models.html#foca.models.config.CustomConfig
+custom:
+  # ServiceInfo configuration based on ServiceInfo model
+  service_info:
+    id: org.ga4gh.myservice
+    name: My project
+    type:
+      group: org.ga4gh
+      artifact: tes
+      version: 1.0.0
+    description: This service provides...
+    organization:
+      name: My organization
+      url: https://example.com
+    contactUrl: mailto:[email protected]
+    documentationUrl: https://docs.myservice.example.com
+    createdAt: '2019-06-04T12:58:19Z'
+    updatedAt: '2019-06-04T12:58:19Z'
+    environment: test
+    version: 1.0.0
+    storage:
+      - file:///path/to/local/funnel-storage
+      - s3://ohsu-compbio-funnel/storage
+    tesResources_backend_parameters:
+      - VmSize
+      - ParamToRecogniseDataComingFromConfig
+
 # Logging configuration
 # Cf. https://foca.readthedocs.io/en/latest/modules/foca.models.html#foca.models.config.LogConfig
 log:

tesk/api/ga4gh/tes/controllers.py

@@ -5,6 +5,8 @@
 # from connexion import request  # type: ignore
 from foca.utils.logging import log_traffic  # type: ignore
 
+from tesk.api.ga4gh.tes.service_info.service_info import ServiceInfo
+
 # Get logger instance
 logger = logging.getLogger(__name__)
 
@@ -36,14 +38,10 @@ def CreateTask(*args, **kwargs) -> dict:  # type: ignore
 
 # GET /tasks/service-info
 @log_traffic
-def GetServiceInfo(*args, **kwargs) -> dict:  # type: ignore
-  """Get service info.
-
-  Args:
-                  *args: Variable length argument list.
-                  **kwargs: Arbitrary keyword arguments.
-  """
-  pass
+def GetServiceInfo() -> dict:  # type: ignore
+  """Get service info."""
+  service_info = ServiceInfo()
+  return service_info.response()
 
 
 # GET /tasks

tesk/api/ga4gh/tes/models.py

@@ -353,7 +353,7 @@ class Service(BaseModel):
   organization: Organization = Field(
     ..., description="Organization providing the service"
   )
-  contactUrl: Optional[AnyUrl] = Field(
+  contactUrl: Optional[str] = Field(
     default=None,
     description="URL of the contact for the provider of this service, e.g. a link to a "
     "contact form (RFC 3986 format), or an email (RFC 2368 format).",

tesk/api/ga4gh/tes/service_info/__init__.py

@@ -0,0 +1 @@
+"""Package for the TES Service Info endpoint."""

tesk/api/ga4gh/tes/service_info/service_info.py

@@ -0,0 +1,87 @@
+"""Service info for TES API."""
+
+import json
+from typing import Any, Optional
+
+from pydantic import AnyUrl
+
+from tesk.api.ga4gh.tes.models import (
+  Artifact,
+  Organization,
+  TesServiceInfo,
+  TesServiceType,
+)
+from tesk.exceptions import ConfigNotFoundError
+from tesk.tesk_app import TeskApp
+
+
+class ServiceInfo:
+  """Service info for TES API."""
+
+  def __init__(self) -> None:
+    """Initializes the BaseServiceInfoRequest class."""
+    self.service_info: Optional[TesServiceInfo] = None
+    self.config = TeskApp().conf
+
+  def get_default_service_info(self) -> TesServiceInfo:
+    """Get the default service info.
+
+    if service info is not provided in the config,
+    this method will return the default service info.
+
+    Returns:
+        TesServiceInfo: Default service info.
+    """
+    return TesServiceInfo(
+      id="org.ga4gh.tes",
+      name="TES",
+      type=TesServiceType(
+        group="org.ga4gh",
+        artifact=Artifact.tes,
+        version="1.1.0",
+      ),
+      organization=Organization(
+        name="my_organization",
+        url=AnyUrl("https://example.com"),
+      ),
+      version="1.1.0",
+    )
+
+  def get_service_info_from_config(self) -> TesServiceInfo:
+    """Returns service info from config.
+
+    Returns:
+      TesServiceInfo: Service info from config.
+
+    Raises:
+      ConfigNotFoundError: If custom config or part of it is not found
+        in the config file.
+    """
+    if not self.config.custom:
+      raise ConfigNotFoundError("Custom configuration not found.")
+
+    service_info_data = self.config.custom.get("service_info")
+    if not service_info_data:
+      raise ConfigNotFoundError("Service info not found in custom configuration.")
+
+    try:
+      service_info = TesServiceInfo(**service_info_data)
+    except TypeError as e:
+      raise ConfigNotFoundError(f"Invalid service info format: {e}") from None
+
+    return service_info
+
+  def response(self) -> dict[str, Any]:
+    """Returns serialized response for /service-info.
+
+    Returns:
+      dict: Serialized response.
+    """
+    if self.service_info is None:
+      try:
+        self.service_info = self.get_service_info_from_config()
+      except ConfigNotFoundError:
+        self.service_info = self.get_default_service_info()
+
+    # return self.service_info.dict()
+    return dict(json.loads(self.service_info.json()))