Repository navigation
docs: document Discovery LRO return types - #1373
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 adds documentation notes to various generated Swift client files and updates the user guide to clarify the behavior of long-running operations in Discovery-based APIs (such as Compute Engine), which return a terminal Operation status object instead of the target resource. The reviewer provided a valuable suggestion to improve the user guide by clarifying that since the polling helper methods are throwing functions in Swift, any operation failure will automatically throw an error, meaning callers do not need to manually check the returned Operation for errors.
chingor13
force-pushed
the
fix-issue-991
branch
from
October 6, 2026 21:49
6af453a to
5c7afbd
Compare
chingor13
marked this pull request as ready for review
October 6, 2026 22:07
nolanleastin
approved these changes
Oct 7, 2026
chingor13
added a commit
to googleapis/librarian
that referenced
this pull request
Oct 7, 2026
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 `Operation` status record. The note informs developers to call the corresponding `get` method to obtain the modified or created resource. Towards googleapis/google-cloud-swift#991 Generated PR: googleapis/google-cloud-swift#1373
chingor13
force-pushed
the
fix-issue-991
branch
from
October 7, 2026 16:34
5c7afbd to
9312437
Compare
chingor13
enabled auto-merge (squash)
October 7, 2026 16:35
chingor13
disabled auto-merge
October 7, 2026 16:36
chingor13
changed the title
chingor13
enabled auto-merge (squash)
October 7, 2026 16:36
chingor13
disabled auto-merge
October 7, 2026 16:43
Regenerate GoogleCloudComputeV1 with DocC notes explaining that Discovery LRO polling returns an Operation status record rather than the modified resource.
Document differences in return types between gRPC and Discovery-based long-running operations in the User Guide, noting that Discovery-based operations return the Operation status object rather than the modified resource.
chingor13
force-pushed
the
fix-issue-991
branch
from
October 7, 2026 16:51
9312437 to
017cf72
Compare
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.
Clarifies that Discovery-based long-running operations return the terminal
Operationstatus record upon polling completion rather than the modified resource, and documents how to retrieve the created/modified resource usingget.GoogleCloudComputeV1LRO polling methods and protocol requirements.Fixes #991