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

Document TRS specification's requirement that are not covered by Yevs registry #5

Closed
inutano opened this issue Jun 5, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@inutano
Copy link
Contributor

inutano commented Jun 5, 2023

From ddbj/workflow-registry#15

From @suecharo

As stated at https://editor.swagger.io/?url=https://raw.githubusercontent.com/ga4gh/tool-registry-schemas/develop/openapi/openapi.yaml, "Descriptors can often include imports that refer to additional descriptors. This returns additional descriptors for the specified tool in the same or other directories that can be reached as a relative path. This endpoint can be useful for workflow engine implementations like cwltool to programmatically download all the descriptors for a tool and run it. This can optionally include other files described with FileWrappers such as test parameters and containerfiles.", the original TRS definition indeed expects that behavior.
However, in yevis, due to the specification that returns TRS responses via GitHub pages, we are unable to implement this behavior. Instead, we're including the download link in the path of the /files response.

ToDo:

  • Yevis-cli のドキュメントに追記
  • Yevis-cli から生成されたレジストリのドキュメントに追記できるか?
@inutano inutano added the documentation Improvements or additions to documentation label Jun 5, 2023
@inutano inutano changed the title Document TRS specification that are not covered Document TRS specification's requirement that are not covered by Yevs registry Jun 5, 2023
@suecharo
Copy link
Collaborator

suecharo commented Jun 5, 2023

@suecharo suecharo closed this as completed Jun 5, 2023
@inutano
Copy link
Contributor Author

inutano commented Jun 6, 2023

Thanks!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

No branches or pull requests

2 participants