Skip to content

ga4gh/ga4gh-registry

Repository files navigation

GA4GH Logo

License Java 11+ Gradle 6.1+ Travis (.org) branch Codecov

GA4GH Planet API

Using the API

See the GA4GH Planet OpenAPI Docs for full developer documentation on the production API.

The production API is available at https://registry.ga4gh.org/v1/. Example HTTPS requests include:

Starting the test server

Usage

Run Spring Boot application with externalized properies file:

./gradlew bootRun --args="--spring.config.location=file:./config/test/test.application.properties"

Testing

To run all tests, execute:

./gradlew test

The test report directory will be available at ./build/reports/tests/test. A local server can be started in that directory to view the report.

To generate the test coverage report, execute the following (after the above test report has been generated):

./gradlew jacocoTestReport

The coverage report directory will be available at ./build/reports/jacoco/test/html. A local server can be started in the directory to view the report.

Register an implementation

To register an implementation, please enter the information for the implementation being registered in the form of the json object below then send it to the GA4GH tech team email found in the maintainers section.

  {
    "id": "edu.caltech.rnaget",
    "name": "Caltech RNAget Reference Implementation",
    "type": {
      "group": "org.ga4gh",
      "artifact": "rnaget",
      "version": "1.0.0"
    },
    "organization": {
      "id": "edu.caltech",
      "name": "California Institute of Technology",
      "shortName": "Caltech",
      "url": "https://www.caltech.edu/"
    },
    "version": "1.0.0",
    "url": "https://felcat.caltech.edu/rnaget",
    "description": "RNAget implementation serving compliance test dataset",
    "contactUrl": "[email protected]",
    "documentationUrl": "https://felcat.caltech.edu/rnaget",
    "environment": "production"
  }

Maintainers

Issues

Feature requests, issues, and bugs may be reported via the Github issue tracker, or by emailing one of the above maintainers directly.

Changelog

v0.5.1

About

Implementation registry service for cataloguing implementations of GA4GH standards

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5

Languages