Fix the nullability of the `Status` property of Responses items by joseharriaga · Pull Request #1346 · openai/openai-dotnet

joseharriaga · 2026-08-28T21:45:01Z

The status properties of Responses items were not defined as optional in the base TypeSpec. This error in the spec remained hidden because the properties went through a series of overlapping customizations in client.tsp, the OpenAILibraryVisitor, and Custom code that correctly exposed the Status as nullable in the .NET library. However, these same customizations resulted in incorrect deserialization code that would fail when the value of status was null. In other words: Even though the property was nullable, our deserialization logic was not accepting null as valid. This change fixes the base TypeSpec and removes the overlapping customizations.

* Fix optional response item statuses Co-authored-by: joseharriaga <45773732+joseharriaga@users.noreply.github.com> * Complete optional response item status fixes Co-authored-by: joseharriaga <45773732+joseharriaga@users.noreply.github.com> * Restore required apply patch output status Co-authored-by: joseharriaga <45773732+joseharriaga@users.noreply.github.com> * Regenerate API listings Co-authored-by: joseharriaga <45773732+joseharriaga@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: joseharriaga <45773732+joseharriaga@users.noreply.github.com>

Copilot

Pull request overview

This PR aligns the Responses item status field nullability across the TypeSpec source, codegen customization layer, and generated .NET models so that deserialization correctly accepts "status": null without throwing, while also removing now-redundant custom overrides.

Changes:

Updates the base Responses TypeSpec item models to make many status properties optional and relocates the apply-patch output status note to the base spec.
Removes overlapping status customizations from the client TSP layer and the codegen OpenAILibraryVisitor.
Regenerates .NET Responses models/serializers so Status is nullable and deserializers skip JsonValueKind.Null for status, and removes the corresponding custom partial Status properties.

Reviewed changes

Copilot reviewed 14 out of 45 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
specification/client/responses.client.tsp	Removes per-item `status` lifecycle visibility overrides now handled by the base spec/codegen.
specification/base/typespec/responses/models_items.tsp	Makes multiple item `status` properties optional; documents apply-patch output status requirement in the base model.
OpenAI.Responses/src/Generated/Models/WebSearchCallResponseItem.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/WebSearchCallResponseItem.cs	Adds generated nullable `Status` property.
OpenAI.Responses/src/Generated/Models/ReasoningResponseItem.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/ReasoningResponseItem.cs	Adds generated nullable `Status` property.
OpenAI.Responses/src/Generated/Models/MessageResponseItem.Serialization.cs	Removes no-longer-relevant generator customization comments for status write guard.
OpenAI.Responses/src/Generated/Models/MessageResponseItem.cs	Adds generated nullable `Status` property.
OpenAI.Responses/src/Generated/Models/InternalUnknownResponsesMessageItemResource.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/InternalResponsesUserMessage.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/InternalResponsesSystemMessage.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/InternalResponsesDeveloperMessage.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/InternalResponsesAssistantMessage.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/InternalLocalShellToolCallOutputItemResource.Serialization.cs	Makes status write conditional on `Optional.IsDefined`; skips `status: null` in deserialization.
OpenAI.Responses/src/Generated/Models/InternalLocalShellToolCallOutputItemResource.cs	Updates `Status` to nullable and adjusts constructors accordingly.
OpenAI.Responses/src/Generated/Models/InternalLocalShellToolCallItemResource.Serialization.cs	Makes status write conditional on `Optional.IsDefined`; skips `status: null` in deserialization.
OpenAI.Responses/src/Generated/Models/InternalLocalShellToolCallItemResource.cs	Updates `Status` to nullable and adjusts constructors accordingly.
OpenAI.Responses/src/Generated/Models/ImageGenerationCallResponseItem.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/ImageGenerationCallResponseItem.cs	Adds generated nullable `Status` property.
OpenAI.Responses/src/Generated/Models/FunctionCallResponseItem.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/FunctionCallResponseItem.cs	Adds generated nullable `Status` property.
OpenAI.Responses/src/Generated/Models/FunctionCallOutputResponseItem.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/FunctionCallOutputResponseItem.cs	Adds generated nullable `Status` property.
OpenAI.Responses/src/Generated/Models/FileSearchCallResponseItem.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/FileSearchCallResponseItem.cs	Adds generated nullable `Status` property.
OpenAI.Responses/src/Generated/Models/ComputerCallResponseItem.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/ComputerCallResponseItem.cs	Adds generated nullable `Status` property.
OpenAI.Responses/src/Generated/Models/ComputerCallOutputResponseItem.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/ComputerCallOutputResponseItem.cs	Adds generated nullable `Status` property.
OpenAI.Responses/src/Generated/Models/CodeInterpreterCallResponseItem.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/CodeInterpreterCallResponseItem.cs	Adds generated nullable `Status` property.
OpenAI.Responses/src/Generated/Models/ApplyPatchCallItem.Serialization.cs	Skips `status` when JSON value is `null` during deserialization.
OpenAI.Responses/src/Generated/Models/ApplyPatchCallItem.cs	Adds generated nullable `Status` property.
OpenAI.Responses/src/Custom/Items/WebSearchTool/WebSearchCallResponseItem.cs	Removes custom `Status` property override now generated correctly.
OpenAI.Responses/src/Custom/Items/Reasoning/ReasoningResponseItem.cs	Removes custom `Status` property override now generated correctly.
OpenAI.Responses/src/Custom/Items/Message/MessageResponseItem.cs	Removes custom `Status` property override now generated correctly.
OpenAI.Responses/src/Custom/Items/ImageGenerationTool/ImageGenerationCallResponseItem.cs	Removes custom `Status` property override now generated correctly.
OpenAI.Responses/src/Custom/Items/FunctionTool/FunctionCallResponseItem.cs	Removes custom `Status` property override now generated correctly.
OpenAI.Responses/src/Custom/Items/FunctionTool/FunctionCallOutputResponseItem.cs	Removes custom `Status` property override now generated correctly.
OpenAI.Responses/src/Custom/Items/FileSearchTool/FileSearchCallResponseItem.cs	Removes custom `Status` property override now generated correctly.
OpenAI.Responses/src/Custom/Items/ComputerTool/ComputerCallResponseItem.cs	Removes custom `Status` property override now generated correctly.
OpenAI.Responses/src/Custom/Items/ComputerTool/ComputerCallOutputResponseItem.cs	Removes custom `Status` property override now generated correctly.
OpenAI.Responses/src/Custom/Items/CodeInterpreterTool/CodeInterpreterCallResponseItem.cs	Removes custom `Status` property override now generated correctly.
OpenAI.Responses/src/Custom/Items/ApplyPatch/ApplyPatchCallItem.cs	Removes custom `Status` property override now generated correctly.
codegen/generator/src/OpenAILibraryVisitor.cs	Removes status-specific type mappings (but leaves an unused field that should be cleaned up).

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Co-authored-by: joseharriaga <45773732+joseharriaga@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 15 out of 46 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 15 out of 46 changed files in this pull request and generated no new comments.

Suppressed comments (1)

Previously missed (1) — in code that hasn't changed since the last review.

specification/base/typespec/responses/models_items.tsp:1067

This change edits the base TypeSpec under specification/base/typespec/, but the repo’s spec-ingestion guidance treats the base spec as an exact upstream copy (local fixes should live in specification/client/ or be applied upstream and then re-synced). Keeping local patches here risks the next spec ingestion overwriting this fix and reintroducing the null-status bug.

Co-authored-by: joseharriaga <45773732+joseharriaga@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 15 out of 46 changed files in this pull request and generated no new comments.

joseharriaga and others added 2 commits August 28, 2026 10:53

Fix optionality of ReasoningResponseItem.Status

948d01b

joseharriaga requested review from jairmyree and jsquire as code owners August 28, 2026 21:45

Copilot AI lite review requested due to automatic review settings August 28, 2026 21:45

joseharriaga requested a review from MaiLinhP as a code owner August 28, 2026 21:45

Copilot started reviewing on behalf of joseharriaga August 28, 2026 21:45 View session

Copilot AI reviewed Aug 28, 2026

View reviewed changes

Comment thread codegen/generator/src/OpenAILibraryVisitor.cs

Comment thread OpenAI.Responses/src/Generated/Models/WebSearchCallResponseItem.Serialization.cs

Copilot started work on behalf of joseharriaga August 28, 2026 21:53 View session

Copilot started work on behalf of joseharriaga August 28, 2026 21:54 View session

Remove unused status replacement field

2688b60

Co-authored-by: joseharriaga <45773732+joseharriaga@users.noreply.github.com>

Copilot AI review requested due to automatic review settings August 28, 2026 21:55

Copilot started reviewing on behalf of joseharriaga August 28, 2026 21:55 View session

Remove unused status generator field

e72a31a

Co-authored-by: joseharriaga <45773732+joseharriaga@users.noreply.github.com>

Copilot finished work on behalf of joseharriaga August 28, 2026 21:59

Copilot AI and others added 2 commits August 28, 2026 21:59

Limit fix to requested response smoke test

283e92b

Co-authored-by: joseharriaga <45773732+joseharriaga@users.noreply.github.com>

Restore generator file unchanged

76976f0

Co-authored-by: joseharriaga <45773732+joseharriaga@users.noreply.github.com>

Copilot AI reviewed Aug 28, 2026

View reviewed changes

Comment thread specification/client/responses.client.tsp

Copilot AI review requested due to automatic review settings August 28, 2026 22:02

Copilot started reviewing on behalf of joseharriaga August 28, 2026 22:02 View session

Copilot finished work on behalf of joseharriaga August 28, 2026 22:05

Copilot AI reviewed Aug 28, 2026

View reviewed changes

joseharriaga mentioned this pull request Aug 29, 2026

[BUG] ReasoningStatus/ReasoningResponseItem.Status should be covered by the extensible-enum work (#1244/#1267) — non-official Responses API backends keep sending "status": null #1342

Closed

jsquire reviewed Aug 31, 2026

View reviewed changes

Comment thread codegen/generator/src/OpenAILibraryVisitor.cs

Copilot started work on behalf of joseharriaga August 31, 2026 18:16 View session

Remove unused status replacement field

3240586

Co-authored-by: joseharriaga <45773732+joseharriaga@users.noreply.github.com>

Copilot AI review requested due to automatic review settings August 31, 2026 18:18

Copilot started reviewing on behalf of joseharriaga August 31, 2026 18:19 View session

Copilot finished work on behalf of joseharriaga August 31, 2026 18:19

Copilot AI reviewed Aug 31, 2026

View reviewed changes

jsquire approved these changes Aug 31, 2026

View reviewed changes

joseharriaga mentioned this pull request Sep 1, 2026

Add support for custom tools in Responses #1340

Merged

Navigation Menu

Uh oh!

Fix the nullability of the `Status` property of Responses items - #1346

Fix the nullability of the `Status` property of Responses items#1346
joseharriaga wants to merge 7 commits into
mainfrom
joseharriaga/item-status

joseharriaga commented Aug 28, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

joseharriaga commented Aug 28, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants