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

Fix GoDoc for GetCredentialReportOutput.Content #2115

Closed
andrewmeissner opened this issue May 5, 2023 · 3 comments
Closed

Fix GoDoc for GetCredentialReportOutput.Content #2115

andrewmeissner opened this issue May 5, 2023 · 3 comments
Labels
documentation This is a problem with documentation. p3 This is a minor priority issue

Comments

@andrewmeissner
Copy link

Describe the issue

Documentation says GetCredentialReportOutput.Content is base64 encoded, but it isn't.

Links

Doc for the field: https://github.com/aws/aws-sdk-go-v2/blob/service/iam/v1.19.12/service/iam/api_op_GetCredentialReport.go#L40

This is where the Content field is being set, already decoded: https://github.com/aws/aws-sdk-go-v2/blob/service/iam/v1.19.12/service/iam/deserializers.go#L27216

AWS Go SDK V2 Module Versions Used

$ go mod graph | grep -i github.com/aws

creds github.com/aws/[email protected]
creds github.com/aws/aws-sdk-go-v2/[email protected]
creds github.com/aws/aws-sdk-go-v2/[email protected]
creds github.com/aws/aws-sdk-go-v2/feature/ec2/[email protected]
creds github.com/aws/aws-sdk-go-v2/internal/[email protected]
creds github.com/aws/aws-sdk-go-v2/internal/endpoints/[email protected]
creds github.com/aws/aws-sdk-go-v2/internal/[email protected]
creds github.com/aws/aws-sdk-go-v2/service/[email protected]
creds github.com/aws/aws-sdk-go-v2/service/internal/[email protected]
creds github.com/aws/aws-sdk-go-v2/service/[email protected]
creds github.com/aws/aws-sdk-go-v2/service/[email protected]
creds github.com/aws/aws-sdk-go-v2/service/[email protected]
creds github.com/aws/[email protected]
github.com/aws/[email protected] github.com/aws/[email protected]
github.com/aws/[email protected] github.com/google/[email protected]
github.com/aws/[email protected] github.com/jmespath/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/aws/aws-sdk-go-v2/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/aws/aws-sdk-go-v2/feature/ec2/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/aws/aws-sdk-go-v2/internal/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/aws/aws-sdk-go-v2/service/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/aws/aws-sdk-go-v2/service/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/aws/aws-sdk-go-v2/service/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/google/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/aws/aws-sdk-go-v2/feature/ec2/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/aws/aws-sdk-go-v2/service/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/aws/aws-sdk-go-v2/service/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/aws/aws-sdk-go-v2/service/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/[email protected] github.com/google/[email protected]
github.com/aws/aws-sdk-go-v2/feature/ec2/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/feature/ec2/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/feature/ec2/[email protected] github.com/google/[email protected]
github.com/aws/aws-sdk-go-v2/internal/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/internal/endpoints/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/internal/endpoints/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/internal/endpoints/[email protected] github.com/google/[email protected]
github.com/aws/aws-sdk-go-v2/internal/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/aws-sdk-go-v2/internal/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/aws-sdk-go-v2/internal/endpoints/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/service/internal/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/service/internal/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/service/internal/[email protected] github.com/google/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/aws-sdk-go-v2/internal/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/aws-sdk-go-v2/internal/endpoints/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/aws-sdk-go-v2/internal/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/aws-sdk-go-v2/internal/endpoints/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/aws-sdk-go-v2/internal/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/aws-sdk-go-v2/internal/endpoints/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/aws-sdk-go-v2/service/internal/[email protected]
github.com/aws/aws-sdk-go-v2/service/[email protected] github.com/aws/[email protected]
github.com/aws/[email protected] github.com/google/[email protected]
github.com/aws/[email protected] github.com/jmespath/[email protected]

@andrewmeissner andrewmeissner added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels May 5, 2023
@andrewmeissner andrewmeissner changed the title (short issue description) Fix GoDoc for GetCredentialReportOutput.Content May 5, 2023
@RanVaknin RanVaknin added p3 This is a minor priority issue and removed needs-triage This issue or PR still needs to be triaged. labels May 19, 2023
@mateusmarquezini
Copy link

Hi there, can I take a look into this?

@lucix-aws
Copy link
Contributor

It is actually base64 coming off the wire -- the SDK performs an additional step on smithy blob types to decode them during deserialization.

This is an unfortunate confusion caused by the fact that the docs we present are simply codegenned from the service API model's docs (all AWS SDKs are code-generated from API models owned by the service teams), which are speaking in terms of the pure HTTP request/response and can't account for logic performed by callers (like us) during deserialization.

Closing since there's nothing actionable for us here.

@lucix-aws lucix-aws closed this as not planned Won't fix, can't repro, duplicate, stale Nov 7, 2023
Copy link

github-actions bot commented Nov 7, 2023

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

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
Projects
None yet
Development

No branches or pull requests

4 participants