From 1dd4bf806f98fa2e3d224d1976f6179de5cd46d6 Mon Sep 17 00:00:00 2001 From: Denis Yuen Date: Wed, 5 Apr 2023 18:02:00 -0400 Subject: [PATCH] Small comment round up (#239) * update readme * swagger and v2 clean-up https://github.com/ga4gh/tool-registry-service-schemas/issues/229 * script seems broken with feature branches * Documentation updates for https://github.com/ga4gh/tool-registry-service-schemas/issues/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 --- README.md | 4 +++- openapi/openapi.yaml | 16 ++++++++++++++-- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3f0ac74..d2d402b 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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? @@ -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 -* [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) \ No newline at end of file diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml index baf2ffe..3cac981 100644 --- a/openapi/openapi.yaml +++ b/openapi/openapi.yaml @@ -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. @@ -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: | @@ -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 @@ -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