docs: add response.web_search_call.in_progress and response.web_search_call.completed to stream response type enums - #5345
Conversation
|
|
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 44 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the 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 configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe streaming response schema and OpenAPI documentation now include ChangesWeb search lifecycle events
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Confidence Score: 5/5This looks safe to merge.
Important Files Changed
Reviews (3): Last reviewed commit: "docs: fix responses stream event enum dr..." | Re-trigger Greptile |
781d422 to
fefdf6e
Compare
27da4f2 to
683aa2c
Compare
Merge activity
|
The base branch was changed.
683aa2c to
43b0268
Compare
…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
…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

Summary
Adds two missing streaming event types for web search calls —
response.web_search_call.in_progressandresponse.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
response.web_search_call.in_progressandresponse.web_search_call.completedto theResponsesStreamResponseTypeenum in the responses schema and all corresponding locations in the generated OpenAPI JSON.Type of change
Affected areas
How to test
Verify that the OpenAPI spec correctly enumerates
response.web_search_call.in_progressandresponse.web_search_call.completedalongside the existingresponse.web_search_call.searching,response.web_search_call.results.added, andresponse.web_search_call.results.completedevent types.Breaking changes
Related issues
Security considerations
None.
Checklist
docs/contributing/README.mdand followed the guidelines