feat(api): add vault metadata and clarify web search locations

[marcuswood-oai]

Summary

Adds vault credential metadata to credential results and create/update requests, including metadata-only updates. Clarifies web search location defaults.

Changes

• Add string-keyed metadata to vault credential results and create/update parameters.
• Allow credential updates with metadata without requiring replacement authentication values.
• Explain that omitted or null web search user locations default to the United States.
• Describe how an approximate location without location fields avoids the fallback, and how location fields localize results.

[github-actions]

Castiron custom code

✅ No new custom-code files detected.

70 mixed files remain; 0 existing customizations changed.

Compared c7047782ff2a → 0562e9852ae1. 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 35923531559 --repo openai/openai-ruby \
  --name castiron-custom-code-35923531559-1 --dir /tmp/castiron-custom-code-35923531559-1
git apply --stat /tmp/castiron-custom-code-35923531559-1/custom-code.patch
cat /tmp/castiron-custom-code-35923531559-1/custom-code.patch

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

git fetch --no-tags origin c7047782ff2ae38a859a08ef199e67a79c16b9fe 0562e9852ae1507ecaf3feb68a04a1e21b781873
python3 scripts/castiron/custom_code_report.py report \
  --base c7047782ff2ae38a859a08ef199e67a79c16b9fe \
  --head 0562e9852ae1507ecaf3feb68a04a1e21b781873 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-0562e9852ae1
cat /tmp/castiron-custom-code-0562e9852ae1/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

[jbeckwith-oai]

Reviewed at 0562e98. No actionable findings.

Reviewed the credential models/resource surface, RBI/RBS consistency, optional update auth, required response metadata, generated fixtures, and documentation-only web-search changes. The required response-metadata/model-construction change is the explicitly documented public-beta contract change, not an accidental omission.

Validation: 40 independent assertions against this head's actual transformed schema passed, including metadata key/value/count bounds and metadata-only, empty-map clearing, auth-only, and combined updates. Verified the complete semantic schema delta and generation hash. Exact-head hosted build/lint/test checks are green (conditional jobs are skipped). I did not rerun the full SDK suite locally.

[marcuswood-oai]

Closing this broader update. A separate update will contain only the web-search approximate-location documentation changes.