mirror of
https://github.com/galaxyproject/galaxy.git
synced 2026-09-24 16:30:27 +08:00
Flush out documentation and service-info for DRS API a bit.
This commit is contained in:
@@ -2091,18 +2091,41 @@ galaxy:
|
||||
# Service ID for GA4GH services (exposed via the service-info endpoint
|
||||
# for the Galaxy DRS API). If unset, one will be generated using the
|
||||
# URL the target API requests are made against.
|
||||
# For more information on GA4GH service definitions - check out
|
||||
# https://github.com/ga4gh-discovery/ga4gh-service-registry and
|
||||
# https://editor.swagger.io/?url=https://raw.githubusercontent.com/ga4gh-discovery/ga4gh-service-registry/develop/service-registry.yaml
|
||||
# This value should likely reflect your service's URL. For instance
|
||||
# for usegalaxy.org this value should be org.usegalaxy. Particular
|
||||
# Galaxy implementations will treat this value as a prefix and append
|
||||
# the service type to this ID. For instance for the DRS service "id"
|
||||
# (available via the DRS API) for the above configuration value would
|
||||
# be org.usegalaxy.drs.
|
||||
#ga4gh_service_id: null
|
||||
|
||||
# Service name for host organization (exposed via the service-info
|
||||
# endpoint for the Galaxy DRS API). If unset, one will be generated
|
||||
# using ga4gh_service_service_id.
|
||||
# using ga4gh_service_id.
|
||||
# For more information on GA4GH service definitions - check out
|
||||
# https://github.com/ga4gh-discovery/ga4gh-service-registry and
|
||||
# https://editor.swagger.io/?url=https://raw.githubusercontent.com/ga4gh-discovery/ga4gh-service-registry/develop/service-registry.yaml
|
||||
#ga4gh_service_organization_name: null
|
||||
|
||||
# Organization URL for host organization (exposed via the service-info
|
||||
# endpoint for the Galaxy DRS API). If unset, one will be generated
|
||||
# using the URL the target API requests are made against.
|
||||
# For more information on GA4GH service definitions - check out
|
||||
# https://github.com/ga4gh-discovery/ga4gh-service-registry and
|
||||
# https://editor.swagger.io/?url=https://raw.githubusercontent.com/ga4gh-discovery/ga4gh-service-registry/develop/service-registry.yaml
|
||||
#ga4gh_service_organization_url: null
|
||||
|
||||
# Service environment (exposed via the service-info endpoint for the
|
||||
# Galaxy DRS API) for implemented GA4GH services.
|
||||
# Suggested values are prod, test, dev, staging.
|
||||
# For more information on GA4GH service definitions - check out
|
||||
# https://github.com/ga4gh-discovery/ga4gh-service-registry and
|
||||
# https://editor.swagger.io/?url=https://raw.githubusercontent.com/ga4gh-discovery/ga4gh-service-registry/develop/service-registry.yaml
|
||||
#ga4gh_service_environment: null
|
||||
|
||||
# Enable tool tags (associating tools with tags). This has its own
|
||||
# option since its implementation has a few performance implications
|
||||
# on startup for large servers.
|
||||
|
||||
@@ -2792,12 +2792,26 @@ mapping:
|
||||
Service ID for GA4GH services (exposed via the service-info endpoint for the Galaxy DRS API).
|
||||
If unset, one will be generated using the URL the target API requests are made against.
|
||||
|
||||
For more information on GA4GH service definitions - check out
|
||||
https://github.com/ga4gh-discovery/ga4gh-service-registry
|
||||
and https://editor.swagger.io/?url=https://raw.githubusercontent.com/ga4gh-discovery/ga4gh-service-registry/develop/service-registry.yaml
|
||||
|
||||
This value should likely reflect your service's URL. For instance for usegalaxy.org
|
||||
this value should be org.usegalaxy. Particular Galaxy implementations will treat this
|
||||
value as a prefix and append the service type to this ID. For instance for the DRS
|
||||
service "id" (available via the DRS API) for the above configuration value would be
|
||||
org.usegalaxy.drs.
|
||||
|
||||
ga4gh_service_organization_name:
|
||||
type: str
|
||||
required: false
|
||||
desc: |
|
||||
Service name for host organization (exposed via the service-info endpoint for the Galaxy DRS API).
|
||||
If unset, one will be generated using ga4gh_service_service_id.
|
||||
If unset, one will be generated using ga4gh_service_id.
|
||||
|
||||
For more information on GA4GH service definitions - check out
|
||||
https://github.com/ga4gh-discovery/ga4gh-service-registry
|
||||
and https://editor.swagger.io/?url=https://raw.githubusercontent.com/ga4gh-discovery/ga4gh-service-registry/develop/service-registry.yaml
|
||||
|
||||
ga4gh_service_organization_url:
|
||||
type: str
|
||||
@@ -2806,6 +2820,23 @@ mapping:
|
||||
Organization URL for host organization (exposed via the service-info endpoint for the Galaxy DRS API).
|
||||
If unset, one will be generated using the URL the target API requests are made against.
|
||||
|
||||
For more information on GA4GH service definitions - check out
|
||||
https://github.com/ga4gh-discovery/ga4gh-service-registry
|
||||
and https://editor.swagger.io/?url=https://raw.githubusercontent.com/ga4gh-discovery/ga4gh-service-registry/develop/service-registry.yaml
|
||||
|
||||
ga4gh_service_environment:
|
||||
type: str
|
||||
required: False
|
||||
desc: |
|
||||
Service environment (exposed via the service-info endpoint for the Galaxy DRS API) for
|
||||
implemented GA4GH services.
|
||||
|
||||
Suggested values are prod, test, dev, staging.
|
||||
|
||||
For more information on GA4GH service definitions - check out
|
||||
https://github.com/ga4gh-discovery/ga4gh-service-registry
|
||||
and https://editor.swagger.io/?url=https://raw.githubusercontent.com/ga4gh-discovery/ga4gh-service-registry/develop/service-registry.yaml
|
||||
|
||||
enable_tool_tags:
|
||||
type: bool
|
||||
default: false
|
||||
|
||||
@@ -63,6 +63,10 @@ class DrsApi:
|
||||
artifact="drs",
|
||||
version="1.2.0",
|
||||
)
|
||||
environemnt = config.ga4gh_service_environment
|
||||
extra_kwds = {}
|
||||
if environemnt:
|
||||
extra_kwds["environment"] = environemnt
|
||||
return Service(
|
||||
id=organization_id + ".drs",
|
||||
name=DRS_SERVICE_NAME,
|
||||
@@ -70,6 +74,7 @@ class DrsApi:
|
||||
organization=organization,
|
||||
type=service_type,
|
||||
version=VERSION,
|
||||
**extra_kwds,
|
||||
)
|
||||
|
||||
@router.get("/ga4gh/drs/v1/objects/{object_id}")
|
||||
|
||||
Reference in New Issue
Block a user