Skip to content

Commit d2ffff5

Browse files
authored
docs(longrunning): link previous crate version (#1351)
Link the previous version of the crate, it is polite and may avoid confusion for some folks. Since I was customizing the description, might as well add something about what the crate is about.
1 parent e64d82a commit d2ffff5

2 files changed

Lines changed: 33 additions & 0 deletions

File tree

src/generated/longrunning/.sidekick.toml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,23 @@
1616
specification-source = 'google/longrunning'
1717
service-config = 'google/longrunning/longrunning.yaml'
1818

19+
[source]
20+
description-override = """Defines types and an abstract service to handle long-running operations.
21+
22+
[Long-running operations] are a common pattern to handle methods that may take a
23+
significant amount of time to execute. Many Google APIs return an `Operation`
24+
message (defined in this crate) that are roughly analogous to a future. The
25+
operation will eventually complete, though it may still return an error on
26+
completion. The client libraries provide helpers to simplify polling of these
27+
operations.
28+
29+
> This crate used to contain a different implementation, with a different
30+
> surface. [@yoshidan](https://github.com/yoshidan) generously donated the crate
31+
> name to Google. Their crate continues to live as [gcloud-longrunning].
32+
33+
[Long-running operations]: https://google.aip.dev/151
34+
[gcloud-longrunning]: https://crates.io/crates/gcloud-longrunning"""
35+
1936
[codec]
2037
version = "0.22.0" # Match existing version
2138
copyright-year = '2024'

src/generated/longrunning/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,22 @@ changes in the upcoming releases. Testing is also incomplete, we do **not**
77
recommend that you use this crate in production. We welcome feedback about the
88
APIs, documentation, missing features, bugs, etc.
99

10+
Defines types and an abstract service to handle long-running operations.
11+
12+
[Long-running operations] are a common pattern to handle methods that may take a
13+
significant amount of time to execute. Many Google APIs return an `Operation`
14+
message (defined in this crate) that are roughly analogous to a future. The
15+
operation will eventually complete, though it may still return an error on
16+
completion. The client libraries provide helpers to simplify polling of these
17+
operations.
18+
19+
> This crate used to contain a different implementation, with a different
20+
> surface. [@yoshidan](https://github.com/yoshidan) generously donated the crate
21+
> name to Google. Their crate continues to live as [gcloud-longrunning].
22+
23+
[Long-running operations]: https://google.aip.dev/151
24+
[gcloud-longrunning]: https://crates.io/crates/gcloud-longrunning
25+
1026
## Quickstart
1127

1228
The main types to work with this crate are the clients:

0 commit comments

Comments
 (0)