Repository navigation
fix(sidekick/swift): note Discovery LRO return type - #7763
Merged
Merged
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the Swift templates (client_protocol.gotmpl and service.swift.gotmpl) to include a documentation note for Discovery-based long-running operations (LROs), clarifying that they return the terminal status object rather than the resulting resource. It also adds a comprehensive unit test, TestGenerateService_DiscoveryLRODocComments, to verify that these notes are correctly generated in both the method and protocol documentation. There are no review comments, and I have no additional feedback to provide.
chingor13
marked this pull request as ready for review
October 6, 2026 21:11
chingor13
changed the title
Add a DocC - Note: callout to Discovery LRO methods in Swift client templates clarifying that polling returns the terminal Operation status object rather than the created resource. Towards googleapis/google-cloud-swift#991
chingor13
force-pushed
the
fix-issue-991
branch
from
October 6, 2026 21:46
1f4e3b7 to
029afa5
Compare
nolanleastin
approved these changes
Oct 7, 2026
hj690
pushed a commit
that referenced
this pull request
Oct 13, 2026
🤖 I have created a release *beep* *boop* --- ## [0.48.0](v0.47.0...v0.48.0) (2026-10-09) ### Features * **sidekick/swift:** add doc comments for init(fromAny:) ([#7767](#7767)) ([effccd5](effccd5)) * **sidekick/swift:** support ExistentialAny ([#7762](#7762)) ([d8be62b](d8be62b)) ### Bug Fixes * **python:** force using tools installed pandoc binary ([#7765](#7765)) ([d264768](d264768)) * **sidekick/swift:** note Discovery LRO return type ([#7763](#7763)) ([a6ef617](a6ef617)) --- 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>
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
2 participants
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.
This change adds a standardized DocC
- Note:callout to Discovery-based long-running operation polling methods in the Swift generator templates.Unlike standard gRPC LROs which unwrap and return the target resource directly upon polling completion, Discovery-based APIs (e.g. Compute Engine) return the terminal
Operationstatus record. The note informs developers to call the correspondinggetmethod to obtain the modified or created resource.Towards googleapis/google-cloud-swift#991
Generated PR: googleapis/google-cloud-swift#1373