fix: omit status field when empty by parthea · Pull Request #2654 · googleapis/librarian

parthea · 2025-10-22T19:39:06Z

This PR omits that status field when it is empty. The status field is always empty in generate-request.json, so this change ensures that generate-request.json no longer contains the status field. This aligns with what we have in the docs: https://github.com/googleapis/librarian/blob/main/doc/language-onboarding.md

We only need the status field in configure-request.json, and the value is expected to be either new or existing as per the above docs.

gemini-code-assist · 2025-10-22T19:39:21Z

Summary of Changes

Hello @parthea, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refines the JSON serialization behavior for the API struct by introducing the omitempty tag to its status field. The primary goal is to prevent the inclusion of an empty status field in generated JSON outputs, specifically generate-request.json, thereby ensuring consistency with existing documentation that indicates this field is only relevant for configure-request.json and should contain specific values. The change is validated with a new unit test and associated test data.

Highlights

JSON Serialization: The status field in the API struct now uses the omitempty JSON tag, ensuring it is not serialized into JSON output when its value is empty.
Documentation Alignment: This change prevents the status field from appearing in generate-request.json files, aligning the output with existing documentation that specifies its usage.
New Test Case: A new test case has been added to internal/docker/docker_test.go to validate the correct omission of the empty status field during JSON marshaling.
Test Data: A corresponding test data file (omit-empty-status.json) was introduced to reflect the expected JSON output without the empty status field.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request modifies the API struct in internal/config/state.go to omit the status field when it's empty during JSON serialization. Additionally, a new test case is added to internal/docker/docker_test.go to verify this behavior. The changes align with the documentation, ensuring that the status field is only present in configure-request.json and not in generate-request.json when empty.

internal/config/state.go

internal/docker/docker_test.go

codecov · 2025-10-22T19:42:26Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.41%. Comparing base (5874c47) to head (99262b4).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2654      +/-   ##
==========================================
+ Coverage   85.66%   87.41%   +1.75%     
==========================================
  Files         108      108              
  Lines       11146     9498    -1648     
==========================================
- Hits         9548     8303    -1245     
+ Misses       1260      853     -407     
- Partials      338      342       +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

internal/docker/docker_test.go

PR created by the Librarian CLI to initialize a release. Merging this PR will auto trigger a release. Librarian Version: not available Language Image: us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/librarian-release-container:latest <details><summary>librarian: 1.0.0</summary> ## [1.0.0](v0.5.0...v1.0.0) (2025-11-06) ### Features * Remove `..._gax` dependency (#2713) ([01675b7](01675b72)) * add context to Librarian PRs (#2698) ([0523329](0523329a)) * add a package comment linter (#2712) ([1bd3e32](1bd3e32e)) * generate pom.xml files (#2682) ([50b95f2](50b95f20)) * add test-container test logic (#2656) ([514cf7e](514cf7e5)) * improve rust-publish logging (#2671) ([585ed50](585ed50b)) * write a timing log at the end of update-image (#2771) ([5fc9e3b](5fc9e3b6)) * migrate Java container from sdk-platform-java (#2670) ([69ac47f](69ac47fd)) * switch to original head after running update-image (#2696) ([7a3e404](7a3e404a)) * format bulk commit from other sources in release notes (#2665) ([7c52da2](7c52da2b)) * enable multi-version API generation (#2699) ([86c5250](86c52507)) * release stage to update pom.xml files (#2772) ([be56755](be567550)) * use proto presence info to generate null-safe code (#2726) ([e36fb81](e36fb81a)) * Base messages in google_cloud_protobuf (#2660) ([e607ea6](e607ea63)) ### Bug Fixes * retry Github 503 requests up to 3 times (#2650) ([09468fa](09468faf)) * Changed docs to ConfigurationException (#2697) ([0950c1e](0950c1e3)) * fix the reference to the old "librariangen" folder (#2677) ([09dc53f](09dc53fe)) * run godoclint via golangci-lint (#2751) ([264a6a0](264a6a0e)) * pass context as the first argument (#2769) ([298a3bd](298a3bd8)) * Move HTTP client creation to `_gax` (#2672) ([4968d63](4968d63d)) * deduplicate bulk commits (#2758) ([4dfae9a](4dfae9ae)) * Support additional api paths for an existing library (#2666) ([50046f5](50046f55)) * remove stray TODO (#2748) ([5072f0e](5072f0e0)) * omit status field when empty (#2654) ([572ae4f](572ae4f3)) * use T.Context in tests (#2768) ([7e7cd2d](7e7cd2dd)) * wrap error to provide more context for commitAndPush (#2767) ([a2a41a4](a2a41a4a)) * use t.Fatal in tests for proper failure handling (#2759) ([cdabb28](cdabb287)) * enforce removal before copying library files (#2765) ([d5ac6c8](d5ac6c87)) * change log level to debug (#2798) ([f042d0b](f042d0bd)) * change path to `doc.go` in docgen test (#2700) ([fd6bae4](fd6bae40)) ### Documentation * use consistent library id in flags and examples (#2770) ([87a1005](87a10056)) </details>

)

fix: omit status field when empty

bcaf3c0

parthea requested a review from a team as a code owner October 22, 2025 19:39

gemini-code-assist bot reviewed Oct 22, 2025

View reviewed changes

internal/config/state.go Show resolved Hide resolved

internal/docker/docker_test.go Show resolved Hide resolved

codyoss reviewed Oct 23, 2025

View reviewed changes

internal/docker/docker_test.go Outdated Show resolved Hide resolved

codyoss previously approved these changes Oct 23, 2025

View reviewed changes

omit empty value

99262b4

parthea dismissed codyoss’s stale review via 99262b4 October 24, 2025 12:35

parthea assigned codyoss Oct 24, 2025

codyoss approved these changes Oct 27, 2025

View reviewed changes

parthea merged commit 572ae4f into main Oct 27, 2025
8 checks passed

parthea deleted the omit-empty branch October 27, 2025 14:55

cloud-sdk-librarian-robot mentioned this pull request Nov 6, 2025

chore: librarian release pull request: 20251106T080249Z #2805

Closed

ldetmer mentioned this pull request Nov 6, 2025

chore: librarian release pull request: 20251106T145301Z #2808

Merged

zhumin8 pushed a commit to zhumin8/librarian that referenced this pull request Nov 17, 2025

cleanup(storage): hide generated implementation details (googleapis#2654

262223c

)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: omit status field when empty#2654

fix: omit status field when empty#2654
parthea merged 2 commits intomainfrom
omit-empty

parthea commented Oct 22, 2025 •

edited

Loading

Uh oh!

gemini-code-assist bot commented Oct 22, 2025

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Oct 22, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

parthea commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist bot commented Oct 22, 2025

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

parthea commented Oct 22, 2025 •

edited

Loading

codecov bot commented Oct 22, 2025 •

edited

Loading