Reconcile configuration/docs semantics and Go version guidance with current implementation#6998
Merged
Merged
Conversation
Copilot
AI
changed the title
[WIP] Fix documentation for sample_rate JSON availability
Reconcile configuration/docs semantics and Go version guidance with current implementation
Jun 4, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reconciles documentation and contributor guidance with the gateway’s current configuration semantics, and adjusts the make install Go version warning to align with “Go 1.25.x or later” expectations without spurious patch-level mismatches.
Changes:
- Updates configuration docs to accurately reflect JSON stdin vs TOML support (e.g.,
sample_rate/sampleRate, TOML-only rate limit fields, snake_casetool_response_filters). - Aligns contributor/agent documentation with current build/test behavior (
make buildrunsgo mod tidy;make agent-finishedscope clarified). - Refines
make installGo version warning logic to compare major.minor baselines rather than exact version strings.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds customSchemas to the quick config field table for JSON stdin completeness. |
| Makefile | Updates Go version warning logic to major.minor baseline comparisons. |
| docs/CONFIGURATION.md | Corrects/clarifies config key support and adds worked guard assignment examples. |
| CONTRIBUTING.md | Updates Go version guidance and documents make build / go mod tidy behavior. |
| AGENTS.md | Clarifies what make agent-finished runs vs what is covered by integration tests. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 5/5 changed files
- Comments generated: 2
Comment on lines
290
to
297
| INSTALLED_MAJOR=$$(echo "$$INSTALLED_VERSION" | cut -d. -f1); \ | ||
| INSTALLED_MINOR=$$(echo "$$INSTALLED_VERSION" | cut -d. -f2); \ | ||
| REQUIRED_MAJOR=$$(echo "$(GO_VERSION)" | cut -d. -f1); \ | ||
| REQUIRED_MINOR=$$(echo "$(GO_VERSION)" | cut -d. -f2); \ | ||
| if [ "$$INSTALLED_MAJOR" -lt "$$REQUIRED_MAJOR" ] || { [ "$$INSTALLED_MAJOR" -eq "$$REQUIRED_MAJOR" ] && [ "$$INSTALLED_MINOR" -lt "$$REQUIRED_MINOR" ]; }; then \ | ||
| echo "⚠ Warning: Expected Go $(GO_VERSION) or later, but found $$INSTALLED_VERSION"; \ | ||
| echo " Visit https://go.dev/dl/ to install Go $(GO_VERSION) or later"; \ | ||
| fi; \ |
| | `payload_dir` / `payloadDir` | Directory for large payload storage (must be absolute path) | | ||
| | `payload_size_threshold` / `payloadSizeThreshold` | Size threshold in bytes for payload storage (default: `524288`) | | ||
| | `trusted_bots` / `trustedBots` | Additional bot usernames to treat as trusted with "approved" integrity. Additive to the built-in trusted bot list. Non-empty array when present. Example: `["my-bot[bot]"]` | | ||
| | `customSchemas` (JSON stdin top-level) | Map custom server `type` names to HTTPS JSON schema URLs for custom server validation | |
Collaborator
|
@copilot address review feedback |
Contributor
Author
Addressed in 6892bd5.
|
This was referenced Jun 4, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Nightly docs reconciliation flagged mismatches between documented config behavior and actual implementation, plus contributor guidance drift around Go version checks and
make buildbehavior in restricted environments. This PR aligns docs and install-time version messaging with current code paths.Configuration reference corrections
sample_ratedocs now reflect actual support matrix:sample_rate(TOML) andsampleRate(JSON stdin), plus CLI--otlp-sample-rate.rate_limit_threshold/rate_limit_cooldownare now documented as TOML config only (removed misleading “JSON file configs” wording).tool_response_filtersintentionally uses snake_case JSON key (tool_response_filters) with no camelCase alias.guardsdefinition paired with per-serverguardassignment.Contributor/build guidance alignment
make buildrunsgo mod tidyfirst (relevant for network-restricted environments).Install-time Go version check behavior
make installwarning logic now compares required vs installed major.minor baseline (warn only when older), avoiding false warnings on valid patch releases (e.g.,1.25.10).Agent/docs clarity updates
AGENTS.mdwording formake agent-finished: it runsgo test ./...+ Rust guard tests; binary integration tests remain a separatemake test-integrationstep.customSchemasto the README gateway/config summary table for JSON stdin completeness.