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

Dangling Parameter - should be removed from SNS Docs #4227

Open
sciencepal opened this issue Aug 5, 2024 · 1 comment
Open

Dangling Parameter - should be removed from SNS Docs #4227

sciencepal opened this issue Aug 5, 2024 · 1 comment
Labels
bug This issue is a confirmed bug. documentation This is a problem with documentation. needs-review p2 This is a standard priority issue

Comments

@sciencepal
Copy link

Describe the issue

There is a dangling (string) parameter that is added at the end of attributes apply only to FIFO Topics under SNS create_topic docs. This is confusing and not needed.

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sns/client/create_topic.html#SNS.Client.create_topic

@sciencepal sciencepal added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Aug 5, 2024
@tim-finnigan tim-finnigan self-assigned this Aug 5, 2024
@tim-finnigan tim-finnigan added the investigating This issue is being investigated and/or work is in progress to resolve the issue. label Aug 5, 2024
@tim-finnigan
Copy link
Contributor

Thanks for reporting. I'll share a screenshot of what you're describing:

image

In cases like this there is usually a modeling issue with the upstream API documentation causing it. But I didn't see this issue in the documentation of other SDKs like JavaScript.

I also found that it exists for other SNS commands like create_platform_endpoint, and for commands of other services like SQS create_queue. Therefore I think there is some kind of parsing bug with the documentation. Will bring this up for discussion with the team.

@tim-finnigan tim-finnigan added bug This issue is a confirmed bug. needs-review p2 This is a standard priority issue and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. needs-triage This issue or PR still needs to be triaged. labels Aug 5, 2024
@tim-finnigan tim-finnigan removed their assignment Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a confirmed bug. documentation This is a problem with documentation. needs-review p2 This is a standard priority issue
Projects
None yet
Development

No branches or pull requests

2 participants