You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When looking more into the spec I noticed the description property is a part of the Tool object but not a part of the ToolVersion. This seems a bit odd since the description changes over time in order to describe how to use a given tool. At the moment, this leads to a documentation gap: How can a user describe a given version when there are multiple versions of a tool defined?
The current options would be:
Do not directly describe versions, instead the description is more specific to the overarching tool
Only describe the most recent version
Jam All version descriptions into the same description
I propose a new optional field in the ToolVersion called description, which is the exact same as the description in the parent Tool
┆Issue is synchronized with this Jira Story
┆Project Name: Zzz-ARCHIVE GA4GH tool-registry-service
┆Issue Number: TRS-62
The text was updated successfully, but these errors were encountered:
* 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
When looking more into the spec I noticed the
description
property is a part of theTool
object but not a part of theToolVersion
. This seems a bit odd since thedescription
changes over time in order to describe how to use a given tool. At the moment, this leads to a documentation gap: How can a user describe a given version when there are multiple versions of a tool defined?The current options would be:
I propose a new optional field in the
ToolVersion
calleddescription
, which is the exact same as the description in the parentTool
┆Issue is synchronized with this Jira Story
┆Project Name: Zzz-ARCHIVE GA4GH tool-registry-service
┆Issue Number: TRS-62
The text was updated successfully, but these errors were encountered: