boto3 icon indicating copy to clipboard operation
boto3 copied to clipboard

Dangling Parameter - should be removed from SNS Docs

Open sciencepal opened this issue 1 year ago • 1 comments

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 avatar Aug 05 '24 18:08 sciencepal

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 avatar Aug 05 '24 20:08 tim-finnigan