Skip to content

Commit

Permalink
Merge pull request #12 from bento-platform/chore/docs
Browse files Browse the repository at this point in the history
chore: update docs
  • Loading branch information
v-rocheleau authored Nov 18, 2024
2 parents 2ee4f5f + 937aae2 commit 0e62475
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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

Expand All @@ -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)

0 comments on commit 0e62475

Please sign in to comment.