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

Propose to remove ToolDockerfile.descriptor #22

Closed
delagoya opened this issue Aug 11, 2017 · 3 comments
Closed

Propose to remove ToolDockerfile.descriptor #22

delagoya opened this issue Aug 11, 2017 · 3 comments
Assignees
Milestone

Comments

@delagoya
Copy link

Much like issue #21 having both a descriptor and url seems redundant and the url should be the canonical source.

Both of these seems like an optimization for a particular implementation of a the Dockstore UI.

@denis-yuen
Copy link
Member

denis-yuen commented Aug 11, 2017

Like the suggestion in #21 I think it makes sense to make url optional rather than the canonical source.

@garyluu
Copy link
Contributor

garyluu commented Jan 8, 2018

Looks like descriptor isn't present in ToolDockerfile:

  ToolDockerfile:
    type: object
    description: A tool dockerfile is a document that describes how to build a particular Docker image.
    required:
      - dockerfile
    properties:
      dockerfile:
        type: string
        description: The dockerfile content for this tool.
      url:
        type: string
description: 'Optional url to the dockerfile used to build this image, should include version information, and can include

Just the dockerfile contents and the optional url

@denis-yuen denis-yuen added this to the v2 milestone Jan 8, 2018
@denis-yuen
Copy link
Member

the proposed idea is that dockerfile is treated in the same way as descriptor in #21. Do not confuse that with the precise name of the property which is of course different.
Let's get that this in there
i.e.

make X.descriptor/dockerfile optional in the response if ToolDescriptor.url is provided.

garyluu added a commit that referenced this issue Jan 8, 2018
@garyluu garyluu mentioned this issue Jan 10, 2018
garyluu added a commit that referenced this issue Feb 20, 2018
garyluu added a commit that referenced this issue Feb 6, 2020
Changes from 2.0.0 + CI fix:

* Explicitly define type in definitions

* Change properties to snakes case and endpoints to camelcase

* Move enum to its own definition

* Incrementing version due to breaking changes

* New endpoint and object definition to describe available files

* For issues #21 and #22

* Renamed File definition to ToolFile due to swagger editor

* Increment version in comment

* Add more file types, better descriptions

* Tool checker proposal (#26)

From https://docs.google.com/document/d/1PTge27WBOKCiR2MkVSOvWKUwnFk0kx-bjq39aKRQxcY/edit?usp=sharing

* Generalize the TRS to account for Singularity and Nextflow
* Change toolversion's boolean indicator

* Add terms of service placeholder

* Install swagger2openapi

* Adding operationIds (#33)

See  dockstore/dockstore#1210

* Moved checker to a property in Tool, also added a boolean

* Specify unencoded paths are also allowed

* Feature/search (#48)

* Add option for search for checker workflows
* For #37 , allow meta_version to be optional

ga4gh/workflow-execution-service-schemas#6
ga4gh/workflow-execution-service-schemas@337cd42

* Add alias suggestion from #38
* Standardize file fields
* Simplify standard (#49)

* Feature/link check (#55)

* Create CONTRIBUTING.md (#65)

* Automatically generate docs for all branches and tags

* TRS documentation update (#64)

* Update openAPI3.sh

* Update BasePath (#72)

Updated base path to `basePath: `/ga4gh/trs/v2`

* Update ga4gh-tool-discovery.yaml (#74)

* Updated LICENCE Copyright (#76)

* Include mention to Nextflow (#77)

Mentioning nextflow as long the API is supporting workflows 
based on Nextflow language (NFL) https://github.com/pditommaso/tool-registry-service-schemas/blob/develop/src/main/resources/swagger/openapi.yaml#L741-L744

* Allow for more than one container image (#58)

* fix type, update OpenAPI version

* fix array examples

* Update openapi.yaml

* Rename metadata to match GA4GH PAP (#78)

* Adding zenodo reference as recommended
* Adding contact URL inspired by WES for PAP
From security questionaire

* More convention sync with cloud workstream APIs (#84)

* Working on #82 also see ga4gh/workflow-execution-service-schemas#134
* Working on harmonizing with GA4GH Discovery  https://github.com/ga4gh-discovery/service-info
* Fix description for #85

* WS-2019-0032  WS-2019-0063

* Attempt to fix tooling (#89)

* Update README.md for gitflow (#91)

* Simple PRC feedback PR (#92)

* Feedback from BOSC

* Typo in example (#99)

* Remove service-info to avoid breaking change (#101)

* Move around a few fields (#97)

* test gradle fix for site deployment (#105)

* Optional auth (#102)

* PRC feedback - strict tool versioning for reproducibility (#93)

* Update to match discussion in DRS
checksum object added and tweaked to match ga4gh/data-repository-service-schemas#282

* Corrects link to GA4GH . checksum hash algorithm registry (#106)

* Correcting hash algorithm registry link

* Correcting hash alg registry link

* Fixing unrelated link

* Glitchy badge (#112)

* Update registry.json (#115)

* Fix CI (#123)

Co-authored-by: Denis Yuen <denis.yuen@oicr.on.ca>
Co-authored-by: Yasset Perez-Riverol <ypriverol@gmail.com>
Co-authored-by: Chris Llanwarne <cjllanwarne@users.noreply.github.com>
Co-authored-by: Susheel Varma <susheel@users.noreply.github.com>
Co-authored-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>
Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants