Skip to content

Commit

Permalink
update services and endpoints, fixes #147
Browse files Browse the repository at this point in the history
  • Loading branch information
helrond committed Apr 24, 2020
1 parent 2d2b4b4 commit f56779b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You will need to edit configuration values in `gemini/config.py` to point to you

## Services

gemini has three services, all of which are exposed via HTTP endpoints (see [Routes](#routes) section below):
gemini has four services, all of which are exposed via HTTP endpoints (see [Routes](#routes) section below):

* Download Packages
* Polling the Archivematica Storage Service for packages.
Expand All @@ -45,11 +45,9 @@ gemini has three services, all of which are exposed via HTTP endpoints (see [Rou
* Storing the package in Fedora, along with minimal metadata.
* Creating a package object in gemini's database.
* Delivering a POST request to a configurable URL. This request has a payload containing the URI of the stored package in Fedora, the package type ("aip" or "dip") and the value of the `Internal-Sender-Identifier` field from the package's `bag-info.txt` file.
* Deliver Data - sends package data to another service.
* Request Cleanup - send a request to another service to clean up after a package has been processed.

![File storage diagram](gemini-services.png)


### Routes

| Method | URL | Parameters | Response | Behavior |
Expand All @@ -58,6 +56,7 @@ gemini has three services, all of which are exposed via HTTP endpoints (see [Rou
|GET|/packages/{id}| |200|Returns data about an individual package|
|POST|/download||200|Runs the download routine|
|POST|/store||200|Runs the store routine|
|POST|/deliver||200|Delivers package data to configured URL|
|POST|/request-cleanup||200|Notifies another service that processing is complete|
|GET|/status||200|Return the status of the microservice|
|GET|/schema.json||200|Returns the OpenAPI schema for this application|
Expand Down
Binary file removed gemini-services.png
Binary file not shown.

0 comments on commit f56779b

Please sign in to comment.