chore: updated docs for extra params passthrough

[sammaji]

Summary

Clarifies how passthrough_extra_params works across different entrypoints, and fixes an incorrect Go SDK usage example that was using the wrong context API.

Changes

• Added an explanation distinguishing how extra parameters are collected on standard inference routes (/v1/chat/completions, /v1/responses, /v1/embeddings, /v1/images/generations) versus OpenAI integration routes (/openai), where unknown top-level fields are not collected and extra_params must be used explicitly.
• Added a new cURL example tab for the OpenAI integration route showing correct extra_params usage.
• Fixed the Go SDK example to use schemas.NewBifrostContext and ctx.SetValue instead of the incorrect context.WithValue pattern.
• Removed trailing newline inconsistency at end of file.

Type of change

• Bug fix
• Feature
• Refactor
• Documentation
• Chore/CI

Affected areas

• Core (Go)
• Transports (HTTP)
• Providers/Integrations
• Plugins
• UI (React)
• Docs

How to test

Review the updated docs/providers/request-options.mdx page and verify:

• The new explanation paragraph accurately reflects routing behavior.
• The OpenAI integration cURL example renders correctly in the tabbed view.
• The Go SDK example compiles correctly against the current SDK API.

Breaking changes

• Yes
• No

Related issues

Security considerations

None.

Checklist

• I read docs/contributing/README.md and followed the guidelines
• I added/updated tests where appropriate
• I updated documentation where needed
• I verified builds succeed (Go and UI)
• I verified the CI pipeline passes locally if applicable

Summary by CodeRabbit

• Documentation
  • Updated request options documentation to clarify how extra parameters are handled differently for standard inference routes versus OpenAI integration routes.
  • Enhanced Gateway and Go SDK examples to better illustrate the correct structure for passing extra parameters based on request type.

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation for Passthrough Extra Parameters is enhanced to clarify collection behavior based on request entrypoint: standard inference routes accept top-level JSON fields, while OpenAI integration routes require fields under extra_params. Gateway and Go SDK examples are updated to demonstrate current API patterns.

Changes

Passthrough Extra Parameters Documentation

Layer / File(s)	Summary
Passthrough Extra Parameters clarification and examples docs/providers/request-options.mdx	Passthrough section now explains entrypoint-specific parameter collection (standard routes vs. /openai routes), adds an "OpenAI Integration" Gateway example showing extra_params nesting, and updates Go SDK example to use schemas.NewBifrostContext(...) with ctx.SetValue(...) for passthrough configuration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

• akshaydeo
• danpiths

Poem

🐰 A doc hops through the params clear,
Explaining where each field goes here—
Extra fields in top-level arrays roam,
But OpenAI finds a nested home.
Go SDK now sets its flags with grace,
Bifrost context in its proper place! 📚

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'chore: updated docs for extra params passthrough' is relevant to the changeset but is generic and lacks specificity about the core improvement (clarifying passthrough behavior across entrypoints and fixing the Go SDK example).
Description check	✅ Passed	The description comprehensively covers the Summary, Changes, Type of change, Affected areas, and Testing approach with clear details about routing behavior, new examples, and SDK fixes. It addresses the template's core requirements despite some checklist items being unchecked.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch 05-29-chore_updated_docs_for_extra_params_passthrough

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sammaji]

• fix: preserve chat max_tokens during param filtering #3992
• chore: update provider management docs #3953
• chore: updated docs for extra params passthrough #3897 👈 (View in Graphite)
• chore: updated docs for otel plugin #2712
• feat: adds tests for multiple otel collectors support #3895
• fix: updates config and helm schema #3944
• feat: adds support for multiple otel collectors #3894
• dev

This stack of pull requests is managed by Graphite. Learn more about stacking.

[greptile-apps]

Confidence Score: 5/5

Documentation-only change with no runtime code touched; all three modifications are accurate against the current Go SDK API.

The Go SDK fix is verified against core/schemas/context.go — NewBifrostContext returns *BifrostContext, SetValue is the correct method, and BifrostContextKeyPassthroughExtraParams is not in the reserved-key list so the write is not silently dropped. The new cURL example correctly uses the extra_params wrapper for the /openai route. The router's ParseModelString handles the 'openai/gpt-4o-mini' format used in both examples.

No files require special attention.

Important Files Changed

Filename	Overview
docs/providers/request-options.mdx	Adds entrypoint-specific explanation and a new cURL tab for the OpenAI integration route; fixes the Go SDK example to use the correct NewBifrostContext + SetValue API instead of context.WithValue

_{Reviews (5): Last reviewed commit: "chore: updated docs for extra params pas..." | Re-trigger Greptile}

[sammaji]

@coderabbitai review

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/providers/request-options.mdx`:
- Line 549: Update the cURL example endpoint which currently uses
'http://localhost:8080/openai/chat/completions' to the correct route
'/openai/v1/chat/completions' so the example calls
'http://localhost:8080/openai/v1/chat/completions'; locate the cURL snippet in
the docs where the broken URL appears and replace the path portion to match the
integration route '/openai/v1/chat/completions'.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: d1ddf18a-bd70-476d-9c9b-b52a3fe66029

📥 Commits

Reviewing files that changed from the base of the PR and between 8137423 and 48158ed.

📒 Files selected for processing (1)

• docs/providers/request-options.mdx

[akshaydeo]

Merge activity

• Jun 2, 4:44 PM UTC: A user started a stack merge that includes this pull request via Graphite.
• Jun 2, 4:48 PM UTC: @akshaydeo merged this pull request with Graphite.