Skip to content

docs: add response.web_search_call.in_progress and response.web_search_call.completed to stream response type enums - #5345

Merged
Pratham-Mishra04 merged 1 commit into
devfrom
07-18-docs_fix_responses_stream_event_enum_drift_in_openapi_spec
Jul 20, 2026
Merged

docs: add response.web_search_call.in_progress and response.web_search_call.completed to stream response type enums#5345
Pratham-Mishra04 merged 1 commit into
devfrom
07-18-docs_fix_responses_stream_event_enum_drift_in_openapi_spec

Conversation

@Pratham-Mishra04

Copy link
Copy Markdown
Collaborator

Summary

Adds two missing streaming event types for web search calls — response.web_search_call.in_progress and response.web_search_call.completed — to the OpenAPI spec and schema definitions, bringing the web search call lifecycle events in line with other tool call types.

Changes

  • Added response.web_search_call.in_progress and response.web_search_call.completed to the ResponsesStreamResponseType enum in the responses schema and all corresponding locations in the generated OpenAPI JSON.

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

Verify that the OpenAPI spec correctly enumerates response.web_search_call.in_progress and response.web_search_call.completed alongside the existing response.web_search_call.searching, response.web_search_call.results.added, and response.web_search_call.results.completed event types.

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

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 44 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 887052f0-f07f-4bc4-99fe-19aa254357da

📥 Commits

Reviewing files that changed from the base of the PR and between 683aa2c and 43b0268.

📒 Files selected for processing (2)
  • docs/openapi/openapi.json
  • docs/openapi/schemas/inference/responses.yaml
📝 Walkthrough

Walkthrough

The streaming response schema and OpenAPI documentation now include response.web_search_call.in_progress and response.web_search_call.completed alongside the existing searching event.

Changes

Web search lifecycle events

Layer / File(s) Summary
Expand web search response events
docs/openapi/schemas/inference/responses.yaml, docs/openapi/openapi.json
The streaming response enum and repeated OpenAPI event sequences add the in_progress and completed web search call events while retaining searching.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: danpiths, akshaydeo

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title clearly and accurately summarizes the primary change: adding missing web search call stream event enums.
Description check ✅ Passed The PR description covers summary, changes, type, affected area, testing, breaking changes, security, and checklist, with only minor omissions.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 07-18-docs_fix_responses_stream_event_enum_drift_in_openapi_spec

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

@greptile-apps

greptile-apps Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Confidence Score: 5/5

This looks safe to merge.

  • No blocking issues found in the changed code.

Important Files Changed

Filename Overview
docs/openapi/schemas/inference/responses.yaml Adds the two missing web-search lifecycle values to the streaming response enum.
docs/openapi/openapi.json Updates all generated copies of the streaming response enum.

Reviews (3): Last reviewed commit: "docs: fix responses stream event enum dr..." | Re-trigger Greptile

@Pratham-Mishra04
Pratham-Mishra04 force-pushed the 07-18-docs_add_openapi_coverage_for_responses_lifecycle_endpoints branch from 781d422 to fefdf6e Compare July 18, 2026 05:24
@Pratham-Mishra04
Pratham-Mishra04 force-pushed the 07-18-docs_fix_responses_stream_event_enum_drift_in_openapi_spec branch from 27da4f2 to 683aa2c Compare July 18, 2026 05:24
coderabbitai[bot]
coderabbitai Bot previously approved these changes Jul 18, 2026

Pratham-Mishra04 commented Jul 20, 2026

Copy link
Copy Markdown
Collaborator Author

Merge activity

  • Jul 20, 7:33 AM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Jul 20, 7:49 AM UTC: Graphite rebased this pull request as part of a merge.
  • Jul 20, 7:50 AM UTC: @Pratham-Mishra04 merged this pull request with Graphite.

@Pratham-Mishra04
Pratham-Mishra04 changed the base branch from 07-18-docs_add_openapi_coverage_for_responses_lifecycle_endpoints to graphite-base/5345 July 20, 2026 07:45
@Pratham-Mishra04
Pratham-Mishra04 changed the base branch from graphite-base/5345 to dev July 20, 2026 07:48
@Pratham-Mishra04
Pratham-Mishra04 dismissed coderabbitai[bot]’s stale review July 20, 2026 07:48

The base branch was changed.

@Pratham-Mishra04
Pratham-Mishra04 force-pushed the 07-18-docs_fix_responses_stream_event_enum_drift_in_openapi_spec branch from 683aa2c to 43b0268 Compare July 20, 2026 07:48
@Pratham-Mishra04
Pratham-Mishra04 merged commit bce784b into dev Jul 20, 2026
14 of 16 checks passed
@Pratham-Mishra04
Pratham-Mishra04 deleted the 07-18-docs_fix_responses_stream_event_enum_drift_in_openapi_spec branch July 20, 2026 07:50
akhsaul pushed a commit to akhsaul/bifrost that referenced this pull request Aug 27, 2026
…arch_call.completed` to stream response type enums (maximhq#5345)

## Summary

Adds two missing streaming event types for web search calls — `response.web_search_call.in_progress` and `response.web_search_call.completed` — to the OpenAPI spec and schema definitions, bringing the web search call lifecycle events in line with other tool call types.

## Changes

- Added `response.web_search_call.in_progress` and `response.web_search_call.completed` to the `ResponsesStreamResponseType` enum in the responses schema and all corresponding locations in the generated OpenAPI JSON.

## 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

Verify that the OpenAPI spec correctly enumerates `response.web_search_call.in_progress` and `response.web_search_call.completed` alongside the existing `response.web_search_call.searching`, `response.web_search_call.results.added`, and `response.web_search_call.results.completed` event types.

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

## Security considerations

None.

## 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
…arch_call.completed` to stream response type enums (maximhq#5345)

## Summary

Adds two missing streaming event types for web search calls — `response.web_search_call.in_progress` and `response.web_search_call.completed` — to the OpenAPI spec and schema definitions, bringing the web search call lifecycle events in line with other tool call types.

## Changes

- Added `response.web_search_call.in_progress` and `response.web_search_call.completed` to the `ResponsesStreamResponseType` enum in the responses schema and all corresponding locations in the generated OpenAPI JSON.

## 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

Verify that the OpenAPI spec correctly enumerates `response.web_search_call.in_progress` and `response.web_search_call.completed` alongside the existing `response.web_search_call.searching`, `response.web_search_call.results.added`, and `response.web_search_call.results.completed` event types.

## Breaking changes

- [ ] Yes
- [x] No

## Related issues

## Security considerations

None.

## 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
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.

2 participants