a2cps / vbr-app

Virtual Biospecimen Repository Web Service API
Other
0 stars 0 forks source link

VBR API

|docs| |openapi| |status|

Purpose

The Virtual Biospecimen Repository API provides sample management and logistics support for biological samples collected and analyzed by the NIH Acute to Chronic Pain Signatures_ (A2CPS) project. This repository contains source code, build support, documentation, and issue tracking for the API.

Documentation

Detailed usage documentation for the API is available via Read the Docs. Programatically-generated API docs are also available served by the API itself. There are both live docs and detailed static docs. An OpenAPI description of the API is also provided.

Get in touch

Get in touch with the authors and maintainers of VBR API by filing or interacting with Github issues.

Contributing

Contributions to the documentation are welcome. Please issue pull requests to the docs branch of this repository.

License

BSD_ © 2021- Texas Advanced Computing Center

.. _BSD: LICENSE

.. _NIH Acute to Chronic Pain Signatures: https://a2cps.org/ .. _REST-like web service: https://vbr-api.a2cps.cloud/ .. _Read the Docs: https://vbr-api.readthedocs.io/en/latest/ .. _live docs: https://vbr-api.a2cps.cloud/docs .. _detailed static docs: https://vbr-api.a2cps.cloud/redoc .. _OpenAPI description: https://vbr-api.a2cps.cloud/openapi.json

.. |docs| image:: https://readthedocs.org/projects/docs/badge/?version=latest :alt: Documentation Status :scale: 100% :target: https://vbr-api.readthedocs.io/en/latest/

.. |openapi| image:: https://img.shields.io/swagger/valid/3.0?label=openapi%203.0&specUrl=https%3A%2F%2Fvbr-api.a2cps.cloud%2Fopenapi.json :alt: OpenAPI Validation Status :target: https://vbr-api.a2cps.cloud/openapi.json

.. |status| image:: https://img.shields.io/website?label=status&url=https%3A%2F%2Fvbr-api.a2cps.cloud%2Fdocs :alt: API Server Status :target: https://vbr-api.a2cps.cloud/docs