Replace deprecated api_key with agent_id in example config#8342
Merged
Conversation
Update config.example-payload-threshold.toml to use agent_id instead of the deprecated api_key field, matching the pattern in config.example.toml. Fixes #8305 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the config.example-payload-threshold.toml example configuration to avoid runtime deprecation warnings by replacing the deprecated gateway.api_key field with the current gateway.agent_id field (Fixes #8305).
Changes:
- Replace
api_key = "your-api-key-here"withagent_id = ""in the payload-threshold example config.
Show a summary per file
| File | Description |
|---|---|
| config.example-payload-threshold.toml | Updates the gateway example config to use agent_id instead of deprecated api_key, preventing deprecation warnings for users copying the example. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Low
This was referenced Jun 30, 2026
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.
Summary
Replace the deprecated
api_keyfield withagent_idinconfig.example-payload-threshold.toml.Problem
config.example-payload-threshold.tomluses the deprecatedapi_keyfield (api_key = "your-api-key-here") on line 12. Users who copy this example as a starting point see deprecation warnings at runtime.Fix
Replace
api_key = "your-api-key-here"withagent_id = "", matching the pattern used inconfig.example.toml.Fixes #8305