Skip to content

Commit

Permalink
Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
Siegrift committed Jan 18, 2024
1 parent 0e93ebf commit 4bed6bd
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

A monorepo for managing signed data. Consists of:

- [signed-api](./packages/signed-api/README.md) - A service for storing and accessing signed data. It provides endpoints to
handle signed data for a specific airnode.
- [signed-api](./packages/signed-api/README.md) - A service for storing and accessing signed data. It provides endpoints
to handle signed data for a specific airnode.
- [airnode-feed](./packages/airnode-feed/README.md) - A service for pushing data provider signed data.
- [e2e](./packages/e2e/README.md) - End to end test utilizing Mock API, Airnode feed and signed API.
- [performance-test](./packages/performance-test/README.md) - Configurations and scripts to allow running performance
Expand Down
6 changes: 3 additions & 3 deletions packages/signed-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,12 +257,12 @@ The version specified in the config must match the version of the Signed API at

The API provides the following endpoints:

- `POST /`: Insert a batch of signed data.
- `POST /{airnode}`: Insert a batch of signed data.
- The batch is validated for consistency and data integrity errors. If there is any issue during this step, the whole
batch is rejected. Otherwise the batch is accepted. Also, all data that is no longer needed is removed during this
step.
- `GET /{endpoint-name}/{airnode}`: Retrieve signed data for the Airnode respecting the endpoint configuration.
- Only returns the freshest signed data available for the given Airnode, respecting the configured endpoint delay.
- Returns the freshest signed data available for the given Airnode, respecting the configured endpoint delay.
- `GET /`: Retrieve list of all available Airnode address.
- Returns all Airnode addresses for which there is signed data. It is possible that this data cannot be shown by the
delayed endpoints (in case the data is too fresh and there is not an older alternative).
Expand Down Expand Up @@ -309,7 +309,7 @@ Here are some examples of how to use the API with `curl`. Note, the port may dif

```sh
# Upsert batch of signed data (HTTP POST)
curl --location 'http://localhost:8090' \
curl --location 'http://localhost:8090/0xc52EeA00154B4fF1EbbF8Ba39FDe37F1AC3B9Fd4' \
--header 'Content-Type: application/json' \
--data '[{
"beaconId": "0x1896e5d90edcd73e8abc3f5685cb8def4dfc1c7fef8032c4d02095a8ac5d1dba",
Expand Down

0 comments on commit 4bed6bd

Please sign in to comment.