From affeb315feaaccf89cd6c07dc0b3efa65988fa9b Mon Sep 17 00:00:00 2001 From: 8naama Date: Sun, 18 Aug 2024 15:00:33 +0300 Subject: [PATCH] clarify `days_back_fetch` in 1password explanation --- README.md | 22 +++++++++++----------- src/apis/onepassword/README.md | 22 +++++++++++----------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 1e82006..0900039 100644 --- a/README.md +++ b/README.md @@ -217,17 +217,17 @@ By default `cloudflare` API type: By default `1password` API type has built in pagination settings and sets the `response_data_path` to `items` field. ## Configuration Options -| Parameter Name | Description | Required/Optional | Default | -|--------------------------|-------------------------------------------------------------------------------------------------|-------------------|-------------------| -| name | Name of the API (custom name) | Optional | the defined `url` | -| onepassword_bearer_token | The 1Password Bearer token | Required | - | -| url | The request URL | Required | - | -| method | The request method (`GET` or `POST`) | Optional | `GET` | -| additional_fields | Additional custom fields to add to the logs before sending to logzio | Optional | - | -| days_back_fetch | The amount of days to fetch back in the first request. Applies a filter on `since` parameter. | Optional | - | -| scrape_interval | Time interval to wait between runs (unit: `minutes`) | Optional | 1 (minute) | -| onepassword_limit | 1Password limit for number of events to return in a single request (allowed range: 100 to 1000) | Optional | 100 | -| pagination_off | True if builtin pagination should be off, False otherwise | Optional | `False` | +| Parameter Name | Description | Required/Optional | Default | +|--------------------------|--------------------------------------------------------------------------------------------------------------|-------------------|-------------------| +| name | Name of the API (custom name) | Optional | the defined `url` | +| onepassword_bearer_token | The 1Password Bearer token | Required | - | +| url | The request URL | Required | - | +| method | The request method (`GET` or `POST`) | Optional | `GET` | +| additional_fields | Additional custom fields to add to the logs before sending to logzio | Optional | - | +| days_back_fetch | The amount of days to fetch back in the first request. Applies a filter on 1password `start_time` parameter. | Optional | - | +| scrape_interval | Time interval to wait between runs (unit: `minutes`) | Optional | 1 (minute) | +| onepassword_limit | 1Password limit for number of events to return in a single request (allowed range: 100 to 1000) | Optional | 100 | +| pagination_off | True if builtin pagination should be off, False otherwise | Optional | `False` | diff --git a/src/apis/onepassword/README.md b/src/apis/onepassword/README.md index 5242ab4..fef0e55 100644 --- a/src/apis/onepassword/README.md +++ b/src/apis/onepassword/README.md @@ -2,17 +2,17 @@ By default `1password` API type has built in pagination settings and sets the `response_data_path` to `items` field. ## Configuration -| Parameter Name | Description | Required/Optional | Default | -|--------------------------|-------------------------------------------------------------------------------------------------|-------------------|-------------------| -| name | Name of the API (custom name) | Optional | the defined `url` | -| onepassword_bearer_token | The 1Password Bearer token | Required | - | -| url | The request URL | Required | - | -| method | The request method (`GET` or `POST`) | Optional | `GET` | -| additional_fields | Additional custom fields to add to the logs before sending to logzio | Optional | - | -| days_back_fetch | The amount of days to fetch back in the first request. Applies a filter on `since` parameter. | Optional | - | -| scrape_interval | Time interval to wait between runs (unit: `minutes`) | Optional | 1 (minute) | -| onepassword_limit | 1Password limit for number of events to return in a single request (allowed range: 100 to 1000) | Optional | 100 | -| pagination_off | True if builtin pagination should be off, False otherwise | Optional | `False` | +| Parameter Name | Description | Required/Optional | Default | +|--------------------------|--------------------------------------------------------------------------------------------------------------|-------------------|-------------------| +| name | Name of the API (custom name) | Optional | the defined `url` | +| onepassword_bearer_token | The 1Password Bearer token | Required | - | +| url | The request URL | Required | - | +| method | The request method (`GET` or `POST`) | Optional | `GET` | +| additional_fields | Additional custom fields to add to the logs before sending to logzio | Optional | - | +| days_back_fetch | The amount of days to fetch back in the first request. Applies a filter on 1password `start_time` parameter. | Optional | - | +| scrape_interval | Time interval to wait between runs (unit: `minutes`) | Optional | 1 (minute) | +| onepassword_limit | 1Password limit for number of events to return in a single request (allowed range: 100 to 1000) | Optional | 100 | +| pagination_off | True if builtin pagination should be off, False otherwise | Optional | `False` | ## Example