Skip to content

docs(event_handler): add information about case-insensitive header lookup function #3183

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

Conversation

pgrzesik
Copy link
Contributor

@pgrzesik pgrzesik commented Oct 8, 2023

Issue number: #3142

Summary

Slightly improved documentation about case-insensitive lookup of specific header values for REST API events.

Changes

As above, slight changes to docs only

User experience

Improved documentation

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@pgrzesik pgrzesik requested a review from a team October 8, 2023 22:07
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Oct 8, 2023
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 8, 2023
@boring-cyborg
Copy link

boring-cyborg bot commented Oct 8, 2023

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

@leandrodamascena leandrodamascena linked an issue Oct 9, 2023 that may be closed by this pull request
Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

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

Hi @pgrzesik! I left a comment with a suggestion to transform the text into a more active voice and tell the customer what they should do to achieve the result they want. Make sense?
Thank you for sending this PR. Improving our documentation from customer feedback is something we work hard on every day.

@leandrodamascena leandrodamascena changed the title docs(event_handler): Highlight case-insensitive lookup of headers docs(event_handler): add more information about case-insensitive lookup of headers Oct 9, 2023
@leandrodamascena leandrodamascena changed the title docs(event_handler): add more information about case-insensitive lookup of headers docs(event_handler): add specific information about case-insensitive lookup of headers Oct 10, 2023
@pgrzesik
Copy link
Contributor Author

Thank you for the suggestion @leandrodamascena, I just accepted it 🙌

@leandrodamascena leandrodamascena changed the title docs(event_handler): add specific information about case-insensitive lookup of headers docs(event_handler): add information about case-insensitive header lookup function Oct 10, 2023
Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

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

Hi @pgrzesik! This PR seems simple because we just changed a line, but the discussions that brought us here were complex and you could find a simple and effective solution. This is priceless, we really appreciate this.

Approved!

image

Signed-off-by: Heitor Lessa <[email protected]>
Copy link
Contributor

@heitorlessa heitorlessa left a comment

Choose a reason for hiding this comment

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

looks great, thank you so much @pgrzesik!

@leandrodamascena before we merge, we need to fix the docstring in the get_header_value function to signal that by default we make a case-insensitive lookup*

@leandrodamascena
Copy link
Contributor

looks great, thank you so much @pgrzesik!

@leandrodamascena before we merge, we need to fix the docstring in the get_header_value function to signal that by default we make a case-insensitive lookup*

Hey @heitorlessa - https://github.com/aws-powertools/powertools-lambda-python/pull/3183/files#diff-201518b4cf27a31cff68870554e0b4e2d6de2fa18456d2ea85d04d156991600cR192

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@codecov-commenter
Copy link

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (e555df1) 95.96% compared to head (933d3d9) 95.96%.
Report is 3 commits behind head on develop.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3183   +/-   ##
========================================
  Coverage    95.96%   95.96%           
========================================
  Files          195      195           
  Lines         8381     8381           
  Branches      1562     1562           
========================================
  Hits          8043     8043           
  Misses         276      276           
  Partials        62       62           
Files Coverage Δ
...lambda_powertools/utilities/data_classes/common.py 100.00% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@leandrodamascena leandrodamascena merged commit bf2df4f into aws-powertools:develop Oct 11, 2023
@boring-cyborg
Copy link

boring-cyborg bot commented Oct 11, 2023

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature: Request header keys should case-insensitive
4 participants