Skip to content

Commit b343769

Browse files
committed
Update API docs
1 parent 9c73b39 commit b343769

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

src/main/resources/templates/apidocs.html

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ <h1>JSON API Documentation</h1>
4040
<p>If you make anything utilizing our API, please <a href="https://gitter.im/common-workflow-language/cwlviewer" alt="Gitter Chatroom" target="_blank" rel="noopener">let us know about it</a> - we would love to see!</p>
4141

4242
<p>All queries require the following header to receive a JSON response:
43-
<pre>accept: application/json</pre>
43+
<pre class="highlight http">accept: application/json</pre>
4444
</p>
4545

4646
<h2>Workflow</h2>
@@ -86,18 +86,31 @@ <h4>Input</h4>
8686
}
8787
</pre>
8888
<h4>Success</h4>
89-
<pre>
89+
<pre class="highlight http">
9090
HTTP/1.1 202 Accepted
9191
Location: /queue/:queueid
9292
</pre>
9393
<h4>Already Exists</h4>
94-
<pre>
94+
<pre class="highlight http">
9595
HTTP/1.1 303 See Other
9696
Location: /workflows/:githubURL
9797
</pre>
98-
98+
<h4>Packed Workflow with Multiple Choices</h4>
99+
<pre class="highlight json">
100+
HTTP/1.1 422 Unprocessable Entity
101+
{
102+
"message": "This workflow file is packed and contains multiple workflow descriptions. Please choose one to add"
103+
"workflows": [
104+
"#workflow.cwl",
105+
"#main",
106+
"#workflow_exome.cwl",
107+
"#align.cwl",
108+
"#workflow.cwl_2"
109+
]
110+
}
111+
</pre>
99112
<h4>Error</h4>
100-
<pre>HTTP/1.1 400 Bad Request</pre>
113+
<pre class="highlight http">HTTP/1.1 400 Bad Request</pre>
101114

102115
<h3 id="workflowDetails">Get Workflow Details</h3>
103116
<span class="method get">GET</span>
@@ -544,7 +557,7 @@ <h5>Example Responses</h5>
544557
</pre>
545558

546559
<h4>Finished 303</h4>
547-
<pre>
560+
<pre class="highlight http">
548561
HTTP/1.1 303 See Other
549562
Location: /workflows/:url
550563
</pre>

0 commit comments

Comments
 (0)