Add typed metadata property builder - #964
Open
YuqiGuo105 wants to merge 1 commit into
Open
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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