Sign in

v1

latestOpenAPI 3.0.02026-07-17101229.1 KB
GA4GH

List versions of a tool

Returns all versions of the specified tool.

get/tools/{id}/versions

Path parameters

idstring required

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

Response

An array of tool versions.

authorstring[]

Contact information for the author of this version of the tool in the registry. (More complex authorship information is handled by the descriptor).

namestring

The name of the version.

urlstring required

The URL for this tool version in this registry.

idstring required

An identifier of the version of this tool for this particular tool registry.

is_productionboolean

This version of a tool is guaranteed to not change over time (for example, a tool built from a tag in git as opposed to a branch). A production quality tool is required to have a checksum

descriptor_typeDescriptorType[]

The type (or types) of descriptors available.

descriptor_type_versionobject

A map providing information about the language versions used in this tool. The keys should be the same values used in the descriptor_type field, and the value should be an array of all the language versions used for the given descriptor_type. Depending on the descriptor_type (e.g. CWL) multiple version values may be used in a single tool.

containerfileboolean

Reports if this tool has a containerfile available. (For Docker-based tools, this would indicate the presence of a Dockerfile)

descriptionstring

The description of the tool version. This allows for documentation of a specific tool version as a tool evolves over time.

meta_versionstring

The version of this tool version in the registry. Iterates when fields like the description, author, etc. are updated.

verifiedboolean

Reports whether this tool has been verified by a specific organization or individual.

verified_sourcestring[]

Source of metadata that can support a verified tool, such as an email or URL.

signedboolean

Reports whether this version of the tool has been signed.

included_appsstring[]

An array of IDs for the applications that are stored inside this tool.

Example response

[
  {
    "url": "http://agora.broadinstitute.org/tools/123456/versions/1",
    "id": "v1",
    "images": [
      {
        "checksum": [
          {
            "checksum": "77af4d6b9913e693e8d0b4b294fa62ade6054e6b2f1ffb617ac955dd63fb0182",
            "type": "sha256"
          }
        ]
      }
    ],
    "included_apps": [
      "https://bio.tools/tool/mytum.de/SNAP2/1",
      "https://bio.tools/bioexcel_seqqc"
    ]
  }
]