Skip to content

Commit

Permalink
update links in README
Browse files Browse the repository at this point in the history
fix README links

simplify links to spec (use gh-pages urls)
  • Loading branch information
jaeddy committed Oct 23, 2018
1 parent 48ec55a commit 92a5278
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Workflow Execution Service (WES) API
====================================

[![Build Status](https://travis-ci.org/ga4gh/workflow-execution-service-schemas.svg?branch=master)](https://travis-ci.org/ga4gh/workflow-execution-service-schemas)
<a href="https://raw.githubusercontent.com/ga4gh/workflow-execution-service-schemas/develop/openapi/workflow_execution_service.swagger.yaml"><img src="http://online.swagger.io/validator?url=https://raw.githubusercontent.com/ga4gh/workflow-execution-service-schemas/develop/openapi/workflow_execution_service.swagger.yaml" alt="Swagger Validator" height="20em" width="72em"></A>
<a href="https://ga4gh.github.io/workflow-execution-service-schemas/swagger.yaml"><img src="http://online.swagger.io/validator?url=https://ga4gh.github.io/workflow-execution-service-schemas/swagger.yaml" alt="Swagger Validator" height="20em" width="72em"></A>

The [Global Alliance for Genomics and Health](http://genomicsandhealth.org/) is an international coalition, formed to enable the sharing of genomic and clinical data.

Expand All @@ -31,7 +31,8 @@ API Definition
--------------

See the human-readable [Reference Documentation](https://ga4gh.github.io/workflow-execution-service-schemas/docs/)
and the [OpenAPI description](openapi/workflow_execution_service.swagger.yaml).
and the [OpenAPI description](openapi/workflow_execution_service.swagger.yaml). You can also explore the specification in [Swagger Editor](https://editor.swagger.io/#/?import=https://ga4gh.github.io/workflow-execution-service-schemas/swagger.yaml).


Use Cases
---------
Expand All @@ -49,7 +50,15 @@ Possible Future Enhancements
* a callback mechanism for monitoring status changes in running workflows (e.g. a webhook)
* integration with GA4GH data access APIs (e.g. htsget, DOS)

How to contribute changes
How to View
------------
- Documentation: https://ga4gh.github.io/workflow-execution-service-schemas/docs/
- Full API specification (OpenAPI YAML): https://ga4gh.github.io/workflow-execution-service-schemas/swagger.yaml (or view in [Swagger Editor](https://editor.swagger.io/#/?import=https://ga4gh.github.io/workflow-execution-service-schemas/swagger.yaml))
- Preview versions of docs or the spec for branch `[branch]`:
+ https://ga4gh.github.io/workflow-execution-service-schemas/preview/[branch]/docs/
+ https://ga4gh.github.io/workflow-execution-service-schemas/preview/[branch]/swagger.yaml (view in this version in Swagger Editor by adding the `[url]` for the link: https://editor.swagger.io/#/?import=[url])

How to Contribute Changes
-------------------------

See [CONTRIBUTING.md](CONTRIBUTING.md).
Expand Down
4 changes: 2 additions & 2 deletions scripts/deploydocs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ set -v
if [ "$TRAVIS_BRANCH" == "master" ]; then
cp docs/html5/index.html docs/
cp openapi/workflow_execution_service.swagger.yaml ./swagger.yaml
elif [ "$TRAVIS_BRANCH" != "gh-pages" ]; then
branch=$(echo "$TRAVIS_BRANCH" | awk '{print tolower($0)}')
elif [ "$BRANCH" != "gh-pages" ]; then
branch=$(echo "$BRANCH" | awk '{print tolower($0)}')
branchpath="preview/$branch"
mkdir -p "$branchpath/docs"
cp docs/html5/index.html "$branchpath/docs/"
Expand Down

0 comments on commit 92a5278

Please sign in to comment.