From a6250c28a1e592f2a5dfe55bbc964ca7be32d0fa Mon Sep 17 00:00:00 2001 From: Seiji Chew <67301797+schew2381@users.noreply.github.com> Date: Wed, 31 Jul 2024 15:20:26 -0700 Subject: [PATCH] docs: Add units to rate limit description (#471) --- docs/data-sources/all_keys.md | 2 +- docs/data-sources/key.md | 2 +- docs/resources/key.md | 2 +- internal/provider/data_source_all_client_keys.go | 2 +- internal/provider/data_source_client_key.go | 2 +- internal/provider/resource_client_key.go | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/data-sources/all_keys.md b/docs/data-sources/all_keys.md index 283152ae..428b3774 100644 --- a/docs/data-sources/all_keys.md +++ b/docs/data-sources/all_keys.md @@ -51,5 +51,5 @@ Read-Only: - `project_id` (String) The ID of the project that the key belongs to. - `public` (String) The public key. - `rate_limit_count` (Number) Number of events that can be reported within the rate limit window. -- `rate_limit_window` (Number) Length of time that will be considered when checking the rate limit. +- `rate_limit_window` (Number) Length of time in seconds that will be considered when checking the rate limit. - `secret` (String) The secret key. diff --git a/docs/data-sources/key.md b/docs/data-sources/key.md index e3928f8b..429b60c0 100644 --- a/docs/data-sources/key.md +++ b/docs/data-sources/key.md @@ -60,5 +60,5 @@ data "sentry_key" "first" { - `project_id` (String) The ID of the project that the key belongs to. - `public` (String) The public key. - `rate_limit_count` (Number) Number of events that can be reported within the rate limit window. -- `rate_limit_window` (Number) Length of time that will be considered when checking the rate limit. +- `rate_limit_window` (Number) Length of time in seconds that will be considered when checking the rate limit. - `secret` (String) The secret key. diff --git a/docs/resources/key.md b/docs/resources/key.md index c4acf45e..f87496c7 100644 --- a/docs/resources/key.md +++ b/docs/resources/key.md @@ -34,7 +34,7 @@ resource "sentry_key" "default" { ### Optional - `rate_limit_count` (Number) Number of events that can be reported within the rate limit window. -- `rate_limit_window` (Number) Length of time that will be considered when checking the rate limit. +- `rate_limit_window` (Number) Length of time in seconds that will be considered when checking the rate limit. ### Read-Only diff --git a/internal/provider/data_source_all_client_keys.go b/internal/provider/data_source_all_client_keys.go index ebea49dc..769056bc 100644 --- a/internal/provider/data_source_all_client_keys.go +++ b/internal/provider/data_source_all_client_keys.go @@ -109,7 +109,7 @@ func (d *AllClientKeysDataSource) Schema(ctx context.Context, req datasource.Sch Computed: true, }, "rate_limit_window": schema.Int64Attribute{ - MarkdownDescription: "Length of time that will be considered when checking the rate limit.", + MarkdownDescription: "Length of time in seconds that will be considered when checking the rate limit.", Computed: true, }, "rate_limit_count": schema.Int64Attribute{ diff --git a/internal/provider/data_source_client_key.go b/internal/provider/data_source_client_key.go index 9873e6e8..b165ad90 100644 --- a/internal/provider/data_source_client_key.go +++ b/internal/provider/data_source_client_key.go @@ -109,7 +109,7 @@ func (d *ClientKeyDataSource) Schema(ctx context.Context, req datasource.SchemaR Computed: true, }, "rate_limit_window": schema.Int64Attribute{ - MarkdownDescription: "Length of time that will be considered when checking the rate limit.", + MarkdownDescription: "Length of time in seconds that will be considered when checking the rate limit.", Computed: true, }, "rate_limit_count": schema.Int64Attribute{ diff --git a/internal/provider/resource_client_key.go b/internal/provider/resource_client_key.go index d0bb2f86..a61a69ba 100644 --- a/internal/provider/resource_client_key.go +++ b/internal/provider/resource_client_key.go @@ -105,7 +105,7 @@ func (r *ClientKeyResource) Schema(ctx context.Context, req resource.SchemaReque Required: true, }, "rate_limit_window": schema.Int64Attribute{ - MarkdownDescription: "Length of time that will be considered when checking the rate limit.", + MarkdownDescription: "Length of time in seconds that will be considered when checking the rate limit.", Optional: true, }, "rate_limit_count": schema.Int64Attribute{