diff --git a/README.md b/README.md index 7ab8e30a..ce0de23a 100644 --- a/README.md +++ b/README.md @@ -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,) | ### /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) |