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

update docs for useQueueUrlAsEndpoint #499

Merged
merged 2 commits into from
May 10, 2024

Conversation

tylermichael
Copy link
Contributor

The AWS docs for this property suggest the language here is backwards.

Description:
The documentation says to set it to false to use the queueUrl as the endpoint, but the behavior is actually the opposite.
Setting it to true (which is the default) makes the SQS client use the queueUrl as the endpoint.
Setting it to false makes the SQS client use the resolved SQS endpoint, which would be the AWS region SQS endpoint by default.

Type of change:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Why is this change required?:
The documentation is incorrect in how this property is used.

Code changes:

  • Documentation change only

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@tylermichael tylermichael requested review from a team as code owners May 10, 2024 16:38
Copy link

github-actions bot commented May 10, 2024

CLA Assistant Lite bot CLA CHECK All Contributors have signed the CLA

@tylermichael
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@tylermichael
Copy link
Contributor Author

recheck

Copy link

codeclimate bot commented May 10, 2024

Code Climate has analyzed commit 190d953 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (80% is the threshold).

This pull request will bring the total coverage in the repository to 97.9% (0.0% change).

View more on Code Climate.

Copy link
Member

@nicholasgriffintn nicholasgriffintn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're totally correct, thanks for the PR!

@nicholasgriffintn nicholasgriffintn merged commit 73c5463 into bbc:main May 10, 2024
8 of 9 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators May 10, 2024
@tylermichael tylermichael deleted the patch-1 branch May 15, 2024 15:26
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants