File endpoint #25
Merged
File endpoint #25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
denis-yuen
requested changes
Jan 12, 2018
| - name: type | ||
| required: true | ||
| in: path | ||
| description: The output type of the descriptor. If not specified it is up to the underlying implementation to determine which output type to return. Plain types return the bare descriptor while the "non-plain" types return a descriptor wrapped with metadata. Allowable values are "CWL" and "WDL". |
There was a problem hiding this comment.
This is returning an array of ToolFile, so this description (especially the part about plain types) seems off
| items: | ||
| $ref: '#/definitions/ToolFile' | ||
| '404': | ||
| description: The tool can not be output in the specified type. |
There was a problem hiding this comment.
This might have been copied and not changed
There was a problem hiding this comment.
I believe the error is for when somebody puts an unknown descriptor type in the path parameter. Even though the tool exists, the tool can not be output in the specified type. Using WDL on a CWL tool on the other hand does not trigger a 404, only a 204.
| properties: | ||
| path: | ||
| type: string | ||
| description: Relative path of a file that can be used with the GA4GH .../{type}/descriptor/{relative_path} endpoint if the file is a primary or secondary descriptor |
There was a problem hiding this comment.
What can be done with the dockerfile and test files? (as a question that comes up when reading this and could be useful to document)
denis-yuen
approved these changes
Jan 16, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduces a new endpoint to display relative paths of all files for #20
Provides a better description for #21 and #22