Manifest Service

Overview

This service handles reading from and writing to a user's s3 folder containing their manifests. A manifest is a JSON file that lists records a researcher may be interested in analyzing. This service stores a manifest to a user folder in an s3 bucket and delivers it for later use, such as when the researcher wants to mount the manifest in their workspace. If the "prefix" config variable is set, user folders will be stored in a directory of that name within the s3 bucket.

Manifest files should contain JSON of the form

[
  {
    "object_id": "757508f5-2697-4700-a69f-89d173a4c514",
    "subject_id": "da6a14a0-6498-4941-a1b2-bbe45a2ccac2"
  },
  {
    "object_id": "835db5c6-5cc8-4d70-a3b2-9a18ad4912cd",
    "subject_id": "da6a14a0-6498-4941-a1b2-bbe45a2ccac2"
  },
  ...
]

Endpoints

For all endpoints, the request must contain an Authorization header with an access_token. The user needs read access and read-storage access on at least one project in order to use this service.

Lists a user's manifests:

GET /
Returns: { "manifests" : [ { "filename" : "manifest-2019-02-27T11-44-20.548126.json", "last_modified" : "2019-02-27 17:44:21" }, ... ] }

Create a manifest file in the user's folder:

POST /
Post body: The contents of the manifest.json file to be created.
Returns: { "filename" : "manifest-2019-03-09T21-47-04.041499.json" }

Read the contents of a manifest file in the user's folder:

GET /file/<filename.json>
Returns: { "body" : "the-body-of-the-manifest-file-as-a-string" }

Lists a user's cohorts:

GET /cohorts
Returns: { "cohorts" : [ { "filename" : "5183a350-9d56-4084-8a03-6471cafeb7fe", "last_modified" : "2019-02-27 17:44:21" }, ... ] }

Create a cohort GUID in the user's folder:

POST /cohorts
Post body: { "guid": "5183a350-9d56-4084-8a03-6471cafeb7fe" }
Returns: { "filename" : "5183a350-9d56-4084-8a03-6471cafeb7fe" }

Lists a user's exported metadata objects:

GET /metadata
Returns: { "metadata" : [ { "filename" : "metadata-2024-06-13T17-14-46.026593.json", "last_modified" : "2024-06-13 17:14:47" }, ... ] }

Create an exported metadata object in the user's folder:

POST /metadata
Post body: { "some_metadata_key": "some_metadata_value" }
Returns: { "filename" : "metadata-2024-06-13T17-14-46.026593.json" }

Read the contents of an exported metadata object file in the user's folder:

GET /metadata/<filename.json>
Returns: { "body" : "the-body-of-the-exported-metadata-object-file-as-a-string" }

On failure, the above endpoints all return JSON in the form

{ "error" : "error-message" }

OpenAPI spec

The OpenAPI/Swagger 2.0 specification of a service is stored in its swagger.yaml and can be visualized here.

Running the service locally

If you want to run this service locally, fill out the config.json file with the correct values and then run:

poetry shell
poetry install
python3 run.py

And then GET and POST to http://localhost:5000/

You'll need AWS credentials in your environment to run this locally.

Quickstart with Helm

You can now deploy individual services via Helm! Please refer to the Helm quickstart guide HERE (https://github.com/uc-cdis/manifestservice/blob/master/docs/quickstart_helm.md)