fix(generator): use json_name when available by diegomarquezp · Pull Request #12940 · googleapis/google-cloud-java

diegomarquezp · 2026-04-27T16:12:36Z

b/505851871

gemini-code-assist

Code Review

This pull request introduces support for the json_name protobuf option within the GAPIC generator for Java REST clients, ensuring that HTTP query parameters correctly use custom JSON names, such as those in kebab-case. The changes involve updating the Field and HttpBinding models to store the JSON name and modifying the HttpRuleParser to extract and propagate this information. Review feedback highlights that certain ternary checks for jsonName are redundant because the protobuf descriptor provides a default value, and suggests using the diamond operator for ArrayList instantiation to avoid raw types.

I am having trouble creating individual review comments. Click here to see my feedback.

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/rest/HttpJsonServiceStubClassComposer.java (929-931)

The fieldDescriptor.getJsonName() method (used in Parser.java to populate the Field model) always returns a non-empty string, as it defaults to the lower-camel-case version of the field name if the json_name option is not explicitly set in the proto. Consequently, httpBindingFieldName.jsonName() is unlikely to be null here, making this ternary operation and the fallback to JavaStyle.toLowerCamelCase redundant. If the intention is to use the generator's custom camel-casing logic for fields without an explicit json_name, the parser should be updated to only set jsonName when the option is present.

References

Avoid adding defensive null checks for values that are guaranteed to be non-null by design, as this can hide invariant breaks.

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/protoparser/HttpRuleParser.java (150)

Avoid using raw types. Use the diamond operator <> for the ArrayList instantiation.

      List<String> jsonNameParts = new ArrayList<>();

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/protoparser/HttpRuleParser.java (163-166)

As noted in other files, field.jsonName() is expected to be non-null and non-empty because it is populated from fieldDescriptor.getJsonName(), which provides a default camel-case name if the json_name option is missing. This ternary check and the fallback to JavaStyle.toLowerCamelCase appear to be unreachable code under the current parsing logic.

References

Avoid adding defensive null checks for values that are guaranteed to be non-null by design, as this can hide invariant breaks.

blakeli0

Pending discussion of b/505851871#comment4

diegomarquezp · 2026-04-29T18:20:33Z

@@ -132,6 +134,8 @@ public class HttpJsonComplianceStub extends ComplianceStub {
                            Map<String, List<String>> fields = new HashMap<>();
                            ProtoRestSerializer<RepeatRequest> serializer =
                                ProtoRestSerializer.create();
+                            serializer.putQueryParam(


let's test with biglake directly and confirm that the response conforms to json_name

diegomarquezp · 2026-04-30T15:26:37Z

Here we can observe the affected query, path and body parameters using the json_name value.

…ud-java into biglake-p1

sonarqubecloud · 2026-04-30T15:46:43Z

Quality Gate failed for 'gapic-generator-java-root'

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

sonarqubecloud · 2026-04-30T15:48:19Z

Quality Gate passed for 'gapic-generator-java-root'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

blakeli0

Thanks Diego! As a follow up, can we create an issue in showcase to support json_name?

diegomarquezp · 2026-04-30T21:24:27Z

Thanks Diego! As a follow up, can we create an issue in showcase to support json_name?

Sure, created #12972

🤖 I have created a release *beep* *boop* --- <details><summary>1.86.0</summary> ## [1.86.0](v1.85.0...v1.86.0) (2026-05-05) ### Features * [aiplatform] Add asyncQueryReasoningEngine to aiplatform v1 API ([a1ab487](a1ab487)) * [aiplatform] Add asyncQueryReasoningEngine to aiplatform v1beta1 ([a1ab487](a1ab487)) * [aiplatform] add OnlineEvaluator API and update Evaluation API ([a1ab487](a1ab487)) * [aiplatform] Model Registry CopyModel BYOSA ([531942b](531942b)) * [aiplatform] new field CopyModelRequest.custome_service_account ([531942b](531942b)) * [aiplatform] Support VeoLoraTuningSpec in the tuning jobs ([a1ab487](a1ab487)) * [analytics-admin] add UserProvidedDataSettings resource and ([a1ab487](a1ab487)) * [bigqueryreservation] add principal field to BigQuery Reservation ([531942b](531942b)) * [ces] Add ability to specify mocked tool responses in ExecuteTool ([a1ab487](a1ab487)) * [chat] Addition of ChatService.FindGroupChats ([a1ab487](a1ab487)) * [compute] Update Compute Engine v1 API to revision 20260331 ([d3b76d9](d3b76d9)) * [health] new module for health ([#12993](#12993)) ([d568a8c](d568a8c)) * [iam] new iam v3beta client for AccessPolicies, this is step 4&5 ([a1ab487](a1ab487)) * [mapmanagement] new module for mapmanagement ([#12874](#12874)) ([0720279](0720279)) * [modelarmor] add streaming methods StreamSanitizeUserPrompt and ([a1ab487](a1ab487)) * [netapp] add ScaleType for Storage Pools and LargeCapacityConfig ([a1ab487](a1ab487)) * [redis-cluster] [Memorystore for Redis Cluster] Updating new node ([d3b76d9](d3b76d9)) * [redis-cluster][Memorystore for Redis Cluster] Updating new node ([d3b76d9](d3b76d9)) * [shopping-merchant-products] a new optional field `video_links` is ([a1ab487](a1ab487)) * [shopping-merchant-reports] add `store_type` to ([d3b76d9](d3b76d9)) * [valkey] [Memorystore for Valkey] Updating new node types added ([d3b76d9](d3b76d9)) * [valkey] [Memorystore for Valkey] Updating new node types added ([d3b76d9](d3b76d9)) * [vectorsearch] Added CMEK support ([531942b](531942b)) * **bqjdbc:** Bypass dry-run job for read-only tokens. ([#12961](#12961)) ([cd57169](cd57169)) * **bqjdbc:** Integrate the PerConnectionFileHandler with BigQueryJdbcRootLogger ([#12933](#12933)) ([2e56184](2e56184)) * **bqjdbc:** Per connection logs - Add BigQueryJdbcMdc ([#12833](#12833)) ([f562667](f562667)) * **bqjdbc:** Per connection logs - Add PerConnectionFileHandler ([#12899](#12899)) ([5846197](5846197)) * **datastore:** Bump to v3 major version ([#12989](#12989)) ([df20994](df20994)) * **datastore:** Enable Otel metrics for custom Otel ([#12969](#12969)) ([1721e7c](1721e7c)) * **Datastore:** Introduce Client Side Metrics ([#12718](#12718)) ([552a34d](552a34d)) * **datastore:** Remove deprecated classes and methods and bump ObsoleteApi to Deprecated ([#12971](#12971)) ([0bca75c](0bca75c)) * **Datastore:** Swap the default transport from HttpJson to gRPC ([#12977](#12977)) ([24fb234](24fb234)) * **datastore:** Update default channel pool configs to handle initial bursts and scalability ([#12883](#12883)) ([26fe0f9](26fe0f9)) * **gax-grpc:** add configurable resize delta and warning for repeated resizing ([#12838](#12838)) ([2caf026](2caf026)) * **spanner:** add connection properties for min/max RPCs for DCP ([#12951](#12951)) ([dc1216e](dc1216e)) * **spanner:** add connection property for enabling/disabling grpc-gcp ([#12898](#12898)) ([1e633d7](1e633d7)) * **spanner:** add shared endpoint cooldowns for location-aware rerouting ([#12845](#12845)) ([f5f273b](f5f273b)) * **spanner:** Cleanup GcpFallbackChannel creation and enable by default ([#12707](#12707)) ([5251219](5251219)) * **storage:** Implement deleteSourceObjects for Compose Operation ([#12873](#12873)) ([2cecd0c](2cecd0c)) ### Bug Fixes * **bq:** do not call 'getQueryResults' for stateful queries via 'query' api ([#12999](#12999)) ([44e9789](44e9789)) * **bqjdbc:** add default OAuth client id/secret ([#12946](#12946)) ([9b5c4fa](9b5c4fa)) * **bqjdbc:** add Google Driver scope to all credential types ([#12847](#12847)) ([5c890f8](5c890f8)) * **bqjdbc:** enhance logging with caller inference and explicit exception tracking ([#12903](#12903)) ([ce4969b](ce4969b)) * **bqjdbc:** Log exception messages - part 2 ([#12907](#12907)) ([5215b11](5215b11)) * **bqjdbc:** Log exception messages - part 3 ([#12920](#12920)) ([45b572f](45b572f)) * **bqjdbc:** metadata methods & getSqlTypeName for struct ([#12947](#12947)) ([37555fb](37555fb)) * **bqjdbc:** optimize formatter in BigQueryJdbcRootLogger ([#12877](#12877)) ([4233faf](4233faf)) * **bqjdbc:** Revert DatabaseMetaData field to be non-static in BigQueryConnection ([#12778](#12778)) ([ac69c8d](ac69c8d)) * **bqjdbc:** support Service Account Impersonation in ADC ([#12967](#12967)) ([8ce183c](8ce183c)) * bump vectorsearch to 0.13.0 for partial release ([#12805](#12805)) ([5208fc9](5208fc9)) * **ci:** update java-showcase path in excluded_modules ([#12984](#12984)) ([3456ee9](3456ee9)) * correct build directory paths in graalvm cloudbuild.yaml ([#12794](#12794)) ([8e6ba36](8e6ba36)) * **datastore:** Create a plaintext gRPC transport channel when using the Emulator ([#12721](#12721)) ([4bed8fd](4bed8fd)) * **datastore:** Update initial ChannelPool configs according to Datastore best practice guide ([#12919](#12919)) ([851fb89](851fb89)) * **deps:** update the Java code generator (gapic-generator-java) to ([531942b](531942b)) * do not generate Version.java files by default ([#12955](#12955)) ([43a888a](43a888a)) * **gax:** record fractional latency metrics ([#12979](#12979)) ([d690333](d690333)) * **gax:** Remove strict validation that resize delta must be less than max channel count ([#12863](#12863)) ([26b06f9](26b06f9)) * **generator:** use json_name when available ([#12940](#12940)) ([622955b](622955b)) * manual preservation of Version.java files ([#12862](#12862)) ([3d65c78](3d65c78)) * remove google/rpc exclusion to generate HttpResponse ([#12992](#12992)) ([24b1719](24b1719)) * **spanner:** fix flakiness and race conditions in multiplexed session tests ([#12949](#12949)) ([3e02f18](3e02f18)) * **spanner:** fix flakiness in testCreateSessionDeadlineExceeded ([#12944](#12944)) ([93f21ed](93f21ed)) * Update renovate config check template to use npx ([#12865](#12865)) ([b974740](b974740)) * use org.junit.jupiter.api.Assertions.assertThrow ([#12882](#12882)) ([bf243a6](bf243a6)) ### Performance Improvements * **spanner:** use StringBuilder for generating RequestId ([#12809](#12809)) ([5c821a3](5c821a3)) ### Dependencies * upgrade opentelemetry ([#12953](#12953)) ([522e05b](522e05b)) ### Documentation * [cloudsecuritycompliance] Updated docs for the APIs ([a1ab487](a1ab487)) * [kms] Update the comment for duration value ([a1ab487](a1ab487)) * [saasservicemgmt] rebrand from "SaaS Runtime" to "App Lifecycle ([a1ab487](a1ab487)) * Add a guide on configuring ChannelPools for gRPC ([#12905](#12905)) ([ea081fe](ea081fe)) * update bazel targets in DEVELOPMENT.md to point to sdk-platform-java ([#12844](#12844)) ([4568284](4568284)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> Co-authored-by: Jin Seop Kim <jinseop@google.com>

diegomarquezp added 2 commits April 27, 2026 11:56

fix(generator): use json_name when available

81dd15f

fix: remove unnecessary null check

78c5a45

gemini-code-assist Bot reviewed Apr 27, 2026

View reviewed changes

diegomarquezp added 5 commits April 27, 2026 12:37

chore: cleanup

4ec4743

chore: format

821cec4

test: retore missing test

0967e2c

fix: use jupiter assertion

2c7cd12

fix: use fallback in stub composer

aa4005b

diegomarquezp marked this pull request as ready for review April 27, 2026 20:55

diegomarquezp requested a review from a team as a code owner April 27, 2026 20:55

blakeli0 requested changes Apr 27, 2026

View reviewed changes

diegomarquezp commented Apr 29, 2026

View reviewed changes

Comment thread ...main/java/com/google/api/generator/gapic/composer/rest/HttpJsonServiceStubClassComposer.java

diegomarquezp commented Apr 29, 2026

View reviewed changes

Comment thread sdk-platform-java/gapic-generator-java/src/test/proto/compliance.proto

diegomarquezp commented Apr 29, 2026

View reviewed changes

Comment thread ...test/java/com/google/api/generator/gapic/composer/rest/goldens/HttpJsonComplianceStub.golden

diegomarquezp commented Apr 29, 2026

View reviewed changes

diegomarquezp added 4 commits April 29, 2026 15:13

chore: ignore ide files

b1ed1a8

fix: include json_name consideration for body and path params

ed9d0a9

docs: explain that response parsing considers json_name

a9fcffc

chore: format

1c31d3d

diegomarquezp mentioned this pull request Apr 30, 2026

demo: regenerated biglake client library #12968

Closed

Merge branch 'main' into biglake-p1

9557026

diegomarquezp commented Apr 30, 2026

View reviewed changes

diegomarquezp added 2 commits April 30, 2026 11:31

docs: improve comment about "case_"

76bc472

Merge branch 'biglake-p1' of https://github.com/googleapis/google-clo…

da69029

…ud-java into biglake-p1

blakeli0 approved these changes Apr 30, 2026

View reviewed changes

diegomarquezp mentioned this pull request Apr 30, 2026

Showcase should test the json_name proto annotation #12972

Open

diegomarquezp merged commit 622955b into main Apr 30, 2026
251 of 255 checks passed

diegomarquezp deleted the biglake-p1 branch April 30, 2026 21:24

This was referenced May 5, 2026

chore(main): release 1.86.0 #13013

Closed

chore(main): release 1.86.0 #13015

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(generator): use json_name when available#12940

fix(generator): use json_name when available#12940
diegomarquezp merged 14 commits intomainfrom
biglake-p1

diegomarquezp commented Apr 27, 2026 •

edited

Loading

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

blakeli0 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

diegomarquezp Apr 29, 2026

Uh oh!

diegomarquezp Apr 30, 2026

Uh oh!

diegomarquezp Apr 30, 2026

Uh oh!

sonarqubecloud Bot commented Apr 30, 2026

Uh oh!

sonarqubecloud Bot commented Apr 30, 2026

Uh oh!

blakeli0 left a comment

Uh oh!

diegomarquezp commented Apr 30, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

diegomarquezp commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/rest/HttpJsonServiceStubClassComposer.java (929-931)

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/protoparser/HttpRuleParser.java (150)

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/protoparser/HttpRuleParser.java (163-166)

Uh oh!

blakeli0 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

diegomarquezp Apr 29, 2026

Choose a reason for hiding this comment

Uh oh!

diegomarquezp Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

diegomarquezp Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Apr 30, 2026

Quality Gate failed for 'gapic-generator-java-root'

Uh oh!

sonarqubecloud Bot commented Apr 30, 2026

Quality Gate passed for 'gapic-generator-java-root'

Uh oh!

blakeli0 left a comment

Choose a reason for hiding this comment

Uh oh!

diegomarquezp commented Apr 30, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

diegomarquezp commented Apr 27, 2026 •

edited

Loading