Populate workflow documentation area from Dockstore worfklow
How would I add to the documentation section of a workflow that is synced to a Dockstore workflow? I see in this page https://support.terra.bio/hc/en-us/articles/360031366091-Create-edit-and-share-a-new-workflow the comments at the top of their WDL file were automatically added to the documentation section, but this didn't work when I tried. To clarify, I want to add to this section of the workflow page without working through the methods repository:
Comments
6 comments
Hi Matthew Smith-Erb,
Unfortunately, that Synopsis section currently only works for workflows imported from the Broad Method Repository.
I've sent this request to our development team for consideration, and I'll be happy to follow up with you if this feature gets built.
Best,
Samantha
Hi Samantha,
I appreciate the quick response. I was afraid that might be the case. Is there some API I could use to update a method in the Broad Methods Repository whilst I push to my Github repository that is synced with Dockstore?
Best,
Matthew
Hi Matthew,
I think this is what you are looking for: https://api.firecloud.org/#/Method%20Repository/post_api_methods__namespace___name___snapshotId_.
For information on how to use Swagger, please see: How to authenticate/troubleshoot Swagger.
Best,
Samantha
Yep it looks like that endpoint should help me out.
Thanks again,
Matthew
Please add support for pulling in metadata from WDL. Suggest meta/description, or meta/synopsis if you want it to be Broad-specific.
While I'm asking, please support parameter_meta and show that documentation in the inputs tab!
Please sign in to leave a comment.