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.

Sign up for GitHub

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

Jump to bottom

No description property in tool version #228

Closed
patmagee opened this issue Nov 24, 2022 · 0 comments
Closed

No description property in tool version #228

patmagee opened this issue Nov 24, 2022 · 0 comments
Milestone
v2.1

Comments

@patmagee
Copy link
Contributor

patmagee commented Nov 24, 2022 •
edited by unito-bot
Loading

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:

  1. Do not directly describe versions, instead the description is more specific to the overarching tool
  2. Only describe the most recent version
  3. 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
@denis-yuen denis-yuen added this to the v2.1 milestone Nov 24, 2022
denis-yuen added a commit that referenced this issue Feb 22, 2023
@denis-yuen
Add tool version specific description #228
9760fee
denis-yuen added a commit that referenced this issue Apr 5, 2023
@denis-yuen
Small comment round up (#239)
1dd4bf8 
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v2.1
Development

No branches or pull requests
2 participants
@denis-yuen @patmagee