diff --git a/README.md b/README.md index 6022b93..7d445ac 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # transcriptomics_data_service -WORK IN PROGRESS. +**Disclaimer: work in progress.** The Transcriptomics Data Service (TDS) is intended to ingest, organize and query data from transcriptomics experiments through an API. @@ -27,6 +27,9 @@ For local development, you can use the [docker-compose.dev.yaml](./docker-compos The server starts in reload mode to quickly reflect local changes, and debugpy is listening on the container's internal port `9511`. ```bash +# Set UID for directory permissions in the container +export UID=$(id -u) + # start docker compose -f ./docker-compose.dev.yaml up --build -d @@ -46,6 +49,12 @@ See the [authorization docs](./docs/authz.md) for more information on how to cre ## Endpoints -* /service-info +TODO: replace this with Swagger UI docs generated from CI workflows. + +* `/service-info` * GA4GH service info -* /ingest (TODO) +* `/ingest` +* `/normalize` +* `/expressions` +* `/experiment` +* `/search` (WIP)