-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
5,300 additions
and
1,902 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# This is a basic workflow to help you get started with Actions | ||
|
||
name: CI | ||
|
||
# Controls when the workflow will run | ||
on: [push] | ||
|
||
env: | ||
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} | ||
|
||
# A workflow run is made up of one or more jobs that can run sequentially or in parallel | ||
jobs: | ||
checkLinks: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Use Node.js | ||
uses: actions/setup-node@v1 | ||
with: | ||
node-version: 14.x | ||
- run: npm i -g markdown-link-check | ||
- run: markdown-link-check ./README.md | ||
buildPage: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Use Node.js | ||
uses: actions/setup-node@v1 | ||
with: | ||
node-version: 14.x | ||
- run: npm ci | ||
- run: npx gh-openapi-docs | ||
- run: bash scripts/update-ghpages.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
on: [push] | ||
|
||
|
||
jobs: | ||
test_swagger_editor_validator_remote: | ||
runs-on: ubuntu-latest | ||
name: Swagger Editor Validator Remote | ||
|
||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Validate OpenAPI definition | ||
uses: char0n/swagger-editor-validate@v1.2.1 | ||
with: | ||
definition-file: openapi/openapi.yaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"apiSpecPath": "openapi/openapi.yaml" | ||
} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
## Instruction for modifying the TRS | ||
|
||
To make changes to the TRS, join the GA4GH organization or ask to join this repository as a collaborator. Then in your branch, modify: | ||
- The swagger yaml file (`ga4gh-tool-discovery.yaml`) with a Swagger 2 definition of the changes. | ||
- This swagger yaml file will be used in the validation server. | ||
- An OpenAPI yaml file (`openapi.yaml`) with an OpenAPI 3 definition of the changes will be auto-generated by swagger2openapi and checked in by an automated TravisCI build | ||
- The openapi.yaml file with an OpenAPI 3 definition of the changes. | ||
- This openapi yaml file will be used in the TRS validation server. | ||
|
||
The v1 directory should not be modified. It provides backward compatibility support for TRS servers/clients. |
Oops, something went wrong.