GA4GHV20

List versions of a tool

Changed on

Returns all versions of the specified tool. Results may be paginated using the offset and limit query parameters.

get/ga4gh/trs/v2/tools/{id}/versions

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/ga4gh/trs/v2/tools/{id}/versions
  • Auth
    HTTP bearer

Path parameters

idstring required

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

Query parameters

offsetstring

Start index of paging. Pagination results can be based on numbers or other values chosen by the registry implementor (for example, SHA values). If this exceeds the current result set return an empty set. If not specified in the request, this will start at the beginning of the results.

limitinteger

Amount of records to return in a given page.

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).

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.

descriptor_typestring[]

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.

idstring required

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

included_appsstring[]

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

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

meta_versionstring

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

namestring

The name of the version.

signedboolean

Reports whether this version of the tool has been signed.

urlstring required

The URL for this tool version in this registry.

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.

Example response

[
  {
    "descriptor_type_version": {
      "CWL": [
        "v1.0.2"
      ],
      "NFL": [
        "DSL2"
      ],
      "WDL": [
        "1.0",
        "1.1"
      ]
    },
    "id": "v1",
    "images": [
      {
        "checksum": [
          {
            "checksum": "77af4d6b9913e693e8d0b4b294fa62ade6054e6b2f1ffb617ac955dd63fb0182",
            "type": "sha256"
          }
        ],
        "image_name": "[\"quay.io/seqware/seqware_full/1.1\",\"ubuntu:latest\"]",
        "registry_host": "[\"registry.hub.docker.com\"]"
      }
    ],
    "included_apps": [
      "https://bio.tools/tool/mytum.de/SNAP2/1",
      "https://bio.tools/bioexcel_seqqc"
    ],
    "url": "http://agora.broadinstitute.org/tools/123456/versions/1"
  }
]

Changes

  • d8be9581784cRevision changes
    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the optional property / to the response with the status