search

ga4gh / tool-registry-service-schemas

APIs for discovering genomics tools, their metadata and their containers
Apache License 2.0
30 stars 18 forks source link

Confusing description for descriptor type #85

Closed coverbeck closed 5 years ago

coverbeck commented 5 years ago

The type path parameter for the /tools/{id}/versions/{version_id}/{type}/descriptor is required, but the description implies that it is optional ("If not specified..."):

The output type of the descriptor. If not specified, it is up to the
underlying implementation to determine which output type to return.
Plain types return the bare descriptor while the "non-plain" types
return a descriptor wrapped with metadata. Allowable values include
"CWL", "WDL", "NFL", "PLAIN_CWL", "PLAIN_WDL", "PLAIN_NFL".

┆Issue is synchronized with this Jira Task ┆containerName: GA4GH tool-registry-service ┆Epic: GA4GH TRS Approval ┆Issue Number: TRS-21

denis-yuen commented 5 years ago

Looks like the description is wrong, the required wins.

denis-yuen commented 5 years ago

Merged