Skip to content

Commit

Permalink
Merge pull request #13 from samply/feature/empty-request
Browse files Browse the repository at this point in the history
Readme empty request
  • Loading branch information
enola-dkfz authored Apr 5, 2024
2 parents 66c43db + bdb19b2 commit 5899b5d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Prism

Prism is a Samply component ran centrally, which queries sites for criteria and number of results for these criteria in their Samply.Blaze stores. Prism is to be used by Samply.Lens for showing expected number of results next to criteria in the search tree.
Prism is a Samply component ran centrally, which queries sites for criteria and number of results for these criteria in their Samply.Blaze stores. Prism is to be used by Samply.Spot or Samply.Lens for showing expected number of results next to criteria in the search tree.

## Installation

Expand All @@ -27,7 +27,7 @@ The following environment variables are mandatory for the usage of Prism.
--sites <SITES>
Sites to initially query, separated by ';' [env: SITES=]
--cors-origin <CORS_ORIGIN>
Credentials to use on the Beam Proxy [env: CORS_ORIGIN=]
Where to allow cross-origin resourse sharing from [env: CORS_ORIGIN=]
--project <PROJECT>
Project name [env: PROJECT=]
```
Expand All @@ -52,6 +52,12 @@ Creating a sample prism query asking for criteria:
curl -v -X POST -H "Content-Type: application/json" --data '{"sites": ["proxy1"]}' http://localhost:8066/criteria
```

If the list of the sites is empty, Prism returns the expected number of results in all the sites in its configuration.

```bash
curl -v -X POST -H "Content-Type: application/json" --data '{"sites": []}' http://localhost:8066/criteria
```


## Roadmap

Expand Down
2 changes: 1 addition & 1 deletion src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ struct CliArgs {
#[clap(long, env, value_parser)]
sites: String,

/// Credentials to use on the Beam Proxy
/// Where to allow cross-origin resourse sharing from
#[clap(long, env, value_parser = parse_cors)]
pub cors_origin: AllowOrigin,

Expand Down

0 comments on commit 5899b5d

Please sign in to comment.