Skip to content

Commit 033cc95

Browse files
claudespicelukekim
authored andcommitted
fix: Remove non-functional rate control params from GitHub connector docs
The GitHub connector does not consume requests_per_second_limit, requests_per_minute_limit, rate_control_jitter_min, or rate_control_jitter_max — they are not in the connector's ParameterSpec array. The GitHub connector uses its own rate limiter based on GitHub API X-RateLimit-* response headers, not the generic HTTP rate control mechanism. Users setting these params have them silently ignored. Keep max_concurrent_requests which IS wired into the connector.
1 parent f4c9cbd commit 033cc95

1 file changed

Lines changed: 2 additions & 6 deletions

File tree

  • website/docs/components/data-connectors/github

website/docs/components/data-connectors/github/index.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,17 +108,13 @@ datasets:
108108
# ... other configuration ...
109109
```
110110

111-
The GitHub connector also supports the shared HTTP rate control parameters for per-dataset concurrency and request rate limits:
111+
The GitHub connector supports the following HTTP concurrency parameter:
112112

113113
| Parameter Name | Description |
114114
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
115115
| `max_concurrent_requests` | Maximum number of concurrent HTTP requests to the same upstream origin. Overrides `runtime.params.http_max_concurrent_requests`. If both are unset, concurrency limiting is disabled. |
116-
| `requests_per_second_limit` | Maximum number of HTTP requests per second to the same upstream origin. Overrides `runtime.params.http_requests_per_second_limit`. If both are unset, no per-second rate limit is applied. |
117-
| `requests_per_minute_limit` | Maximum number of HTTP requests per minute to the same upstream origin. Overrides `runtime.params.http_requests_per_minute_limit`. If both are unset, no per-minute rate limit is applied. |
118-
| `rate_control_jitter_min` | Minimum random delay added before HTTP requests when rate control is active. Defaults to `5ms` when a request-rate limit is configured. |
119-
| `rate_control_jitter_max` | Maximum random delay added before HTTP requests when rate control is active. Defaults to `10ms` when a request-rate limit is configured. |
120116

121-
Multiple datasets targeting the same GitHub endpoint share the same rate controller.
117+
The GitHub connector uses its own rate limiter based on GitHub API `X-RateLimit-*` response headers. Multiple datasets targeting the same GitHub endpoint share this rate limiter.
122118

123119
## Filter Push Down
124120

0 commit comments

Comments
 (0)