An open API service indexing awesome lists of open source software.

https://github.com/elixir-cloud-aai/openapi-test-runner

An application allowing the TES servers to test their conformance to TES Specifications
https://github.com/elixir-cloud-aai/openapi-test-runner

Last synced: about 1 year ago
JSON representation

An application allowing the TES servers to test their conformance to TES Specifications

Awesome Lists containing this project

README

          

[![License][badge-apache-license]](https://opensource.org/licenses/Apache-2.0)
[![Coverage][badge-coverage]][badge-url-coverage]
[![Python 3.6][badge-python]](https://www.python.org)

# TES Compliance Suite

The TES Compliance Suite determines a server's compliance with the [TES API specification][res-tes-spec]. The specification has been developed by the [Global Alliance for Genomics and Health][res-ga4gh], an international coalition, formed to enable the sharing of genomic and clinical data. It serves to provide a standardized API framework and data structure to allow for interoperability of datasets hosted at different institutions.

## Description

The compliance suite is designed as an abstract and API specification independent runner. It allows reusability of specs without having to make significant code changes. The suite is run via multiple YAML-based test files defining the test flow of an API endpoint.

## Documentation

Please refer [Installation and Usage][res-doc-installation] to get started with the installation and usage of suite.

You can also find more details about suite architecture and methodology.

- [Preamble](docs/preamble.md)
- [API Specification](docs/api_spec.md)
- [Architecture](docs/architecture.md)
- [Endpoint Test Flow](docs/endpoints.md)
- [Tests - Deep Analysis](docs/test_structure.md)
- [Report](docs/report.md)

## Contributing

This project is a community effort and lives off your contributions, be it in
the form of bug reports, feature requests, discussions, or fixes and other code
changes. Please refer to our organization's [contributing
guidelines][res-contributing] if you are interested to contribute.
Please mind the [code of conduct][res-coc] for all interactions
with the community.

## Versioning

The project adopts [semantic versioning][res-semver]. Currently, the service
is in alpha stage, so the API may change without further notice.

## License

This project is covered by the [Apache License 2.0][res-apache-license] also
[shipped with this repository][res-repo-license].

## Contact

The project is a collaborative effort under the umbrella of [ELIXIR Cloud &
AAI][res-elixir-cloud]. Follow the link to get in touch with us via chat or
email. Please mention the name of this service for any inquiry, proposal,
question etc.

![GA4GH_Logo_banner][img-logo-ga4gh]
![Elixir_Logo_banner][img-logo-elixir]

[badge-apache-license]: https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square
[badge-coverage]:
[badge-url-coverage]:
[badge-python]:
[img-logo-elixir]: docs/images/img-elixir.svg
[img-logo-ga4gh]: docs/images/img-ga4gh.svg
[res-elixir-cloud]:
[res-apache-license]:
[res-repo-license]: LICENSE
[res-semver]:
[res-contributing]:
[res-coc]:
[res-doc-installation]: docs/utility.md
[res-tes-spec]:
[res-ga4gh]: