GA4GH

List one specific tool version, acts as an anchor for self references

This endpoint returns one specific tool version.

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

Path parameters

idstring required

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

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

A tool version.

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"
  ]
}

Changes

Changed in 10 of the 22 revisions of this API.41018

Apr 5, 20230ffba1b7a0f11See the full diff
- ○
  added the optional property description to the response with the 200 status
  response-optional-property-added
Sep 14, 2022f046d092f3341See the full diff
- ○
  added the optional property descriptor_type_version to the response with the 200 status
  response-optional-property-added
Aug 25, 202155c06a2814371See the full diff
- ●
  added the new SMK enum value to the descriptor_type/items/ response property for the response status 200
  response-property-enum-value-added
Dec 23, 2020a7ee6347c3cd2See the full diff
- ▲
  removed the media type text/plain for the response with the status 200
  response-media-type-removed
- ▲
  removed the media type text/plain for the response with the status 404
  response-media-type-removed
Apr 2, 2020a47808c8a04a2See the full diff
- ●
  added the new GALAXY enum value to the descriptor_type/items/ response property for the response status 200 (media type: application/json)
  response-property-enum-value-added
- ●
  added the new GALAXY enum value to the descriptor_type/items/ response property for the response status 200 (media type: text/plain)
  response-property-enum-value-added
Aug 14, 2019eab37df28ccf4See the full diff
- ○
  added the optional property images/items/checksum to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property images/items/checksum to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property is_production to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property is_production to the response with the 200 status (media type: text/plain)
  response-optional-property-added
Aug 13, 20195ee7d3a548a81See the full diff
- ○
  the endpoint scheme security BEARER was added to the API
  api-security-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 12, 2019179cda7bb37a6See the full diff
- ○
  added the optional property author to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property author to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property included_apps to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property included_apps to the response with the 200 status (media type: text/plain)
  response-optional-property-added
- ○
  added the optional property signed to the response with the 200 status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property signed to the response with the 200 status (media type: text/plain)
  response-optional-property-added
Jul 29, 20198be9b128ef4a1See the full diff
- ▲
  the verified_source response's property type/format changed from string/ to array/ for status 200 (media type: application/json)
  response-property-type-changed
Jun 12, 201900ccac2487d2175See the full diff
- ▲
  the verified_source response's property type/format changed from array/ to string/ for status 200
  response-property-type-changed
- ●
  removed the optional property author from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property description from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property descriptor_type_version from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property images/items/checksum from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property included_apps from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property is_production from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property signed from the response with the 200 status
  response-optional-property-removed
- ○
  the endpoint scheme security BEARER was removed from the API
  api-security-removed
- ○
  added the media type text/plain for the response with the status 200
  response-media-type-added
- ○
  added the media type text/plain for the response with the status 404
  response-media-type-added
- ○
  removed the GALAXY enum value from the descriptor_type/items/ response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the SMK enum value from the descriptor_type/items/ response property for the response status 200
  response-property-enum-value-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history