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.

Sign up for GitHub

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

Jump to bottom

docs(event_handler): add micro function examples #3056

Merged
merged 16 commits into from
Sep 15, 2023
Merged

docs(event_handler): add micro function examples #3056

merged 16 commits into from
Sep 15, 2023

Conversation

TonySherman
Copy link
Contributor

Issue number:
#902

Summary

Adding an example of a micro function pattern REST API

Changes

No code changes. Documentation updates only

Please provide a summary of what's being changed

User experience

Please share what the user experience looks like before and after this change

Checklist

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

Is this a breaking change? No **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.

@TonySherman TonySherman requested a review from a team as a code owner September 7, 2023 14:48
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Sep 7, 2023
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 7, 2023
@boring-cyborg
Copy link

boring-cyborg bot commented Sep 7, 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 Sep 7, 2023 that may be closed by this pull request
More full examples of the micro function pattern #902
Closed
@sthulb sthulb self-requested a review September 11, 2023 13:25
@leandrodamascena leandrodamascena changed the title docs(event_handler): micro function examples docs(event_handler): add micro function examples Sep 11, 2023
@leandrodamascena
Copy link
Contributor

Hi @TonySherman! Can you enable our write access to this branch? We need to keep this PR in sync with our develop branch and we can't do that because you need to enable this option:

image

Thanks

@TonySherman
Copy link
Contributor Author

Hi @TonySherman! Can you enable our write access to this branch? We need to keep this PR in sync with our develop branch and we can't do that because you need to enable this option:

image

Thanks

It doesn't look like I have the ability to do this. Perhaps because it's a fork by my organization.

@leandrodamascena
Copy link
Contributor

Hi @TonySherman! Can you enable our write access to this branch? We need to keep this PR in sync with our develop branch and we can't do that because you need to enable this option:
image
Thanks

It doesn't look like I have the ability to do this. Perhaps because it's a fork by my organization.

Aaa ok, don't worry about it. @sthulb and I will review this PR and provide appropriate feedback.

@leandrodamascena leandrodamascena self-requested a review September 11, 2023 15:56
sthulb
sthulb previously approved these changes Sep 12, 2023
View reviewed changes
Copy link
Contributor

@sthulb sthulb left a comment

Choose a reason for hiding this comment

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

These docs are good, thanks!

examples/event_handler_rest/src/micro_function_user_by_id_route.py Outdated Show resolved Hide resolved
@TonySherman
Copy link
Contributor Author

Thanks for the review @sthulb! I made a change on the one comment you had. If this falls behind the develop branch again. feel free to ping me. I'll try to keep an eye on it too.

sthulb
sthulb previously approved these changes Sep 12, 2023
View reviewed changes
leandrodamascena
leandrodamascena requested changes Sep 14, 2023
View reviewed changes
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.

Thanks for your review @sthulb!

Hi @TonySherman, I made some additional comments and it would be good to address them before we merge. This is a great opportunity to show our customers how to use a microfunction pattern, thank you very much for investing time in this.

docs/core/event_handler/api_gateway.md Outdated Show resolved Hide resolved
examples/event_handler_rest/sam/micro_function_template.yaml Outdated Show resolved Hide resolved
examples/event_handler_rest/sam/micro_function_template.yaml Outdated Show resolved Hide resolved
examples/event_handler_rest/src/micro_function_all_users_route.py Outdated Show resolved Hide resolved
examples/event_handler_rest/src/micro_function_all_users_route.py Outdated Show resolved Hide resolved
examples/event_handler_rest/src/micro_function_all_users_route.py Outdated Show resolved Hide resolved
examples/event_handler_rest/src/micro_function_user_by_id_route.py Outdated Show resolved Hide resolved
examples/event_handler_rest/src/micro_function_user_by_id_route.py Outdated Show resolved Hide resolved
examples/event_handler_rest/src/micro_function_user_by_id_route.py Outdated Show resolved Hide resolved
examples/event_handler_rest/src/micro_function_user_by_id_route.py Outdated Show resolved Hide resolved
@TonySherman @leandrodamascena
Add missing .
ed3ba21 
Co-authored-by: Leandro Damascena <[email protected]>
Signed-off-by: Tony Sherman <[email protected]>
@TonySherman
Copy link
Contributor Author

Thanks for the suggestions @leandrodamascena! Let me know if there's any other changes you'd like.

@leandrodamascena leandrodamascena self-requested a review September 15, 2023 09:32
@leandrodamascena
Copy link
Contributor

Hey @TonySherman! Can you please update this branch? We will merge and include in this release!

Thanks a lot again, this is an important contribution.

@sonarcloud
Copy link

sonarcloud bot commented Sep 15, 2023

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 2 Code Smells

No Coverage information No Coverage information
1.3% 1.3% Duplication

@leandrodamascena leandrodamascena merged commit 4e8ca0f into aws-powertools:develop Sep 15, 2023
4 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented Sep 15, 2023

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

@TonySherman TonySherman deleted the docs/micro-function-examples branch September 15, 2023 12:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leandrodamascena leandrodamascena leandrodamascena approved these changes

@sthulb sthulb sthulb left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

More full examples of the micro function pattern
3 participants
@TonySherman @leandrodamascena @sthulb