Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-kotliar committed Jul 24, 2019
1 parent 2bb35d2 commit 5ae56b8
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions docs/readme/rest_api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# REST API

## Specification
Besides built-in API, provided by Airflow Webserver, CWL-Airflow allows to run API server separately.

Please follow the link on [SwaggerHub](https://app.swaggerhub.com/apis/michael-kotliar/cwl_airflow_workflow_execution_service/1.0.0)
To start API server run the following command
```sh
$ cwl-airflow wesserver
```

Optional parameters:

| Flag | Description | Default |
| ------ | ----------------------- | --------- |
| --port | Port to run WES servert | 8080 |
| --host | Host to run WES server | 127.0.0.1 |

**For detailed API specification, please follow the link on [SwaggerHub](https://app.swaggerhub.com/apis/michael-kotliar/cwl_airflow_workflow_execution_service/1.0.0)**

0 comments on commit 5ae56b8

Please sign in to comment.