docs: Generate RPC samples for all APIs#4720
Conversation
d49a8c7 to
0979cbb
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4720 +/- ##
==========================================
- Coverage 95.07% 95.06% -0.02%
==========================================
Files 198 198
Lines 7596 7596
==========================================
- Hits 7222 7221 -1
- Misses 374 375 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
b120dbc to
501b983
Compare
|
The All other checks are green. I'll clean up the PR and push. It's still possible that the actual showcase check fails at that point, in which case we'll temporarily skip RPC sample generation for showcase. |
501b983 to
24cdc4a
Compare
|
This is ready for review. I've created #4729 for tracking the fixes for the few APIs that we are skipping here. And we also have #4018 for Pub/Sub. See #4720 (comment) for how these were tested. |
coryan
left a comment
There was a problem hiding this comment.
I left a few comments as FYIs, things to consider in the future.
An interesting question: how many RPCs follow the AIPs vs. how many don't? You could modify librarian to log "AIP: YES" and "AIP: NO" and then count the results.
| /// let mut list = client.list_users() | ||
| /// /* set fields */ | ||
| /// .by_item(); |
There was a problem hiding this comment.
FYI. Several cases in showcase have these empty list of fields for list_* operations.
| /// use google_cloud_lro::Poller; | ||
| /// use google_cloud_workflows_v1::Result; | ||
| /// async fn sample( | ||
| /// client: &Workflows, resource_name: &str |
There was a problem hiding this comment.
nit: resource_name is not any more helpful than name and probably gets people wondering, "what is a resource".
| /// let response = client.create_workflow() | ||
| /// .set_parent(parent).set_workflow_id("workflow_id_value") | ||
| /// .set_workflow( | ||
| /// Workflow::new()/* set fields */ | ||
| /// ) | ||
| /// .poller().until_done().await?; |
There was a problem hiding this comment.
FYI, this is close to ideal...
amanda-tarafa
left a comment
There was a problem hiding this comment.
Acked all the comments, I've added them to my TODO.
An interesting question: how many RPCs follow the AIPs vs. how many don't? You could modify librarian to log "AIP: YES" and "AIP: NO" and then count the results.
Yes, I like this.
No description provided.