Skip to content

Commit e257cd1

Browse files
MarkRobboMarkRobbo
committed
Update API documentation
1 parent 31cc5ff commit e257cd1

File tree

2 files changed

+175
-44
lines changed

2 files changed

+175
-44
lines changed

‎src/main/resources/templates/apidocs.html

Lines changed: 174 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,31 @@ <h4>Parameters</h4>
5959
<tr>
6060
<td>url</td>
6161
<td>String</td>
62-
<td>The Github URL to the workflow</td>
62+
<td>The URL of the repository. Either a Gitlab or Github URL, or any Git repository URL.</td>
63+
</tr>
64+
<tr>
65+
<td>branch</td>
66+
<td>String</td>
67+
<td>The branch of the repository. Required if the URL is not from Gitlab or Github.</td>
68+
</tr>
69+
<tr>
70+
<td>path</td>
71+
<td>String</td>
72+
<td>The path within the repository to the workflow file. Required if the URL is not from Gitlab or Github.</td>
6373
</tr>
6474
</table>
6575
<h4>Input</h4>
6676
<pre class="highlight json">
6777
{
6878
"url": "https://github.com/common-workflow-language/workflows/tree/master/workflows/compile/compile1.cwl"
6979
}
80+
</pre>
81+
<pre class="highlight json">
82+
{
83+
"url": "https://bitbucket.org/markrobinson96/workflows.git",
84+
"branch": "master",
85+
"path": "/workflows/make-to-cwl/dna.cwl"
86+
}
7087
</pre>
7188
<h4>Success</h4>
7289
<pre>
@@ -84,7 +101,7 @@ <h4>Error</h4>
84101

85102
<h3 id="workflowDetails">Get Workflow Details</h3>
86103
<span class="method get">GET</span>
87-
<pre>/workflows/:githubURL</pre>
104+
<pre>/workflows/:url</pre>
88105
<h4>Parameters</h4>
89106
<table class="table">
90107
<tr>
@@ -93,9 +110,9 @@ <h4>Parameters</h4>
93110
<th>Description</th>
94111
</tr>
95112
<tr>
96-
<td>githubURL</td>
113+
<td>url</td>
97114
<td>String</td>
98-
<td>Partial github URL to the workflow (no "https://")</td>
115+
<td>Partial URL to the workflow eg "github.com/owner/repo/tree/branch/workflow.cwl" or "bitbucket.org/owner/repo.git/master/workflow.cwl</td>
99116
</tr>
100117
</table>
101118
<h4>Success 200</h4>
@@ -106,14 +123,9 @@ <h4>Success 200</h4>
106123
<th>Description</th>
107124
</tr>
108125
<tr>
109-
<td>retrievedFrom.owner</td>
126+
<td>retrievedFrom.repoUrl</td>
110127
<td>String</td>
111-
<td>Github username or organisation name</td>
112-
</tr>
113-
<tr>
114-
<td>retrievedFrom.repoName</td>
115-
<td>String</td>
116-
<td>Github repository name</td>
128+
<td>URL of the Github repository</td>
117129
</tr>
118130
<tr>
119131
<td>retrievedFrom.branch</td>
@@ -128,7 +140,17 @@ <h4>Success 200</h4>
128140
<tr>
129141
<td>retrievedFrom.url</td>
130142
<td>URL</td>
131-
<td>The full Github URL to the workflow</td>
143+
<td>The URL to the page on the site if type is not GENERIC, otherwise the same as repoUrl</td>
144+
</tr>
145+
<tr>
146+
<td>retrievedFrom.rawUrl</td>
147+
<td>URL</td>
148+
<td>The URL directly to the file if type is not GENERIC, otherwise the same as repoUrl</td>
149+
</tr>
150+
<tr>
151+
<td>retrievedFrom.type</td>
152+
<td>Enum</td>
153+
<td>One of GENERIC, GITHUB, GITLAB, BITBUCKET</td>
132154
</tr>
133155
<tr>
134156
<td>retrievedOn</td>
@@ -140,6 +162,11 @@ <h4>Success 200</h4>
140162
<td>String</td>
141163
<td>The last commit ID on the branch</td>
142164
</tr>
165+
<tr>
166+
<td>packedWorkflowID</td>
167+
<td>String</td>
168+
<td>The ID of the workflow within the file, if this is a packed CWL file (contains a <a href="http://www.commonwl.org/draft-3/SchemaSalad.html#Document_graph">document graph</a>).</td>
169+
</tr>
143170
<tr>
144171
<td>label</td>
145172
<td>String</td>
@@ -207,46 +234,39 @@ <h5>Example Response</h5>
207234
<pre class="highlight json">
208235
{
209236
"retrievedFrom": {
210-
"owner": "common-workflow-language",
211-
"repoName": "workflows",
237+
"repoUrl": "https://github.com/common-workflow-language/workflows.git",
212238
"branch": "master",
213239
"path": "workflows/lobSTR/lobSTR-workflow.cwl",
214-
"url": "https://github.com/common-workflow-language/workflows/tree/master/workflows/lobSTR/lobSTR-workflow.cwl"
240+
"url": "https://github.com/common-workflow-language/workflows/blob/master/workflows/lobSTR/lobSTR-workflow.cwl",
241+
"rawUrl": "https://raw.githubusercontent.com/common-workflow-language/workflows/master/workflows/lobSTR/lobSTR-workflow.cwl",
242+
"type": "GITHUB"
215243
},
216-
"retrievedOn": 1499175275743,
217-
"lastCommit": "920c6be45f08e979e715a0018f22c532b024074f",
244+
"retrievedOn": 1502714218616,
245+
"lastCommit": "17b65ea19d81527090fded62ffa0e1ba3b25d561",
218246
"label": "lobSTR-workflow.cwl",
219247
"inputs": {
220248
"reference": {
221-
"doc": "lobSTR's bwa reference files",
222249
"type": "File"
223250
},
224251
"rg-sample": {
225-
"doc": "Use this in the read group SM tag",
226252
"type": "String"
227253
},
228254
"p1": {
229-
"doc": "list of files containing the first end of paired end reads in fasta or fastq format",
230-
"type": "11a1d32ade317199b68e62aa6ce50b3e"
255+
"type": "ee54066e73d068edfbf9ca5059e14acd"
231256
},
232257
"p2": {
233-
"doc": "list of files containing the second end of paired end reads in fasta or fastq format",
234-
"type": "f9505470accbbaf6b9e15db2123490aa"
258+
"type": "79ab371b6d0fdbadbf9a4a89ef393353"
235259
},
236260
"output_prefix": {
237-
"doc": "prefix for output files. will output prefix.aligned.bam and prefix.aligned.stats",
238261
"type": "String"
239262
},
240263
"rg-lib": {
241-
"doc": "Use this in the read group LB tag",
242264
"type": "String"
243265
},
244266
"strinfo": {
245-
"doc": "File containing statistics for each STR.",
246267
"type": "File"
247268
},
248269
"noise_model": {
249-
"doc": "File to read noise model parameters from (.stepmodel)",
250270
"type": "File"
251271
}
252272
},
@@ -266,34 +286,145 @@ <h5>Example Response</h5>
266286
},
267287
"steps": {
268288
"allelotype": {
269-
"doc": "Run lobSTR allelotype classifier.",
270289
"run": "allelotype.cwl",
271-
"runType": "COMMANDLINETOOL"
290+
"runType": "COMMANDLINETOOL",
291+
"sources": {
292+
"file:///data/git/3ec0d19076841a1140e71cc3a1b330a56099aac2/workflows/lobSTR/lobSTR-workflow.cwl#allelotype/bam": {
293+
"sourceID": [
294+
"samindex"
295+
],
296+
"sourceIDs": [
297+
"samindex"
298+
]
299+
},
300+
"allelotype": {
301+
"sourceID": [
302+
"strinfo"
303+
],
304+
"sourceIDs": [
305+
"strinfo"
306+
]
307+
},
308+
"file:///data/git/3ec0d19076841a1140e71cc3a1b330a56099aac2/workflows/lobSTR/lobSTR-workflow.cwl#allelotype/noise_model": {
309+
"sourceID": [
310+
"noise_model"
311+
],
312+
"sourceIDs": [
313+
"noise_model"
314+
]
315+
},
316+
"file:///data/git/3ec0d19076841a1140e71cc3a1b330a56099aac2/workflows/lobSTR/lobSTR-workflow.cwl#allelotype/reference": {
317+
"sourceID": [
318+
"reference"
319+
],
320+
"sourceIDs": [
321+
"reference"
322+
]
323+
},
324+
"file:///data/git/3ec0d19076841a1140e71cc3a1b330a56099aac2/workflows/lobSTR/lobSTR-workflow.cwl#allelotype/output_prefix": {
325+
"sourceID": [
326+
"output_prefix"
327+
],
328+
"sourceIDs": [
329+
"output_prefix"
330+
]
331+
}
332+
}
272333
},
273334
"samsort": {
274-
"doc": "Invoke 'samtools sort' (samtools 1.19)",
275335
"run": "samtools-sort.cwl",
276-
"runType": "COMMANDLINETOOL"
336+
"runType": "COMMANDLINETOOL",
337+
"sources": {
338+
"samsort": {
339+
"sourceID": [
340+
"lobSTR"
341+
],
342+
"sourceIDs": [
343+
"lobSTR"
344+
]
345+
},
346+
"file:///data/git/3ec0d19076841a1140e71cc3a1b330a56099aac2/workflows/lobSTR/lobSTR-workflow.cwl#samsort/output_name": {
347+
"defaultVal": "\\\"aligned.sorted.bam\\\""
348+
}
349+
}
277350
},
278351
"lobSTR": {
279352
"label": "lobSTR",
280-
"doc": "lobSTR is a tool for profiling Short Tandem Repeats (STRs) from high throughput sequencing data.",
281353
"run": "lobSTR-tool.cwl",
282-
"runType": "COMMANDLINETOOL"
354+
"runType": "COMMANDLINETOOL",
355+
"sources": {
356+
"lobSTR": {
357+
"sourceID": [
358+
"rg-lib"
359+
],
360+
"sourceIDs": [
361+
"rg-lib"
362+
]
363+
},
364+
"file:///data/git/3ec0d19076841a1140e71cc3a1b330a56099aac2/workflows/lobSTR/lobSTR-workflow.cwl#lobSTR/p1": {
365+
"sourceID": [
366+
"p1"
367+
],
368+
"sourceIDs": [
369+
"p1"
370+
]
371+
},
372+
"file:///data/git/3ec0d19076841a1140e71cc3a1b330a56099aac2/workflows/lobSTR/lobSTR-workflow.cwl#lobSTR/p2": {
373+
"sourceID": [
374+
"p2"
375+
],
376+
"sourceIDs": [
377+
"p2"
378+
]
379+
},
380+
"file:///data/git/3ec0d19076841a1140e71cc3a1b330a56099aac2/workflows/lobSTR/lobSTR-workflow.cwl#lobSTR/output_prefix": {
381+
"sourceID": [
382+
"output_prefix"
383+
],
384+
"sourceIDs": [
385+
"output_prefix"
386+
]
387+
},
388+
"file:///data/git/3ec0d19076841a1140e71cc3a1b330a56099aac2/workflows/lobSTR/lobSTR-workflow.cwl#lobSTR/rg-sample": {
389+
"sourceID": [
390+
"rg-sample"
391+
],
392+
"sourceIDs": [
393+
"rg-sample"
394+
]
395+
},
396+
"file:///data/git/3ec0d19076841a1140e71cc3a1b330a56099aac2/workflows/lobSTR/lobSTR-workflow.cwl#lobSTR/reference": {
397+
"sourceID": [
398+
"reference"
399+
],
400+
"sourceIDs": [
401+
"reference"
402+
]
403+
}
404+
}
283405
},
284406
"samindex": {
285-
"doc": "Invoke 'samtools index' to create a 'BAI' index (samtools 1.19)",
286407
"run": "samtools-index.cwl",
287-
"runType": "COMMANDLINETOOL"
408+
"runType": "COMMANDLINETOOL",
409+
"sources": {
410+
"samindex": {
411+
"sourceID": [
412+
"samsort"
413+
],
414+
"sourceIDs": [
415+
"samsort"
416+
]
417+
}
418+
}
288419
}
289420
},
290-
"dockerLink": "true",
291-
"cwltoolVersion": " 1.0.20170622090721",
292-
"visualisationDot": "digraph workflow {\n graph [\n bgcolor = \"#eeeeee\"\n color = \"black\"\n fontsize = \"10\"\n labeljust = \"left\"\n clusterrank = \"local\"\n ranksep = \"0.22\"\n nodesep = \"0.05\"\n ]\n node [\n fontname = \"Helvetica\"\n fontsize = \"10\"\n fontcolor = \"black\"\n shape = \"record\"\n height = \"0\"\n width = \"0\"\n color = \"black\"\n fillcolor = \"lightgoldenrodyellow\"\n style = \"filled\"\n ];\n edge [\n fontname=\"Helvetica\"\n fontsize=\"8\"\n fontcolor=\"black\"\n color=\"black\"\n arrowsize=\"0.7\"\n ];\n subgraph cluster_inputs {\n rank = \"same\";\n style = \"dashed\";\n label = \"Workflow Inputs\";\n \"lobSTR-workflow.cwl#output_prefix\" [fillcolor=\"#94DDF4\",label=\"output_prefix\"];\n \"lobSTR-workflow.cwl#reference\" [fillcolor=\"#94DDF4\",label=\"reference\"];\n \"lobSTR-workflow.cwl#p2\" [fillcolor=\"#94DDF4\",label=\"p2\"];\n \"lobSTR-workflow.cwl#p2\" [fillcolor=\"#94DDF4\",label=\"p2\"];\n \"lobSTR-workflow.cwl#strinfo\" [fillcolor=\"#94DDF4\",label=\"strinfo\"];\n \"lobSTR-workflow.cwl#p1\" [fillcolor=\"#94DDF4\",label=\"p1\"];\n \"lobSTR-workflow.cwl#p1\" [fillcolor=\"#94DDF4\",label=\"p1\"];\n \"lobSTR-workflow.cwl#rg-lib\" [fillcolor=\"#94DDF4\",label=\"rg-lib\"];\n \"lobSTR-workflow.cwl#noise_model\" [fillcolor=\"#94DDF4\",label=\"noise_model\"];\n \"lobSTR-workflow.cwl#rg-sample\" [fillcolor=\"#94DDF4\",label=\"rg-sample\"];\n }\n subgraph cluster_outputs {\n rank = \"same\";\n style = \"dashed\";\n label = \"Workflow Outputs\";\n \"lobSTR-workflow.cwl#bam_stats\" [fillcolor=\"#94DDF4\",label=\"bam_stats\"];\n \"lobSTR-workflow.cwl#vcf_stats\" [fillcolor=\"#94DDF4\",label=\"vcf_stats\"];\n \"lobSTR-workflow.cwl#vcf\" [fillcolor=\"#94DDF4\",label=\"vcf\"];\n \"lobSTR-workflow.cwl#bam\" [fillcolor=\"#94DDF4\",label=\"bam\"];\n }\n \"lobSTR-workflow.cwl#allelotype\" [label=\"allelotype\"];\n \"lobSTR-workflow.cwl#samindex\" [label=\"samindex\"];\n \"lobSTR-workflow.cwl#samsort\" [label=\"samsort\"];\n \"lobSTR-workflow.cwl#lobSTR\" [label=\"lobSTR\"];\n}\n",
293-
"robundle": "/robundle/github.com/common-workflow-language/workflows/tree/master/workflows/lobSTR/lobSTR-workflow.cwl",
294-
"visualisationXdot": "/graph/xdot/github.com/common-workflow-language/workflows/tree/master/workflows/lobSTR/lobSTR-workflow.cwl",
295-
"visualisationPng": "/graph/png/github.com/common-workflow-language/workflows/tree/master/workflows/lobSTR/lobSTR-workflow.cwl",
296-
"visualisationSvg": "/graph/svg/github.com/common-workflow-language/workflows/tree/master/workflows/lobSTR/lobSTR-workflow.cwl"
421+
"dockerLink": "https://hub.docker.com/r/rabix/lobstr",
422+
"cwltoolVersion": "1.0.20170810192106",
423+
"visualisationDot": "digraph workflow {\n graph [\n bgcolor = \"#eeeeee\"\n color = \"black\"\n fontsize = \"10\"\n labeljust = \"left\"\n clusterrank = \"local\"\n ranksep = \"0.22\"\n nodesep = \"0.05\"\n ]\n node [\n fontname = \"Helvetica\"\n fontsize = \"10\"\n fontcolor = \"black\"\n shape = \"record\"\n height = \"0\"\n width = \"0\"\n color = \"black\"\n fillcolor = \"lightgoldenrodyellow\"\n style = \"filled\"\n ];\n edge [\n fontname=\"Helvetica\"\n fontsize=\"8\"\n fontcolor=\"black\"\n color=\"black\"\n arrowsize=\"0.7\"\n ];\n subgraph cluster_inputs {\n rank = \"same\";\n style = \"dashed\";\n label = \"Workflow Inputs\";\n \"p2\" [fillcolor=\"#94DDF4\",label=\"p2\"];\n \"p2\" [fillcolor=\"#94DDF4\",label=\"p2\"];\n \"output_prefix\" [fillcolor=\"#94DDF4\",label=\"output_prefix\"];\n \"reference\" [fillcolor=\"#94DDF4\",label=\"reference\"];\n \"noise_model\" [fillcolor=\"#94DDF4\",label=\"noise_model\"];\n \"strinfo\" [fillcolor=\"#94DDF4\",label=\"strinfo\"];\n \"p1\" [fillcolor=\"#94DDF4\",label=\"p1\"];\n \"p1\" [fillcolor=\"#94DDF4\",label=\"p1\"];\n \"rg-lib\" [fillcolor=\"#94DDF4\",label=\"rg-lib\"];\n \"rg-sample\" [fillcolor=\"#94DDF4\",label=\"rg-sample\"];\n }\n subgraph cluster_outputs {\n rank = \"same\";\n style = \"dashed\";\n labelloc = \"b\";\n label = \"Workflow Outputs\";\n \"bam\" [fillcolor=\"#94DDF4\",label=\"bam\"];\n \"vcf\" [fillcolor=\"#94DDF4\",label=\"vcf\"];\n \"bam_stats\" [fillcolor=\"#94DDF4\",label=\"bam_stats\"];\n \"vcf_stats\" [fillcolor=\"#94DDF4\",label=\"vcf_stats\"];\n }\n \"allelotype\" [label=\"allelotype\"];\n \"samsort\" [label=\"samsort\"];\n \"lobSTR\" [label=\"lobSTR\"];\n \"samindex\" [label=\"samindex\"];\n \"strinfo\" -> \"allelotype\" [label=\"strinfo\"];\n \"reference\" -> \"allelotype\" [label=\"reference\"];\n \"output_prefix\" -> \"allelotype\" [label=\"output_prefix\"];\n \"noise_model\" -> \"allelotype\" [label=\"noise_model\"];\n \"samindex\" -> \"allelotype\" [label=\"bam\"];\n \"lobSTR\" -> \"samsort\" [label=\"input\"];\n \"default1\" -> \"samsort\" [label=\"output_name\"];\n \"default1\" [label=\"\\\"aligned.sorted.bam\\\"\", fillcolor=\"#D5AEFC\"];\n \"rg-lib\" -> \"lobSTR\" [label=\"rg-lib\"];\n \"rg-sample\" -> \"lobSTR\" [label=\"rg-sample\"];\n \"p2\" -> \"lobSTR\" [label=\"p2\"];\n \"p1\" -> \"lobSTR\" [label=\"p1\"];\n \"reference\" -> \"lobSTR\" [label=\"reference\"];\n \"output_prefix\" -> \"lobSTR\" [label=\"output_prefix\"];\n \"samsort\" -> \"samindex\" [label=\"input\"];\n \"samindex\" -> \"bam\";\n \"allelotype\" -> \"vcf\";\n \"lobSTR\" -> \"bam_stats\";\n \"allelotype\" -> \"vcf_stats\";\n}\n",
424+
"visualisationPng": "/graph/png/github.com/common-workflow-language/workflows/blob/master/workflows/lobSTR/lobSTR-workflow.cwl",
425+
"visualisationSvg": "/graph/svg/github.com/common-workflow-language/workflows/blob/master/workflows/lobSTR/lobSTR-workflow.cwl",
426+
"roBundle": "/robundle/github.com/common-workflow-language/workflows/blob/master/workflows/lobSTR/lobSTR-workflow.cwl",
427+
"visualisationXdot": "/graph/xdot/github.com/common-workflow-language/workflows/blob/master/workflows/lobSTR/lobSTR-workflow.cwl"
297428
}
298429
</pre>
299430

@@ -454,7 +585,7 @@ <h5>Example Responses</h5>
454585
<h4>Finished 303</h4>
455586
<pre>
456587
HTTP/1.1 303 See Other
457-
Location: /workflows/:githubURL
588+
Location: /workflows/:url
458589
</pre>
459590

460591
<h2>Examples</h2>

‎src/main/resources/templates/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ <h2>Workflow URL</h2>
5353
<strong>Don't know what to view?</strong> Try these from <i>common-workflow-language/workflows</i>:
5454
<a class="example" href="https://github.com/common-workflow-language/workflows/tree/master/workflows/compile/compile1.cwl">compile</a>,
5555
<a class="example" href="https://github.com/common-workflow-language/workflows/tree/master/workflows/make-to-cwl/dna.cwl">make-to-cwl</a>,
56-
<a class="example" href="https://github.com/common-workflow-language/workflows/tree/lobstr-v1/workflows/lobSTR/lobSTR-workflow.cwl">lobSTR</a>
56+
<a class="example" href="https://github.com/common-workflow-language/workflows/tree/master/workflows/lobSTR/lobSTR-workflow.cwl">lobSTR</a>
5757
or <a href="/workflows">explore the collection</a>
5858
</div>
5959
<form id="add" action="#" th:action="@{/workflows}" th:object="${workflowForm}" method="POST">

0 commit comments

Comments
 (0)