Skip to content

chore(api): correct fine-tuning bounds and Realtime response reference - #752

Merged
markstuart-oai merged 1 commit into
mainfrom
castiron/promotions/pr-149
Sep 23, 2026
Merged

markstuart-oai merged 1 commit into
mainfrom
castiron/promotions/pr-149

Conversation

@markstuart-oai

@markstuart-oai markstuart-oai commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Corrects fine-tuning numeric bounds and Realtime client-secret response alternatives in the Ruby API reference.

Changes

  • Use OpenAPI 3.1 numeric exclusive bounds for fine-tuning parameters.
  • Identify realtime and transcription session alternatives in client-secret responses.

Why

The API reference used boolean exclusiveMinimum values, which are invalid in OpenAPI 3.1. This corrects seven numeric lower bounds and restores their existing auto defaults. Explicit discriminator mappings also identify the existing realtime and transcription alternatives in client-secret responses.

This is a reference-only correction: SDK source, public types, dependencies, and request/response serialization are unchanged.

Source: published OpenAPI correction.

Compatibility review

Reviewed head a34849d6459f3d50765eca417a81c243aea4cf57 against base c7047782ff2ae38a859a08ef199e67a79c16b9fe.

  • The complete tree diff contains only .castiron.stats.yml and api_reference/openapi.transformed.yml. All SDK source, public signatures, related model types, serializers, dependencies, and package/build configuration are unchanged. Neither changed file is consumed by the SDK runtime or enters its normal distributed code.
  • Paired baseline/candidate Ruby request serialization and model-coercion probes pass (51 cases per revision, identical results).
  • The transformed reference passes 464 focused schema cases, including actual enclosing requests/responses, lower/upper boundaries, auto, omission, and both Realtime response variants.
  • Current-head CI passes.

Scope: this establishes no identified SDK-package compile-time or runtime compatibility regression from this patch. Tools that directly read the OpenAPI reference (validators, mock servers, or third-party generators) can observe the corrected bounds, defaults, and explicit mappings; those integrations are a separate compatibility surface. No deployed-service test or package release is claimed.

Castiron-Internal-PR: openai/openai-ruby-internal#149
Castiron-Source-SHA: de28e463384ba1c1b67753497d2f35ee1f9e0adb
Castiron-Public-Base-SHA: c704778
@github-actions

github-actions Bot commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

70 mixed files remain; 0 existing customizations changed.

Compared c7047782ff2a → a34849d6459f. Generated baselines verified.

70 existing customizations unchanged
  • lib/openai.rb
  • lib/openai/client.rb
  • lib/openai/models/audio/transcription_create_response.rb
  • lib/openai/models/beta/agents/vault_status_filter.rb
  • lib/openai/models/chat/chat_completion_message.rb
  • lib/openai/models/chat/chat_completion_message_function_tool_call.rb
  • lib/openai/models/chat/completion_create_params.rb
  • lib/openai/models/image_edit_completed_event.rb
  • lib/openai/models/image_edit_partial_image_event.rb
  • lib/openai/models/image_gen_completed_event.rb
  • lib/openai/models/image_gen_partial_image_event.rb
  • lib/openai/models/images_response.rb
  • lib/openai/models/response_format_json_schema.rb
  • lib/openai/models/responses/function_tool.rb
  • lib/openai/models/responses/response.rb
  • lib/openai/models/responses/response_create_params.rb
  • lib/openai/models/responses/response_format_text_config.rb
  • lib/openai/models/responses/response_format_text_json_schema_config.rb
  • lib/openai/models/responses/response_function_tool_call.rb
  • lib/openai/models/responses/response_function_web_search.rb
  • lib/openai/models/responses/response_output_text.rb
  • lib/openai/models/responses/tool.rb
  • lib/openai/models/webhooks/webhook_endpoint_with_secret.rb
  • lib/openai/resources/beta/agents/sessions.rb
  • lib/openai/resources/beta/threads.rb
  • lib/openai/resources/chat/completions.rb
  • lib/openai/resources/containers/files.rb
  • lib/openai/resources/files.rb
  • lib/openai/resources/responses.rb
  • lib/openai/resources/vector_stores/file_batches.rb
  • lib/openai/resources/vector_stores/files.rb
  • lib/openai/resources/webhooks.rb
  • rbi/openai/client.rbi
  • rbi/openai/models/beta/agents/vault_status_filter.rbi
  • rbi/openai/models/chat/chat_completion_message.rbi
  • rbi/openai/models/chat/chat_completion_message_function_tool_call.rbi
  • rbi/openai/models/chat/completion_create_params.rbi
  • rbi/openai/models/image_edit_completed_event.rbi
  • rbi/openai/models/image_edit_partial_image_event.rbi
  • rbi/openai/models/image_gen_completed_event.rbi

30 more in the full report.

A changed generated baseline means this report cannot reliably identify which handwritten lines changed.

Inspect the custom-code diff

Download the exact patch produced by this run (requires repository access):

gh run download 35923951363 --repo openai/openai-ruby \
  --name castiron-custom-code-35923951363-1 --dir /tmp/castiron-custom-code-35923951363-1
git apply --stat /tmp/castiron-custom-code-35923951363-1/custom-code.patch
cat /tmp/castiron-custom-code-35923951363-1/custom-code.patch

Or reproduce it from an SDK checkout containing the vendored reporter:

git fetch --no-tags origin c7047782ff2ae38a859a08ef199e67a79c16b9fe a34849d6459f3d50765eca417a81c243aea4cf57
python3 scripts/castiron/custom_code_report.py report \
  --base c7047782ff2ae38a859a08ef199e67a79c16b9fe \
  --head a34849d6459f3d50765eca417a81c243aea4cf57 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-a34849d6459f
cat /tmp/castiron-custom-code-a34849d6459f/custom-code.patch

This is the current full custom patch for mixed files, not an attribution of only the handwritten lines changed by this PR.

Full report and patch

@markstuart-oai
markstuart-oai marked this pull request as ready for review September 23, 2026 21:40
@markstuart-oai
markstuart-oai requested a review from a team as a code owner September 23, 2026 21:40
@openai-sdks

openai-sdks Bot commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

OkTest Summary

✅ 236/236 SDK tests passed in 10.589s for Ruby SDK PR #752.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 236ms
tests/chat-completions-create.test.ts ✅ Passed 357ms
tests/chat-completions-stream.test.ts ✅ Passed 147ms
tests/files-content-binary.test.ts ✅ Passed 197ms
tests/files-create-multipart.test.ts ✅ Passed 176ms
tests/files-list-pagination.test.ts ✅ Passed 174ms
tests/initialize-config.test.ts ✅ Passed 235ms
tests/instance-isolation.test.ts ✅ Passed 241ms
tests/models-list.test.ts ✅ Passed 248ms
tests/responses-background-lifecycle.test.ts ✅ Passed 318ms
tests/responses-body-method-errors.test.ts ✅ Passed 547ms
tests/responses-cancel-timeout.test.ts ✅ Passed 297ms
tests/responses-cancel.test.ts ✅ Passed 304ms
tests/responses-compact-retries.test.ts ✅ Passed 362ms
tests/responses-compact.test.ts ✅ Passed 266ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 270ms
tests/responses-create-advanced.test.ts ✅ Passed 247ms
tests/responses-create-disconnect.test.ts ✅ Passed 151ms
tests/responses-create-errors.test.ts ✅ Passed 292ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 138ms
tests/responses-create-retries.test.ts ✅ Passed 206ms
tests/responses-create-stream-failures.test.ts ✅ Passed 135ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 224ms
tests/responses-create-stream-wire.test.ts ✅ Passed 2.046s
tests/responses-create-stream.test.ts ✅ Passed 209ms
tests/responses-create-terminal-states.test.ts ✅ Passed 390ms
tests/responses-create-timeout.test.ts ✅ Passed 279ms
tests/responses-create.test.ts ✅ Passed 317ms
tests/responses-delete.test.ts ✅ Passed 275ms
tests/responses-input-items-errors.test.ts ✅ Passed 189ms
tests/responses-input-items-list.test.ts ✅ Passed 207ms
tests/responses-input-items-options.test.ts ✅ Passed 190ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 366ms
tests/responses-input-tokens-count.test.ts ✅ Passed 239ms
tests/responses-malformed-inputs.test.ts ✅ Passed 2.278s
tests/responses-not-found-errors.test.ts ✅ Passed 374ms
tests/responses-parse.test.ts ✅ Passed 277ms
tests/responses-retrieve-retries.test.ts ✅ Passed 360ms
tests/responses-retrieve.test.ts ✅ Passed 296ms
tests/responses-stored-method-errors.test.ts ✅ Passed 1.001s
tests/retry-behavior.test.ts ✅ Passed 3.6s
tests/sdk-error-shape.test.ts ✅ Passed 450ms

View OkTest run #35923882590

SDK merge (f834f4cb103e) · head (a34849d6459f) · base (c7047782ff2a) · OkTest (a0be4375e02d)

@jbeckwith-oai jbeckwith-oai 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.

Reviewed exact head a34849d6459f3d50765eca417a81c243aea4cf57: no actionable findings.

Independently validated the complete two-file diff and 94 schema assertions: all seven numeric-bound/default corrections match the published OpenAPI source at 946e365dd69d52ccfe49fd0a9e565504aef517bd; boundary values, auto, invalid types, omission, and retained upper limits behave correctly. Both Realtime discriminator mappings resolve to the matching required type variants. Whole-document comparison found only those intended schema changes, and the transformed-schema hash matches the generation stats.

The SDK implementation, public language types, dependencies, and serialization code are unchanged. Raw-schema consumers do observe the intended validation/default/discriminator correction. Hosted checks were successful or conditionally skipped when checked; I did not rerun the author's language-specific compatibility suites locally.

@markstuart-oai
markstuart-oai added this pull request to the merge queue Sep 23, 2026
Merged via the queue into main with commit 4c1cd58 Sep 23, 2026
26 checks passed
@markstuart-oai
markstuart-oai deleted the castiron/promotions/pr-149 branch September 23, 2026 21:57
@openai-sdks openai-sdks Bot mentioned this pull request Sep 23, 2026
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