Skip to content

Configurable service info #62

Open

Description

@uniqueg

Is your feature request related to a problem? Please describe.

Hi! GET /service-info returns fixed values for every TESP API deployment: id: fi.muni.cz.tesp, the organization, contact and documentation URLs, createdAt/updatedAt, storage and environment: dev are set in the code (get_service_info, task_endpoints.py L121–L146).

Service registries and clients use the service info to tell deployments apart and to show who runs them. The GA4GH service-info specification asks for an id that is unique for each service and has environment to tell production from test deployments. With fixed values, all deployments report the same id and organization, and production deployments report dev.

Describe the solution you'd like

A service_info section in settings.toml (overridable per environment and by environment variables, as the other settings), e.g.:

service_info.id = "org.example.tesp"
service_info.name = "TESP"
service_info.organization.name = "Example Org"
service_info.organization.url = "https://example.org"
service_info.contact_url = "mailto:admin@example.org"
service_info.documentation_url = "https://example.org/docs"
service_info.environment = "prod"
service_info.storage = ["https://example.org/data"]

Unset fields keep today's values. type and version stay as TESP API reports them.

Describe alternatives you've considered

A reverse proxy that rewrites the response: possible, but each operator would have to maintain it.

Additional context

For context: the ELIXIR Node NL (SURF) plans a TESP API deployment with LS Login; we track that in elixir-cloud-aai/generic-issues#106. If this is welcome, we'd be happy to send a PR. And no problem if it doesn't fit your plans.

This issue was written by Claude Code Opus 5.5 on behalf of @uniqueg.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions