awslabs / awslabs/aws-sdk-rust

Generate docs about lack of timeouts in stream APIs

Open
#1,176 0 comments 0 reactions 0 assignees View on GitHub
documentation p2
Dominant language
Rust
Stars
3.3k
Forks
290
Avg merge
1d 12h
Merged PRs (30d)
3

Description

### Describe the issue

The SDKs do not currently have any timeouts for [stream](https://smithy.io/2.0/spec/streaming.html#streaming) APIs, and it is not obvious to the customers that their application code needs to wrap calls to those APIs with explicit timeouts like `tokio::time::timeout`.

### Links

[Example for current doc on stream API](https://docs.rs/aws-sdk-ebs/latest/aws_sdk_ebs/struct.Client.html#method.get_snapshot_block) (no mentioning regarding the absence of timeouts)

Contributor guide

Open the contributing guide

Research direction

The issue points to generated docs.rs stream API documentation and the Smithy streaming specification. Start by locating the documentation generator or template for methods such as GetSnapshotBlock, then update the generated API guidance to explain the lack of timeouts and the need for explicit caller-side handling such as tokio::time::timeout. Done means stream API docs clearly communicate this limitation.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.