Repository navigation
Add typed metadata property builder - #964
YuqiGuo105 wants to merge 1 commit into
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
sylvesterkaczmarek
left a comment
There was a problem hiding this comment.
This is a useful API-level narrowing over the raw additional-properties escape hatch. The helper guarantees metadata values are serialized as JSON strings, which matches the service contract and avoids callers accidentally sending numeric JSON for numeric-looking IDs. Mirroring it in both stable and beta response params keeps the two surfaces consistent.
|
Thanks, @YuqiGuo105, for proposing the typed metadata helper and adding regression coverage. The We've closed #338 as completed. Closing this PR as superseded by the released implementation. Thank you for helping improve the SDK! |
Summary
Metadata.Builder.putProperty(String, String)helper for ResponsesputAdditionalProperty(String, JsonValue)as the escape hatch for undocumented valuesMotivation
The API only accepts string values for metadata, but the existing builder exposes only the raw
JsonValuemethod. This allows values such as JSON numbers to compile and fail later with a 400 response. The typed helper provides a straightforward, API-aligned path while keeping the existing low-level method backward compatible.Testing
ResponseCreateParamsTesttests:openai-java-core:lintKotlinCloses #338