Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve SDK docs around support for modeled request compression #2762

Open
lucix-aws opened this issue Aug 23, 2024 · 0 comments
Open

Improve SDK docs around support for modeled request compression #2762

lucix-aws opened this issue Aug 23, 2024 · 0 comments
Labels
documentation This is a problem with documentation. p3 This is a minor priority issue queued This issues is on the AWS team's backlog

Comments

@lucix-aws
Copy link
Contributor

lucix-aws commented Aug 23, 2024

See #2753. There is a discoverability issue with the modeled request compression feature in that there's no explicit indication of what services actually support it. The presence of the env settings for controlling it are rife for causing confusion as customers might be lead to believe there is functionality where none exists.

Some things we can do better:

  • Clarify documentation in the SDK around these settings to clarify the per-request nature
  • Add custom doc strings to operations that support it indicating as such
@lucix-aws lucix-aws added documentation This is a problem with documentation. p3 This is a minor priority issue queued This issues is on the AWS team's backlog labels Aug 23, 2024
@lucix-aws lucix-aws changed the title SDK docs for operations should be more explicit about when modeled request compression is enabled Improve SDK docs around support for modeled request compression Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. p3 This is a minor priority issue queued This issues is on the AWS team's backlog
Projects
None yet
Development

No branches or pull requests

1 participant