TT-12306, addressed changes suggested in the tyk-docs PR

andrei-tyk commented 1 month ago

User description

Description

Related Issue

Motivation and Context

How This Has Been Tested

Screenshots (if appropriate)

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[ ] Refactoring or add test (improvements in base code or adds test coverage to functionality)

Checklist

[ ] I ensured that the documentation is up to date
[ ] I explained why this PR updates go.mod in detail with reasoning why it's required
[ ] I would like a code coverage CI quality gate exception and have explained why

PR Type

enhancement, bug fix

Description

Added // nolint comments to alias declarations in apidef/oas/event.go and apidef/oas/time.go to prevent linting issues.
Corrected typos in comments within config/rate_limit.go to improve clarity and accuracy.

Changes walkthrough 📝

Relevant files

Enhancement

event.go `Add nolint comments to alias declarations in event.go` apidef/oas/event.go - Added `// nolint` comments to alias declarations.	+2/-0
time.go `Add nolint comment to alias declaration in time.go` apidef/oas/time.go - Added `// nolint` comment to alias declaration.	+1/-0

Bug fix

rate_limit.go

Fix typos in rate limiter configuration comments

config/rate_limit.go - Corrected typos in comments for rate limiter configurations.

+2/-2

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

github-actions[bot] commented 1 month ago

API Changes

--- prev.txt    2024-07-01 10:26:19.412996267 +0000
+++ current.txt 2024-07-01 10:26:16.217016286 +0000
@@ -5937,7 +5937,7 @@
    // EnableFixedWindow enables fixed window rate limiting.
    EnableFixedWindowRateLimiter bool `json:"enable_fixed_window_rate_limiter"`

-   // Redis based rate limiter with sliding log. Provides 100% rate limiting accuracy, but require two additional Redis roundtrip for each request.
+   // Redis based rate limiter with sliding log. Provides 100% rate limiting accuracy, but require two additional Redis roundtrips for each request.
    EnableRedisRollingLimiter bool `json:"enable_redis_rolling_limiter"`

    // To enable, set to `true`. The sentinel-based rate limiter delivers a smoother performance curve as rate-limit calculations happen off-thread, but a stricter time-out based cool-down for clients. For example, when a throttling action is triggered, they are required to cool-down for the period of the rate limit.
@@ -5946,7 +5946,7 @@
    // The standard rate limiter offers similar performance as the sentinel-based limiter. This is disabled by default.
    EnableSentinelRateLimiter bool `json:"enable_sentinel_rate_limiter"`

-   // EnableRateLimitSmoothing enables or disables rate smoothing. The rate smoothing is only supported on the
+   // EnableRateLimitSmoothing enables or disables rate limit smoothing. The rate smoothing is only supported on the
    // Redis Rate Limiter, or the Sentinel Rate Limiter, as both algorithms implement a sliding log.
    EnableRateLimitSmoothing bool `json:"enable_rate_limit_smoothing"`

github-actions[bot] commented 1 month ago

PR Reviewer Guide 🔍

⏱️ Estimated effort to review [1-5]	2
🧪 Relevant tests	No
🔒 Security concerns	No
⚡ Key issues to review	Comment Consistency: The comments added with `// nolint` in `event.go` and `time.go` should have an explanation as to why linting is being ignored. This helps maintain code quality and understandability.
⚡ Key issues to review	Typographical Error: In `rate_limit.go`, the comment correction from "rate smoothing" to "rate limit smoothing" might be unnecessary unless it aligns with internal documentation or naming conventions. It's important to ensure consistency in terminology across the project.