Skip to content

Improve SDK docs around support for modeled request compression #2762

Open
@lucix-aws

Description

@lucix-aws
Contributor

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

Activity

added
documentationThis is a problem with documentation.
p3This is a minor priority issue
queuedThis issues is on the AWS team's backlog
on Aug 23, 2024
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[/+] on Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationThis is a problem with documentation.p3This is a minor priority issuequeuedThis issues is on the AWS team's backlog

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @lucix-aws

        Issue actions

          Improve SDK docs around support for modeled request compression · Issue #2762 · aws/aws-sdk-go-v2