Skip to content

chore: adds docs for azure model router - #5175

Merged
akshaydeo merged 1 commit into
devfrom
07-08-chore_adds_docs_for_azure_model_router
Jul 21, 2026
Merged

akshaydeo merged 1 commit into
devfrom
07-08-chore_adds_docs_for_azure_model_router

Conversation

@sammaji

@sammaji sammaji commented Jul 14, 2026 •

Copy link
Copy Markdown
Member

Summary

Adds a dedicated documentation page for the Azure Model Router provider, explaining how Bifrost automatically falls back to Chat Completions when a model-router deployment is targeted via the Responses API.

Changes

  • Added docs/providers/supported-providers/azure-model-router.mdx documenting the Azure model-router routing behavior, supported operations, a Mermaid flowchart illustrating the fallback logic, usage examples (REST and Go SDK), and known limitations.
  • Registered the new page in docs/docs.json so it appears in the navigation between the Azure and Bedrock entries.

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

Navigate to the Azure Model Router page in the rendered docs and verify:

  • The page appears in the sidebar between Azure and Bedrock.
  • The Mermaid flowchart renders correctly.
  • All code examples and notes display as expected.

Breaking changes

  • Yes
  • No

Related issues

Security considerations

None. This is a documentation-only change with no impact on auth, secrets, or runtime behavior.

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

@coderabbitai

coderabbitai Bot commented Jul 14, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added documentation for using Azure OpenAI model-router deployments.
    • Explained supported Chat Completions usage and the configuration workaround for Responses.
    • Included Web UI, API, and configuration file setup examples.
    • Added endpoint usage guidance, limitations, and related documentation links.
    • Updated the provider documentation navigation to include the new page.

Walkthrough

Adds documentation for Azure OpenAI model-router deployments, including Chat Completions support, Responses configuration through Azure AI Foundry, usage examples, limitations, related documentation, and navigation.

Changes

Azure Model Router documentation

Layer / File(s) Summary
Document model-router setup and usage
docs/providers/supported-providers/azure-model-router.mdx
Adds the model-router overview, supported-operations table, Azure AI Foundry configuration steps, Responses request example, limitations, and related documentation links.
Add supported-provider navigation entry
docs/docs.json
Adds the Azure model-router page to the supported-provider navigation after Azure.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: bearts, pratham-mishra04

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately describes the documentation addition for the Azure model router.
Description check ✅ Passed The description covers the required sections and is mostly complete, with only minor non-critical items left blank.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 07-08-chore_adds_docs_for_azure_model_router

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Checkov (3.3.8)
docs/docs.json

Traceback (most recent call last):
File "/usr/local/bin/checkov", line 2, in
from checkov.main import Checkov
ModuleNotFoundError: No module named 'checkov'


Comment @coderabbitai help to get the list of available commands.

sammaji commented Jul 14, 2026 •

Copy link
Copy Markdown
Member Author

@sammaji
sammaji changed the base branch from 07-08-fix_azure_model-router_responses_fallback_routing to graphite-base/5175 July 16, 2026 12:19
@sammaji
sammaji force-pushed the graphite-base/5175 branch from 287dcab to c0909f9 Compare July 16, 2026 12:19
@sammaji
sammaji force-pushed the 07-08-chore_adds_docs_for_azure_model_router branch from 28377e4 to 2be6c55 Compare July 16, 2026 12:19
@sammaji
sammaji changed the base branch from graphite-base/5175 to dev July 16, 2026 12:19
@sammaji
sammaji changed the base branch from dev to graphite-base/5175 July 16, 2026 21:34
@sammaji
sammaji force-pushed the 07-08-chore_adds_docs_for_azure_model_router branch from 2be6c55 to b467169 Compare July 16, 2026 21:34
@sammaji
sammaji changed the base branch from graphite-base/5175 to 07-15-fix_drops_unsupported_reasoning_summary_values_for_azure_model_router July 16, 2026 21:34
@sammaji
sammaji changed the base branch from 07-15-fix_drops_unsupported_reasoning_summary_values_for_azure_model_router to graphite-base/5175 July 17, 2026 14:56
@sammaji
sammaji force-pushed the graphite-base/5175 branch from 10c6695 to 701b4a5 Compare July 17, 2026 14:57
@sammaji
sammaji force-pushed the 07-08-chore_adds_docs_for_azure_model_router branch from b467169 to b8ed6b8 Compare July 17, 2026 14:57
@sammaji
sammaji changed the base branch from graphite-base/5175 to dev July 17, 2026 14:57
@akshaydeo
akshaydeo force-pushed the dev branch 2 times, most recently from 44564de to 493bff0 Compare July 18, 2026 01:10
@sammaji
sammaji force-pushed the 07-08-chore_adds_docs_for_azure_model_router branch from b8ed6b8 to 0fa6e8a Compare July 21, 2026 11:40
@sammaji
sammaji marked this pull request as ready for review July 21, 2026 11:45
Copilot AI review requested due to automatic review settings July 21, 2026 11:45

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@greptile-apps

greptile-apps Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Confidence Score: 4/5

The raw-response logging guidance needs correction before merging.

  • The navigation entry and main configuration example match existing documentation patterns.
  • The logging note can cause users to persist raw provider data when they intend not to store it.

docs/providers/supported-providers/azure-model-router.mdx

Security Review

The raw-response note can cause sensitive provider data to be persisted because it recommends setting the storage option when the stated goal is to avoid storage.

Important Files Changed

Filename Overview
docs/docs.json Adds the new page to the Supported Providers navigation with a matching route.
docs/providers/supported-providers/azure-model-router.mdx Adds the provider guide, but reverses the meaning of the raw-data storage option.

Reviews (1): Last reviewed commit: "chore: adds docs for azure model router" | Re-trigger Greptile

```

<Note>
If you need to inspect provider-specific extra parameters, enable [Send Back Raw Response](/providers/request-options#send-back-raw-response). If you do not want those raw bytes persisted in logs, also set [Store Raw Request/Response](/providers/request-options#store-raw-request/response).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 security Raw Logging Advice Is Reversed

When a user wants to inspect raw responses without persisting them, this note tells them to set Store Raw Request/Response, which enables internal log persistence rather than preventing it. This can store sensitive provider data against the user's intent; the option should remain disabled, and the corrected link should use the generated section fragment.

Suggested change
If you need to inspect provider-specific extra parameters, enable [Send Back Raw Response](/providers/request-options#send-back-raw-response). If you do not want those raw bytes persisted in logs, also set [Store Raw Request/Response](/providers/request-options#store-raw-request/response).
If you need to inspect provider-specific extra parameters, enable [Send Back Raw Response](/providers/request-options#send-back-raw-response). If you do not want those raw bytes persisted in logs, leave [Store Raw Request/Response](/providers/request-options#store-raw-requestresponse) disabled.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🧹 Nitpick comments (1)
docs/providers/supported-providers/azure-model-router.mdx (1)

113-115: 🔒 Security & Privacy | 🔵 Trivial | ⚡ Quick win

Clarify the independence of the raw-response controls.

Use a <Warning> block to distinguish returning provider-specific data from persisting raw requests/responses, and state which setting must be disabled to prevent persistence. The current <Note> can imply that enabling one control governs the other.

As per path instructions, config-flag independence should be called out explicitly with a Warning.

🤖 Prompt for 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.

In `@docs/providers/supported-providers/azure-model-router.mdx` around lines 113 -
115, The raw-response guidance in the Note should explicitly distinguish
returning provider-specific data from persisting raw requests/responses. Replace
the Note with a Warning that explains these controls are independent and states
that Store Raw Request/Response must be disabled to prevent persistence, while
retaining the Send Back Raw Response setting for inspecting provider-specific
parameters.

Source: Path instructions

🤖 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/supported-providers/azure-model-router.mdx`:
- Around line 100-111: Add a Go SDK usage example alongside the existing curl
example in the Usage section, following the repository’s established SDK
conventions and using the same azure-foundry provider, model-router deployment,
Responses endpoint, and input prompt.
- Around line 84-89: Update the request_path_overrides entry in the field table
to mark it as required for the documented Azure Foundry Responses setup, and
clarify that both responses and responses_stream overrides must be provided to
route requests to the Responses endpoint. Leave the other field requirements
unchanged.
- Line 30: Update the Azure AI Foundry documentation to use the
*.services.ai.azure.com/api/projects/<project> hostname throughout the prose, UI
example, and JSON request_path_overrides. In the custom provider example, remove
base_url or explicitly state that the full-URL responses and responses_stream
overrides bypass it.

---

Nitpick comments:
In `@docs/providers/supported-providers/azure-model-router.mdx`:
- Around line 113-115: The raw-response guidance in the Note should explicitly
distinguish returning provider-specific data from persisting raw
requests/responses. Replace the Note with a Warning that explains these controls
are independent and states that Store Raw Request/Response must be disabled to
prevent persistence, while retaining the Send Back Raw Response setting for
inspecting provider-specific parameters.
🪄 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: CHILL

Plan: Pro Plus

Run ID: b4f3473e-7b67-4b57-9543-85dc64c2992e

📥 Commits

Reviewing files that changed from the base of the PR and between 878938e and 0fa6e8a.

📒 Files selected for processing (2)
  • docs/docs.json
  • docs/providers/supported-providers/azure-model-router.mdx


## Adding Azure Foundry as a custom provider

Azure AI Foundry projects expose an OpenAI-Responses-API-shaped endpoint (`*.ai.azure.com/api/projects/<project>/openai/v1/responses`) that is distinct from the classic Azure OpenAI resource endpoint (`*.openai.azure.com`) used by the native Azure provider. You can reach it by creating a [custom provider](../custom-providers) named e.g. `azure-foundry` with `base_provider_type: "openai"` and a full-URL [request path override](../custom-providers#request-path-overrides) for the `responses` and `responses_stream` request types. A full URL in `request_path_overrides` bypasses `base_url` entirely, so requests go straight to your Azure AI Foundry project's Responses endpoint.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/sh
set -eu
curl -fsSL 'https://learn.microsoft.com/en-us/rest/api/microsoft-foundry/aiproject' |
  grep -F 'services.ai.azure.com/api/projects'

Repository: maximhq/bifrost

Length of output: 35769


🏁 Script executed:

#!/bin/sh
set -eu

file='docs/providers/supported-providers/azure-model-router.mdx'

# Show the relevant sections with line numbers.
sed -n '1,180p' "$file" | cat -n

echo
echo '---'
echo 'Occurrences of ai.azure.com / services.ai.azure.com in this file:'
grep -nE 'ai\.azure\.com|services\.ai\.azure\.com|base_url|request_path_overrides|responses_stream|responses' "$file" || true

Repository: maximhq/bifrost

Length of output: 9228


Use the Foundry project hostname

The examples still point at *.ai.azure.com/api/projects/..., but the Foundry project endpoint uses *.services.ai.azure.com/api/projects/<project>. Update the prose, UI example, and JSON overrides, and either remove the base_url example or call out that the full-URL overrides ignore it.

🤖 Prompt for 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.

In `@docs/providers/supported-providers/azure-model-router.mdx` at line 30, Update
the Azure AI Foundry documentation to use the
*.services.ai.azure.com/api/projects/<project> hostname throughout the prose, UI
example, and JSON request_path_overrides. In the custom provider example, remove
base_url or explicitly state that the full-URL responses and responses_stream
overrides bypass it.

Comment on lines +84 to +89
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `custom_provider_config.base_provider_type` | string | Yes | Must be `openai` so requests are shaped as OpenAI-compatible calls |
| `custom_provider_config.allowed_requests` | object | No | Restricts this provider to only the request types you enable |
| `custom_provider_config.request_path_overrides` | object | No | Full URL per request type; bypasses `network_config.base_url` |
| `network_config.base_url` | string | No | Used for any request type without a full-URL override |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Mark the Responses override as required for this setup.

request_path_overrides is documented as optional, but the page states that the full override is what routes requests to the Azure Foundry Responses endpoint. Without the responses and responses_stream overrides, this workaround has no documented path to that endpoint.

As per path instructions, the field table should make required fields explicit for the documented scenario.

🤖 Prompt for 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.

In `@docs/providers/supported-providers/azure-model-router.mdx` around lines 84 -
89, Update the request_path_overrides entry in the field table to mark it as
required for the documented Azure Foundry Responses setup, and clarify that both
responses and responses_stream overrides must be provided to route requests to
the Responses endpoint. Leave the other field requirements unchanged.

Source: Path instructions

Comment on lines +100 to +111
## Usage

Call the Responses endpoint using the `azure-foundry` custom provider and your model-router deployment name:

```bash
curl -X POST http://localhost:8080/v1/responses \
-H "Content-Type: application/json" \
-d '{
"model": "azure-foundry/model-router",
"input": "Write a short haiku about gateways."
}'
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Add the promised Go SDK example.

The PR objectives call for REST and Go SDK usage examples, but this section only documents curl. Add a Go SDK example using the repository’s established SDK conventions.

🤖 Prompt for 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.

In `@docs/providers/supported-providers/azure-model-router.mdx` around lines 100 -
111, Add a Go SDK usage example alongside the existing curl example in the Usage
section, following the repository’s established SDK conventions and using the
same azure-foundry provider, model-router deployment, Responses endpoint, and
input prompt.

akshaydeo commented Jul 21, 2026 •

Copy link
Copy Markdown
Contributor

Merge activity

  • Jul 21, 2:59 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Jul 21, 2:59 PM UTC: @akshaydeo merged this pull request with Graphite.

@akshaydeo
akshaydeo merged commit 6deb72d into dev Jul 21, 2026
17 checks passed
@akshaydeo
akshaydeo deleted the 07-08-chore_adds_docs_for_azure_model_router branch July 21, 2026 14:59
akshaydeo added a commit that referenced this pull request Jul 21, 2026
* chore: fix migration tests

* framework test fixes (#5421)

* chore: adds docs for azure model router (#5175)

## Summary

Adds a dedicated documentation page for the Azure Model Router provider, explaining how Bifrost automatically falls back to Chat Completions when a model-router deployment is targeted via the Responses API.

## Changes

- Added `docs/providers/supported-providers/azure-model-router.mdx` documenting the Azure model-router routing behavior, supported operations, a Mermaid flowchart illustrating the fallback logic, usage examples (REST and Go SDK), and known limitations.
- Registered the new page in `docs/docs.json` so it appears in the navigation between the Azure and Bedrock entries.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

Navigate to the Azure Model Router page in the rendered docs and verify:
- The page appears in the sidebar between Azure and Bedrock.
- The Mermaid flowchart renders correctly.
- All code examples and notes display as expected.

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

## Security considerations

None. This is a documentation-only change with no impact on auth, secrets, or runtime behavior.

## Checklist

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

* fix: adds created timestamp for openai text completions (#5407)

## Summary

Adds the missing `created` field to `BifrostTextCompletionResponse` to align with the OpenAI text completion response schema, and modernizes the `ExtraParams` type alias from `map[string]interface{}` to the equivalent `map[string]any`.

## Changes

- Added `Created int` field with `omitempty` to `BifrostTextCompletionResponse`, representing the Unix timestamp (in seconds) of when the completion was created — this field was previously absent from the struct despite being part of the API response.
- Replaced `map[string]interface{}` with `map[string]any` in `TextCompletionParameters.ExtraParams` to use the modern Go type alias.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [x] Refactor
- [ ] Documentation
- [ ] Chore/CI

## Affected areas

- [x] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [ ] Docs

## How to test

```sh
go version
go test ./...
```

Verify that text completion responses now include the `created` timestamp field when it is non-zero.

## Screenshots/Recordings

N/A

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

N/A

## Security considerations

None.

## Checklist

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

---------

Co-authored-by: Samyabrata Maji <116789799+sammaji@users.noreply.github.com>
Co-authored-by: Samyabrata Maji <samyabratamaji334@gmail.com>
akhsaul pushed a commit to akhsaul/bifrost that referenced this pull request Aug 27, 2026
## Summary

Adds a dedicated documentation page for the Azure Model Router provider, explaining how Bifrost automatically falls back to Chat Completions when a model-router deployment is targeted via the Responses API.

## Changes

- Added `docs/providers/supported-providers/azure-model-router.mdx` documenting the Azure model-router routing behavior, supported operations, a Mermaid flowchart illustrating the fallback logic, usage examples (REST and Go SDK), and known limitations.
- Registered the new page in `docs/docs.json` so it appears in the navigation between the Azure and Bedrock entries.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

Navigate to the Azure Model Router page in the rendered docs and verify:
- The page appears in the sidebar between Azure and Bedrock.
- The Mermaid flowchart renders correctly.
- All code examples and notes display as expected.

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

## Security considerations

None. This is a documentation-only change with no impact on auth, secrets, or runtime behavior.

## Checklist

- [ ] I read `docs/contributing/README.md` and followed the guidelines
- [ ] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [ ] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
akhsaul pushed a commit to akhsaul/bifrost that referenced this pull request Aug 27, 2026
* chore: fix migration tests

* framework test fixes (maximhq#5421)

* chore: adds docs for azure model router (maximhq#5175)

## Summary

Adds a dedicated documentation page for the Azure Model Router provider, explaining how Bifrost automatically falls back to Chat Completions when a model-router deployment is targeted via the Responses API.

## Changes

- Added `docs/providers/supported-providers/azure-model-router.mdx` documenting the Azure model-router routing behavior, supported operations, a Mermaid flowchart illustrating the fallback logic, usage examples (REST and Go SDK), and known limitations.
- Registered the new page in `docs/docs.json` so it appears in the navigation between the Azure and Bedrock entries.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

Navigate to the Azure Model Router page in the rendered docs and verify:
- The page appears in the sidebar between Azure and Bedrock.
- The Mermaid flowchart renders correctly.
- All code examples and notes display as expected.

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

## Security considerations

None. This is a documentation-only change with no impact on auth, secrets, or runtime behavior.

## Checklist

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

* fix: adds created timestamp for openai text completions (maximhq#5407)

## Summary

Adds the missing `created` field to `BifrostTextCompletionResponse` to align with the OpenAI text completion response schema, and modernizes the `ExtraParams` type alias from `map[string]interface{}` to the equivalent `map[string]any`.

## Changes

- Added `Created int` field with `omitempty` to `BifrostTextCompletionResponse`, representing the Unix timestamp (in seconds) of when the completion was created — this field was previously absent from the struct despite being part of the API response.
- Replaced `map[string]interface{}` with `map[string]any` in `TextCompletionParameters.ExtraParams` to use the modern Go type alias.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [x] Refactor
- [ ] Documentation
- [ ] Chore/CI

## Affected areas

- [x] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [ ] Docs

## How to test

```sh
go version
go test ./...
```

Verify that text completion responses now include the `created` timestamp field when it is non-zero.

## Screenshots/Recordings

N/A

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

N/A

## Security considerations

None.

## Checklist

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

---------

Co-authored-by: Samyabrata Maji <116789799+sammaji@users.noreply.github.com>
Co-authored-by: Samyabrata Maji <samyabratamaji334@gmail.com>
occcat pushed a commit to occcat/bifrost that referenced this pull request Sep 2, 2026
## Summary

Adds a dedicated documentation page for the Azure Model Router provider, explaining how Bifrost automatically falls back to Chat Completions when a model-router deployment is targeted via the Responses API.

## Changes

- Added `docs/providers/supported-providers/azure-model-router.mdx` documenting the Azure model-router routing behavior, supported operations, a Mermaid flowchart illustrating the fallback logic, usage examples (REST and Go SDK), and known limitations.
- Registered the new page in `docs/docs.json` so it appears in the navigation between the Azure and Bedrock entries.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

Navigate to the Azure Model Router page in the rendered docs and verify:
- The page appears in the sidebar between Azure and Bedrock.
- The Mermaid flowchart renders correctly.
- All code examples and notes display as expected.

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

## Security considerations

None. This is a documentation-only change with no impact on auth, secrets, or runtime behavior.

## Checklist

- [ ] I read `docs/contributing/README.md` and followed the guidelines
- [ ] I added/updated tests where appropriate
- [x] I updated documentation where needed
- [ ] I verified builds succeed (Go and UI)
- [ ] I verified the CI pipeline passes locally if applicable
occcat pushed a commit to occcat/bifrost that referenced this pull request Sep 2, 2026
* chore: fix migration tests

* framework test fixes (maximhq#5421)

* chore: adds docs for azure model router (maximhq#5175)

## Summary

Adds a dedicated documentation page for the Azure Model Router provider, explaining how Bifrost automatically falls back to Chat Completions when a model-router deployment is targeted via the Responses API.

## Changes

- Added `docs/providers/supported-providers/azure-model-router.mdx` documenting the Azure model-router routing behavior, supported operations, a Mermaid flowchart illustrating the fallback logic, usage examples (REST and Go SDK), and known limitations.
- Registered the new page in `docs/docs.json` so it appears in the navigation between the Azure and Bedrock entries.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [ ] Refactor
- [x] Documentation
- [ ] Chore/CI

## Affected areas

- [ ] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [x] Docs

## How to test

Navigate to the Azure Model Router page in the rendered docs and verify:
- The page appears in the sidebar between Azure and Bedrock.
- The Mermaid flowchart renders correctly.
- All code examples and notes display as expected.

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

## Security considerations

None. This is a documentation-only change with no impact on auth, secrets, or runtime behavior.

## Checklist

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

* fix: adds created timestamp for openai text completions (maximhq#5407)

## Summary

Adds the missing `created` field to `BifrostTextCompletionResponse` to align with the OpenAI text completion response schema, and modernizes the `ExtraParams` type alias from `map[string]interface{}` to the equivalent `map[string]any`.

## Changes

- Added `Created int` field with `omitempty` to `BifrostTextCompletionResponse`, representing the Unix timestamp (in seconds) of when the completion was created — this field was previously absent from the struct despite being part of the API response.
- Replaced `map[string]interface{}` with `map[string]any` in `TextCompletionParameters.ExtraParams` to use the modern Go type alias.

## Type of change

- [ ] Bug fix
- [ ] Feature
- [x] Refactor
- [ ] Documentation
- [ ] Chore/CI

## Affected areas

- [x] Core (Go)
- [ ] Transports (HTTP)
- [ ] Providers/Integrations
- [ ] Plugins
- [ ] UI (React)
- [ ] Docs

## How to test

```sh
go version
go test ./...
```

Verify that text completion responses now include the `created` timestamp field when it is non-zero.

## Screenshots/Recordings

N/A

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

N/A

## Security considerations

None.

## Checklist

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

---------

Co-authored-by: Samyabrata Maji <116789799+sammaji@users.noreply.github.com>
Co-authored-by: Samyabrata Maji <samyabratamaji334@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants