Skip to content

Commit 8657178

Browse files
committed
Changing header level of API
1 parent 22b2790 commit 8657178

File tree

1 file changed

+15
-20
lines changed

1 file changed

+15
-20
lines changed

docs/api/RESTAPI.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,8 @@
1919
* `application/json`
2020

2121

22-
23-
24-
<a name="paths"></a>
25-
## Paths
26-
2722
<a name="api-workflows-version-post"></a>
28-
### Submit a workflow for execution
23+
## Submit a workflow for execution
2924
```
3025
POST /api/workflows/{version}
3126
```
@@ -80,7 +75,7 @@ Submits a workflow to Cromwell. Note that this endpoint can accept an unlimited
8075

8176

8277
<a name="api-workflows-version-backends-get"></a>
83-
### List the supported backends
78+
## List the supported backends
8479
```
8580
GET /api/workflows/{version}/backends
8681
```
@@ -117,7 +112,7 @@ Returns the backends supported by this Cromwell server, as well as the default b
117112

118113

119114
<a name="api-workflows-version-batch-post"></a>
120-
### Submit a batch of workflows for execution
115+
## Submit a batch of workflows for execution
121116
```
122117
POST /api/workflows/{version}/batch
123118
```
@@ -168,7 +163,7 @@ In instances where you want to run the same workflow multiple times with varying
168163

169164

170165
<a name="api-workflows-version-callcaching-diff-get"></a>
171-
### Explain hashing differences for 2 calls
166+
## Explain hashing differences for 2 calls
172167
```
173168
GET /api/workflows/{version}/callcaching/diff
174169
```
@@ -214,7 +209,7 @@ This endpoint returns the hash differences between 2 completed (successfully or
214209

215210

216211
<a name="api-workflows-version-query-post"></a>
217-
### Get workflows matching some criteria
212+
## Get workflows matching some criteria
218213
```
219214
POST /api/workflows/{version}/query
220215
```
@@ -254,7 +249,7 @@ Query workflows by start dates, end dates, names, ids, or statuses.
254249

255250

256251
<a name="api-workflows-version-query-get"></a>
257-
### Get workflows matching some criteria
252+
## Get workflows matching some criteria
258253
```
259254
GET /api/workflows/{version}/query
260255
```
@@ -300,7 +295,7 @@ Query for workflows which match various criteria. When a combination of criteria
300295

301296

302297
<a name="api-workflows-version-id-abort-post"></a>
303-
### Abort a running workflow
298+
## Abort a running workflow
304299
```
305300
POST /api/workflows/{version}/{id}/abort
306301
```
@@ -342,7 +337,7 @@ Request Cromwell to abort a running workflow. For instance this might be necessa
342337

343338

344339
<a name="api-workflows-version-id-labels-patch"></a>
345-
### Update labels for a workflow
340+
## Update labels for a workflow
346341
```
347342
PATCH /api/workflows/{version}/{id}/labels
348343
```
@@ -385,7 +380,7 @@ Update multiple labels for an existing workflow. When supplying a label with a k
385380

386381

387382
<a name="api-workflows-version-id-logs-get"></a>
388-
### Get the logs for a workflow
383+
## Get the logs for a workflow
389384
```
390385
GET /api/workflows/{version}/{id}/logs
391386
```
@@ -426,7 +421,7 @@ Returns paths to the standard out and standard error files that were generated d
426421

427422

428423
<a name="api-workflows-version-id-metadata-get"></a>
429-
### Get workflow and call-level metadata for a specified workflow
424+
## Get workflow and call-level metadata for a specified workflow
430425
```
431426
GET /api/workflows/{version}/{id}/metadata
432427
```
@@ -599,7 +594,7 @@ json :
599594

600595

601596
<a name="api-workflows-version-id-outputs-get"></a>
602-
### Get the outputs for a workflow
597+
## Get the outputs for a workflow
603598
```
604599
GET /api/workflows/{version}/{id}/outputs
605600
```
@@ -640,7 +635,7 @@ Retrieve the outputs for the specified workflow. Cromwell will return any output
640635

641636

642637
<a name="api-workflows-version-id-status-get"></a>
643-
### Retrieves the current state for a workflow
638+
## Retrieves the current state for a workflow
644639
```
645640
GET /api/workflows/{version}/{id}/status
646641
```
@@ -677,7 +672,7 @@ GET /api/workflows/{version}/{id}/status
677672

678673

679674
<a name="api-workflows-version-id-timing-get"></a>
680-
### Get a visual diagram of a running workflow
675+
## Get a visual diagram of a running workflow
681676
```
682677
GET /api/workflows/{version}/{id}/timing
683678
```
@@ -718,7 +713,7 @@ Returns a javascript file which will render a Gantt chart for the requested work
718713

719714

720715
<a name="engine-version-stats-get"></a>
721-
### Returns basic statistics from this Cromwell server.
716+
## Returns basic statistics from this Cromwell server.
722717
```
723718
GET /engine/{version}/stats
724719
```
@@ -744,7 +739,7 @@ GET /engine/{version}/stats
744739

745740

746741
<a name="engine-version-status-get"></a>
747-
### Return the current health status of any monitored subsystems
742+
## Return the current health status of any monitored subsystems
748743
```
749744
GET /engine/{version}/status
750745
```

0 commit comments

Comments
 (0)