Update openapi spec components by nezhyborets · Pull Request #423 · MacPaw/OpenAI

nezhyborets · 2026-05-22T22:15:56Z

What

Re-generate Components with the latest OpenAPI spec. Update manually maintained code to work with the new Components

Why

It hasn't been updated for a very long time. It could fix some issues and enable people to use newer APIs.

Details

Replaces the hand-maintained Components.swift with a version generated from the latest OpenAI OpenAPI spec (openapi.with-code-samples.yml) using openapi-generator + a custom extraction script (Scripts/extract_components.py).
Adds a Makefile target to automate future spec updates (make generate).
Updates all public facades and manual types (OutputItem, ResponseStreamEvent, Tool, CreateModelResponseQuery, ResponseObject, etc.) to align with the new schema.
Fixes streaming event handling: corrects the output_text.annotation.added event type mapping and removes the now-unnecessary fixMappingError workaround.
Makes WebSearchActionSearch.query and ResponseFunctionCallArgumentsDoneEvent.name optional to match what actually received from API

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Remove 32 invalid redeclarations: duplicate primitive typealiases (Bool/String/Int/Double = Swift.X) within the same struct scope, and six `typealias String = [Swift.String]` entries that shadowed Swift.String in CodingKeys raw type position, breaking compilation. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

- Rename reasoning event types: ResponseReasoningDelta/DoneEvent → ResponseReasoningTextDelta/DoneEvent; ResponseReasoningSummaryDelta/DoneEvent → ResponseReasoningSummaryTextDelta/DoneEvent - Reorder decoder chain to match new value indices (value29–50): new ReasoningText events inserted at 29/30 pushed Refusal, OutputText, WebSearch, ImageGen, MCP events down by 2; MCP call-arguments events moved from value40/41 to value42/43, freeing 40/41 for the two previously-missing ImageGen events - Add decoder entries for value40/41 (ImageGenCallInProgress/PartialImage) and value49 (MCPListToolsInProgress), which were absent in the old mapping - Update guard indices to match: value40/41 → value42/43, value49 → value51 - Update case comments to match spec wording Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Generated OutputItem changed from a OneOf struct (value1…value12) to a discriminated enum with named cases. Rewrite init(from:) to decode the generated enum and switch on its cases. Also adds the 13 new cases introduced in the spec: functionToolCallOutputResource, computerToolCallOutputResource, toolSearchCall, toolSearchOutput, compactionBody, localShellToolCallOutput, functionShellCall, functionShellCallOutput, applyPatchToolCall, applyPatchToolCallOutput, mcpApprovalResponseResource, customToolCall, customToolCallOutputResource. Updates existing comments to use absolute URLs and aligns wording with the spec descriptions. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

The generated type now has readable case names, making the facade unnecessary. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

- Rename Includable → IncludeEnum, TextPayload → ResponseTextParam, ToolChoicePayload → ToolChoiceParam - Replace LocalShellTool → LocalShellToolParam in Tool enum - Add new Tool cases: computer, computerUsePreview, webSearch, webSearchPreview, functionShell, custom, namespace, toolSearch, applyPatch - Drop Tool suffix from all enum case names Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

- Restore Tool suffix on all enum cases; rename codeInterpreter → codeInterpreterTool - Add required responseId param to ResponseAudioDoneEvent in test - Add logprobs:[] to mock SSE JSON for ResponseTextDeltaEvent (now required by spec) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Re-adds the OutputItem facade removed in the previous commit so that public call sites don't need to switch on Components.Schemas.OutputItem directly. The facade mirrors all 25 cases of the generated type and preserves the user-friendly names (reasoning, imageGenerationCall, localShellCall). Also removes the now-redundant ResponseStreamEvent.OutputItem typealias that pointed at the generated type. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

All discriminator blocks in the spec used propertyName values (e.g. 'type') whose enum strings don't match schema names, making explicit mapping required. Without it, strict OpenAPI tooling cannot resolve the correct schema from a discriminator value. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

This reverts commit 8efc593.

Adds `make generate` which runs swift-openapi-generator and then extracts the Components enum from the output into Components.swift, stripping typealias lines that shadow Swift built-in names and would cause invalid redeclaration build errors. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

query is deprecated and no longer sent by the API, causing keyNotFound decoding errors. Removed it from the required list in the spec. See openai/openai-openapi#544. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

The stream event type was incorrectly mapped to the underscore variant in ModelResponseStreamEventType; corrected to match the spec value response.output_text.annotation.added. fixMappingError() was doing the opposite transformation (dot→underscore) before decoding, which broke decoding after the generated enum was updated to use the spec's dot-separated value. Removed the function along with its call site; getPayloadType() is retained as it serves an unrelated fallback purpose. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

The API does not send name in response.function_call_arguments.done events, despite the spec marking it required. Removed it from required. See openai/openai-openapi#545. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Pull request overview

Copilot reviewed 21 out of 23 changed files in this pull request and generated 10 comments.

Comments suppressed due to low confidence (1)

Sources/OpenAI/Public/Schemas/Edited/Tool.swift:57

Tool.init(from:) uses a trial-and-error decode strategy (many do/try/catch attempts). With the newly added tool cases, this makes decoding increasingly expensive because most cases will fail before the correct one succeeds. Prefer decoding a lightweight discriminator first (e.g., _type / type) and then decoding exactly one concrete schema based on that value; this improves performance and keeps the implementation scalable as more tool variants are added.

    public init(from decoder: any Decoder) throws {
        var errors: [any Error] = []
        do {
            self = .fileSearchTool(try .init(from: decoder))
            return
        } catch {
            errors.append(error)
        }

Replaces the fragile try-catch chain with a type-first switch over ModelResponseStreamEventType, making every event type's handler explicit and compiler-enforced. Also removes the stale response.reasoning_summary.delta/done event types and the ReasoningSummaryEvent enum, which have no corresponding generated schema types and are absent from the current OpenAI API reference. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…ingStreamed overloads Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot

Pull request overview

Copilot reviewed 22 out of 24 changed files in this pull request and generated 3 comments.

Remove erroneous leading space from top-level keys and properly indent list items under paths: and schemas: so the config is unambiguously valid YAML. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Validate that exactly two arguments are passed before indexing sys.argv, so a missing argument produces a clear usage message instead of a bare IndexError. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot

Pull request overview

Copilot reviewed 22 out of 24 changed files in this pull request and generated 1 comment.

- Make text and toolChoice optional (spec marks both as optional) - Change status from String to typed Status? (Schemas.Response.Value3Payload.StatusPayload), adding cancelled and queued to the documented values - Change truncation from String? to typed Truncation? (Schemas.ResponseProperties.TruncationPayload), update doc comment to match current spec wording - Add model doc comment explaining why it stays as non-optional String rather than the spec's optional ModelIdsResponses enum - Deprecate user field, pointing to safetyIdentifier and promptCacheKey - Add 11 missing fields: background, completedAt, conversation, maxToolCalls, outputText, prompt, promptCacheKey, promptCacheRetention, safetyIdentifier, serviceTier, topLogprobs Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot

Pull request overview

Copilot reviewed 22 out of 24 changed files in this pull request and generated 2 comments.

Add ResponseObject+Mock.swift with a makeMock(output:tools:status:) helper following the pattern of other mock extensions. Update ResponsesEndpointTests to use it, removing the inline memberwise init and the private makeResponse helper. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

… tests Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot

Pull request overview

Copilot reviewed 25 out of 27 changed files in this pull request and generated 3 comments.

…ptional Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…params Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot

Pull request overview

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

nezhyborets and others added 20 commits May 15, 2026 20:27

Update Components.swift from new OpenAI OpenAPI spec

4dbb288

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Remove OutputItem facade, use Components.Schemas.OutputItem directly

1ee4241

The generated type now has readable case names, making the facade unnecessary. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Fix warnings

e79fa23

Fix Demo app build errors after OpenAPI spec update

626c712

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Prefix the print, may be too long when Base64

1036e64

Print error

d3ff152

Add spec and config

ddfd805

Revert "Add discriminator mappings missing from OpenAPI spec"

da7f88d

This reverts commit 8efc593.

Merge branch 'main' into update-openapi-spec-components

d280f5a

nezhyborets requested review from Krivoblotsky and Copilot May 22, 2026 22:15

Copilot started reviewing on behalf of nezhyborets May 22, 2026 22:16 View session

Copilot AI reviewed May 22, 2026

View reviewed changes

nezhyborets requested a review from Copilot May 22, 2026 22:22

Copilot started reviewing on behalf of nezhyborets May 22, 2026 22:22 View session

Copilot AI reviewed May 22, 2026

View reviewed changes

Krivoblotsky requested a review from Copilot May 23, 2026 08:31

Copilot started reviewing on behalf of Krivoblotsky May 23, 2026 08:32 View session

Copilot AI reviewed May 23, 2026

View reviewed changes

nezhyborets and others added 4 commits June 3, 2026 16:41

Use type discriminator in Tool.init(from:) instead of trial-and-error

19ef09c

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Add tests for response.output_text.annotation.added event dispatch

cf91050

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Extract shared apply helpers to remove duplication in updateMessageBe…

ceb230a

…ingStreamed overloads Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

nezhyborets requested a review from Copilot June 3, 2026 20:12

Copilot started reviewing on behalf of nezhyborets June 3, 2026 20:12 View session

Copilot AI reviewed Jun 3, 2026

View reviewed changes

Comment thread openapi-generator-config.yaml Outdated

Comment thread Scripts/extract_components.py

Comment thread Demo/DemoChat/Sources/ResponsesStore.swift

nezhyborets and others added 2 commits June 4, 2026 13:34

Fix YAML indentation in openapi-generator-config.yaml

b9b5bb0

Remove erroneous leading space from top-level keys and properly indent list items under paths: and schemas: so the config is unambiguously valid YAML. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Add argument count guard to extract_components.py

ae2f929

Validate that exactly two arguments are passed before indexing sys.argv, so a missing argument produces a clear usage message instead of a bare IndexError. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

nezhyborets requested a review from Copilot June 4, 2026 10:42

Copilot started reviewing on behalf of nezhyborets June 4, 2026 10:42 View session

Copilot AI reviewed Jun 4, 2026

View reviewed changes

Comment thread Sources/OpenAI/Public/Models/Responses API/ResponseObject.swift Outdated

nezhyborets requested a review from Copilot June 4, 2026 11:32

Copilot started reviewing on behalf of nezhyborets June 4, 2026 11:32 View session

Copilot AI reviewed Jun 4, 2026

View reviewed changes

Comment thread Sources/OpenAI/Public/Models/Responses API/ResponseObject.swift

Comment thread Sources/OpenAI/Public/Models/Responses API/ResponseObject.swift

nezhyborets and others added 3 commits June 4, 2026 19:14

Change createdAt to Double to match API spec number type

b82a938

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Fix double-optional IncompleteDetails and add ResponseObject decoding…

13a6bf5

… tests Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

nezhyborets requested a review from Copilot June 4, 2026 16:31

Copilot started reviewing on behalf of nezhyborets June 4, 2026 16:31 View session

Copilot AI reviewed Jun 4, 2026

View reviewed changes

Comment thread Sources/OpenAI/Public/Schemas/Facade/ResponseStreamEvent.swift

Comment thread Sources/OpenAI/Public/Models/Responses API/ResponseObject.swift Outdated

Comment thread Tests/OpenAITests/MockServerSentEvent.swift Outdated

nezhyborets mentioned this pull request Jun 4, 2026

ResponseStreamEvent: Codable conformance is asymmetric #427

Open

nezhyborets and others added 2 commits June 4, 2026 19:47

Fix usage doc comment: remove outdated rationale, spec now marks it o…

c5b3b2b

…ptional Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Use JSONSerialization in responseStreamEvent to safely escape string …

124eb1d

…params Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

nezhyborets requested a review from Copilot June 4, 2026 16:52

Copilot started reviewing on behalf of nezhyborets June 4, 2026 16:52 View session

Copilot AI reviewed Jun 4, 2026

View reviewed changes

Conversation

nezhyborets commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Why

Details

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

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!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

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!

2 participants

nezhyborets commented May 22, 2026 •

edited

Loading