Skip to content

Commit 37724c7

Browse files
committed
More pointers to the REST API
1 parent 13f16a8 commit 37724c7

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README-PUBSUB.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# The Publisher-Subscriber Model in Caterva2
2-
**Note**: this functionality is in alpha stage. If you are interested in testing it, please contact the Caterva2 team.
2+
**Note**: this functionality is in alpha stage; if you are interested in testing it, please contact the ironArray team.
33

44
Caterva2 offers the possibility of using the publisher-subscriber (pub-sub) message pattern. Under this framework, when a user uses a client (Web API, Python API or command line) to query datasets, the client will connect to a Caterva2 **subscriber** service, which in turn will communicate with the associated **publishers** to which it is subscribed, to retrieve the requested datasets. This subscriber/publisher interaction is mediated by a **broker** service.
55

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## What is it?
44

5-
Caterva2 is a service meant for serving [Blosc2][] and [HDF5][] datasets among authenticated users, work groups, or the general public. There are several interfaces to Caterva2, including a Web GUI, a REST API, a Python API, and a command-line client.
5+
Caterva2 is a service meant for serving [Blosc2][] and [HDF5][] datasets among authenticated users, work groups, or the public. There are several interfaces to Caterva2, including a Web GUI, a REST API, a Python API, and a command-line client.
66

77
<img src="./doc/_static/caterva2-block-diagram.png" alt="Figure: Caterva2 block diagram" width="100%"/>
88

@@ -64,7 +64,7 @@ You may install Caterva2 in several ways:
6464
python -m pip install -e .
6565
```
6666

67-
When a user uses a client (Web API, Python API or command line) to query datasets, the client will connect to a Caterva2 **subscriber** service, which
67+
When a user uses a client (web GUI, REST API, Python API, or command line) to query datasets, the client will connect to a Caterva2 **subscriber** service, which
6868
accesses the relevant datasets stored either locally or remotely. The subscriber services may be managed via the command line by installing the `caterva2` package with the `[subscriber]` extra feature (we also wish to use the command line client, so we will also install the `clients` extra too):
6969

7070
```sh

0 commit comments

Comments
 (0)