Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small comment round up #239

Merged
merged 10 commits into from
Apr 5, 2023
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1193735.svg)](https://doi.org/10.5281/zenodo.1193735)


![release_badge](https://img.shields.io/github/v/tag/ga4gh/tool-registry-service-schemas)


Expand All @@ -19,6 +20,7 @@ Cloud Work Stream
----------------------------------

The Cloud Work Stream is focused on creating specific standards for defining, sharing, and executing portable workflows and self-contained tasks, and accessing data across clouds.

We work with many different Driver Projects to develop, enhance, test, and use the Cloud Work Stream APIs.

What is the Tool Registry API Schema?
Expand Down Expand Up @@ -96,4 +98,4 @@ For more information
* [WES](https://github.com/ga4gh/wiki/wiki/Workflow-Execution-Service)
* [Global Alliance for Genomics and Health](https://www.ga4gh.org/) - GA4GH's main page
* [GA4GH Technical Alignment Sub Committee (TASC)](https://github.com/ga4gh/TASC) - we try to co-ordinate GA4GH API decisions here
uniqueg marked this conversation as resolved.
Show resolved Hide resolved
* [GA4GH Slack](https://ga4gh.slack.com/) - although you may need an invitation from a GA4GH administrator if your email domain name has not been allow-listed, see [https://github.com/ga4gh/TASC/issues/44](https://github.com/ga4gh/TASC/issues/44)
* [GA4GH Slack](https://ga4gh.slack.com/) - although you may need an invitation from a GA4GH administrator if your email domain name has not been allow-listed, see [https://github.com/ga4gh/TASC/issues/44](https://github.com/ga4gh/TASC/issues/44)
16 changes: 14 additions & 2 deletions openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,15 @@ paths:
description: Filter tools by the name of the descriptor type
schema:
$ref: '#/components/schemas/DescriptorType'
- name: tags
in: query
description: Filter tools by registry specific tags
schema:
type: array
items:
type: string
minItems: 1
explode: false
- name: registry
in: query
description: The image registry that contains the image.
Expand Down Expand Up @@ -629,7 +638,7 @@ components:
descriptor_type_version:
type: object
description: 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
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.
example: |
Expand All @@ -647,6 +656,9 @@ components:
description: Reports if this tool has a containerfile available. (For
Docker-based tools, this would indicate the presence of a
Dockerfile)
description:
type: string
description: The description of the tool version. This allows for documentation of a specific tool version as a tool evolves over time.
meta_version:
type: string
description: The version of this tool version in the registry. Iterates when
Expand Down Expand Up @@ -726,7 +738,7 @@ components:
- WDL
- NFL
- GALAXY
- SMK
- SMK
DescriptorTypeVersion:
type: string
description: The language version for a given descriptor type. The version should correspond
Expand Down