Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added descriptions to all parameters in readme.
  • Loading branch information
flynnc3 authored Nov 7, 2022
1 parent 6445c46 commit 8c298bd
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,40 +12,40 @@ The data engine endpoint lives at [**http://defi-de.idea.rpi.edu:8080/defi/v1/re

| ?param | desc |
|--------|------|
| source | |
| source | Source id of the desired datatype to check for existance. (i.e. amber_data) |

### /stream_exists

| ?param | desc |
|--------|------|
| key | |
| key | Key of the desired stream to check for existance. |

### /initialize

| ?param | desc |
|-----------|------|
| source | |
| auth_data | |
| source | Source id of the desired datatype to check for existance. (i.e. amber_data) |
| auth_data | Authorization data required to initialize the source. (i.e. key,<api_key>) |

### /is_authorized

| ?param | desc |
|--------|------|
| key | |
| key | Key of the desired stream to check for authorization. |

### /is_active

| ?param | desc |
|--------|------|
| key | |
| key | Key of the desired stream to check for activity. |

### /request_dated

| ?param | desc |
|-------------|------|
| destination | |
| key | |
| request | |
| query | |
| start_date | |
| end_date | |
| destination | Socket key used for returning data to. |
| key | Key of the desired stream for processing the request. |
| request | Request type and parameters used for processing. (i.e. request,aave-protocol-dated) |
| query | Query parameters used for accessing the database. Note it must be formatted exactly as stated. (i.e.) |
| start_date | Start date of the request for data. In the format yyyy-MM-dd. (i.e. 2022-01-01) |
| end_date | End date of the request for data (non-inclusive). In the format yyyy-MM-dd. (i.e 2022-01-02) |

0 comments on commit 8c298bd

Please sign in to comment.