Skip to content

Docs: Incorrect OpenAPI Param used in example #3945

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

Closed
1 task done
eldritchideen opened this issue Mar 13, 2024 · 4 comments · Fixed by #3948
Closed
1 task done

Docs: Incorrect OpenAPI Param used in example #3945

eldritchideen opened this issue Mar 13, 2024 · 4 comments · Fixed by #3948
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@eldritchideen
Copy link
Contributor

What were you searching in the docs?

The Customizing API operations example is using the wrong OpenAPI param. The example uses Query, when it should be Path.
https://docs.powertools.aws.dev/lambda/python/latest/core/event_handler/bedrock_agents/#customizing-api-operations:~:text=Customzing%20API%20operations

Is this related to an existing documentation section?

https://docs.powertools.aws.dev/lambda/python/latest/core/event_handler/bedrock_agents/#customizing-api-operations:~:text=Customzing%20API%20operations

How can we improve?

Simple updates to the example code.

Got a suggestion in mind?

No response

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@eldritchideen eldritchideen added documentation Improvements or additions to documentation triage Pending triage from maintainers labels Mar 13, 2024
Copy link

boring-cyborg bot commented Mar 13, 2024

Thanks for opening your first issue here! We'll come back to you as soon as we can.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

@eldritchideen
Copy link
Contributor Author

Happy to submit a PR to fix this, I'll work on it.

@rubenfonseca
Copy link
Contributor

Thank you so much for catching this @eldritchideen ! We would love your PR to fix this :)

@rubenfonseca rubenfonseca removed the triage Pending triage from maintainers label Mar 13, 2024
@rubenfonseca rubenfonseca self-assigned this Mar 13, 2024
@rubenfonseca rubenfonseca moved this from Triage to Working on it in Powertools for AWS Lambda (Python) Mar 13, 2024
@leandrodamascena leandrodamascena linked a pull request Mar 13, 2024 that will close this issue
6 tasks
@github-project-automation github-project-automation bot moved this from Working on it to Coming soon in Powertools for AWS Lambda (Python) Mar 13, 2024
Copy link
Contributor

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

@leandrodamascena leandrodamascena moved this from Coming soon to Shipped in Powertools for AWS Lambda (Python) Mar 18, 2024
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
Projects
Status: Shipped
2 participants