Sign in

v1

latestOpenAPI 3.0.02026-07-17101229.1 KB
GA4GH

Get the tool descriptor for the specified tool

Returns the descriptor for the specified tool (examples include CWL, WDL, Nextflow, Galaxy, or Snakemake documents).

get/tools/{id}/versions/{version_id}/{type}/descriptor

Path parameters

idstring required

A unique identifier of the tool, scoped to this registry, for example 123456.

type'CWL' | 'WDL' | 'NFL' | 'GALAXY' | 'SMK' | 'PLAIN_CWL' | 'PLAIN_WDL' | 'PLAIN_NFL' | 'PLAIN_GALAXY' | 'PLAIN_SMK' required

The output type of the descriptor. Plain types return the raw text while the "non-plain" types return the application/json

The output type of the descriptor. Plain types return the bare descriptor while the "non-plain" types return a descriptor wrapped with metadata.

version_idstring required

An identifier of the tool version, scoped to this registry, for example v1. We recommend that versions use semantic versioning https://semver.org/spec/v2.0.0.html (For example, 1.0.0 instead of develop)

Response

The tool descriptor.

contentstring

The content of the file itself. One of url or content is required.

urlstring

Optional url to the underlying content, should include version information, and can include a git hash. Note that this URL should resolve to the raw unwrapped content that would otherwise be available in content. One of url or content is required.

Example response

{
  "checksum": [
    {
      "checksum": "ea2a5db69bd20a42976838790bc29294df3af02b",
      "type": "sha1"
    }
  ]
}