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

docs(bedrock-agents): fix type in Bedrock operation example #3948

Conversation

eldritchideen
Copy link
Contributor

@eldritchideen eldritchideen commented Mar 13, 2024

Issue number: #3945

Summary

Changes

Changed the OpenAPI parameter specification from Query to Path, to correctly match the configuration of the get for the BedrockAgentResolver. Also reworded the Path description.

User experience

The example code is now accurate.

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.

@eldritchideen eldritchideen requested a review from a team March 13, 2024 11:38
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 13, 2024
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@eldritchideen eldritchideen changed the title docs(bedrock agents) Changed Query to Path matching router in example docs(bedrock-agents) Changed Query to Path matching router in example Mar 13, 2024
@leandrodamascena leandrodamascena linked an issue Mar 13, 2024 that may be closed by this pull request
1 task
@leandrodamascena leandrodamascena changed the title docs(bedrock-agents) Changed Query to Path matching router in example docs(bedrock-agents): Changed Query to Path matching router in example Mar 13, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 13, 2024
@leandrodamascena leandrodamascena changed the title docs(bedrock-agents): Changed Query to Path matching router in example docs(bedrock-agents): fix type in Bedrock operation example Mar 13, 2024
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.

Hey @eldritchideen! Thanks for sending this PR to fix this error in our documentation!

APPROVED!

@leandrodamascena leandrodamascena merged commit c3e36de into aws-powertools:develop Mar 13, 2024
12 checks passed
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.

Docs: Incorrect OpenAPI Param used in example
2 participants