Skip to content

Commit 1dd4bf8

Browse files
authored
Small comment round up (#239)
* update readme * swagger and v2 clean-up #229 * script seems broken with feature branches * Documentation updates for #114 * typo fix and trigger build * fix link and really re-genrate TOC * prep for next version and even more re-generate * propose tag-based search #205 * Add tool version specific description #228
1 parent 4204d76 commit 1dd4bf8

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

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

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

78

@@ -19,6 +20,7 @@ Cloud Work Stream
1920
----------------------------------
2021

2122
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.
23+
2224
We work with many different Driver Projects to develop, enhance, test, and use the Cloud Work Stream APIs.
2325

2426
What is the Tool Registry API Schema?
@@ -96,4 +98,4 @@ For more information
9698
* [WES](https://github.com/ga4gh/wiki/wiki/Workflow-Execution-Service)
9799
* [Global Alliance for Genomics and Health](https://www.ga4gh.org/) - GA4GH's main page
98100
* [GA4GH Technical Alignment Sub Committee (TASC)](https://github.com/ga4gh/TASC) - we try to co-ordinate GA4GH API decisions here
99-
* [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)
101+
* [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)

openapi/openapi.yaml

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,15 @@ paths:
128128
description: Filter tools by the name of the descriptor type
129129
schema:
130130
$ref: '#/components/schemas/DescriptorType'
131+
- name: tags
132+
in: query
133+
description: Filter tools by registry specific tags
134+
schema:
135+
type: array
136+
items:
137+
type: string
138+
minItems: 1
139+
explode: false
131140
- name: registry
132141
in: query
133142
description: The image registry that contains the image.
@@ -629,7 +638,7 @@ components:
629638
descriptor_type_version:
630639
type: object
631640
description: A map providing information about the language versions used in this tool. The keys should be the
632-
same values used in the `descriptor_type` field, and the value should be an array of all the language versions used
641+
same values used in the `descriptor_type` field, and the value should be an array of all the language versions used
633642
for the given `descriptor_type`. Depending on the `descriptor_type` (e.g. CWL) multiple version values may be used
634643
in a single tool.
635644
example: |
@@ -647,6 +656,9 @@ components:
647656
description: Reports if this tool has a containerfile available. (For
648657
Docker-based tools, this would indicate the presence of a
649658
Dockerfile)
659+
description:
660+
type: string
661+
description: The description of the tool version. This allows for documentation of a specific tool version as a tool evolves over time.
650662
meta_version:
651663
type: string
652664
description: The version of this tool version in the registry. Iterates when
@@ -726,7 +738,7 @@ components:
726738
- WDL
727739
- NFL
728740
- GALAXY
729-
- SMK
741+
- SMK
730742
DescriptorTypeVersion:
731743
type: string
732744
description: The language version for a given descriptor type. The version should correspond

0 commit comments

Comments
 (0)