feat(event_handler): add route-level custom response validation in OpenAPI utility by amin-farjadi · Pull Request #6341 · aws-powertools/powertools-lambda-python

amin-farjadi · 2025-03-25T08:55:40Z

Issue number: #6245

Summary

Adds custom http code for when response validation fails per route.

Changes

Added custom_response_validation_http_code argument for Route
Added said argument to route method in Router and APIGatewayResolver
Added _validate_route_response_validation_error_http_code method to APIGatewayResolver
Added has_route_custom_response_validation argument to the _serialize_response method in OpenAPIValidationMiddleware
Added response_validation_error_response_definition to open api types

User experience

After the merge of #6189, users could add custom response validation error http code at the app level

from aws_lambda_powertools.event_handler import APIGatewayRestResolver

app = APIGatewayRestResolver(enable_validation=True, response_validation_error_http_code=500)

Now, users can customise the response validation http code at route level as well as at app level

from aws_lambda_powertools.event_handler import APIGatewayRestResolver

app = APIGatewayRestResolver(enable_validation=True, response_validation_error_http_code=500)

@app.get(
    "/response_validation_error_with_422",
    custom_response_validation_http_code=422,
)
def handler() -> list:
    return {"body": "hi"}

Checklist

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

Meet tenets criteria
I have performed a self-review of this change
Changes have been tested
Changes are documented
PR title follows conventional commit semantics

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.

… error status code.

…lidation_error_http_code

…est file

…p's.

…not Router

amin-farjadi · 2025-03-25T09:43:54Z

n.b. tests/functional/metrics/datadog/test_metrics_datadog.py::test_datadog_disable_write_to_log_with_env_variable fails in local machine which I believe is expected

leandrodamascena · 2025-03-25T09:50:21Z

n.b. tests/functional/metrics/datadog/test_metrics_datadog.py::test_datadog_disable_write_to_log_with_env_variable fails in local machine which I believe is expected

Try to run make dev and it will install a dev dependency that fix this.

codecov · 2025-03-25T09:55:39Z

Codecov Report

Attention: Patch coverage is 97.56098% with 1 line in your changes missing coverage. Please review.

Project coverage is 96.33%. Comparing base (54648da) to head (9e04a63).
Report is 2 commits behind head on develop.

Files with missing lines	Patch %	Lines
aws_lambda_powertools/event_handler/api_gateway.py	97.05%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #6341   +/-   ##
========================================
  Coverage    96.33%   96.33%           
========================================
  Files          243      243           
  Lines        11763    11797   +34     
  Branches       871      878    +7     
========================================
+ Hits         11332    11365   +33     
  Misses         337      337           
- Partials        94       95    +1

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

leandrodamascena · 2025-03-31T10:49:28Z

Looking at this now.

leandrodamascena

Hi @amin-farjadi! Super thanks for this another PR. It took me a few more days than I expected to review this PR because I had some internal priorities.

Overall this PR is pretty good, but there is 1 critical item that needs to be fixed before I can do a final review and merge.

Please let me know if you need any help.

aws_lambda_powertools/event_handler/api_gateway.py

aws_lambda_powertools/event_handler/openapi/types.py

…on for it

amin-farjadi · 2025-04-09T22:26:25Z

@leandrodamascena I think it's all done. appreciate a review.

p.s. found a lil bug whilst testing the openapi schema — #6435

sonarqubecloud · 2025-04-10T17:05:49Z

Quality Gate passed

Issues
0 New issues
5 Accepted issues

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

See analysis details on SonarQube Cloud

anafalcao

approved!

leandrodamascena

Hey @amin-farjadi! Thanks a lot for another super nice PR and addressing all the comments!

APPROVED!!

…enAPI utility (#6341) * feat(api-gateway-resolver): Add option for custom response validation error status code. * feat(docs): Added doc for custom response validation error responses. * feat(unit-test): Add tests for custom response validation error. * fix: Formatting. * fix(unit-test): fix failed CI. * feat(unit-test): add tests for incorrect types and invalid configs * refactor: rename response_validation_error_http_status to response_validation_error_http_code * refactor(tests): move unit tests into openapi_validation functional test file * feat: add route-specific custom response validation and tests * fix: except Route implementation * fix: put custom_response_validation_http_code before middleware * feat: route's custom response validation must take precedence over app's. * feat: added more tests. * refactor: improved error messagee and tests' descriptions. * feat: updated docs. * move veritifcation method of route custom http code to BaseRouter. * fix: add validate function for route http code to APIGatewayResolver not Router * feat: add custom_response_validation_http_code to the routes of Bedrock * fix: make mypy happy * fix: address comments * fix(openapi): add response for response validation error and definition for it * minor changes * minor changes --------- Co-authored-by: Amin Farjadi <amin.farjadi@eonnext.com> Co-authored-by: Leandro Damascena <lcdama@amazon.pt>

Amin Farjadi and others added 16 commits March 21, 2025 18:58

feat(api-gateway-resolver): Add option for custom response validation…

85321d1

… error status code.

feat(docs): Added doc for custom response validation error responses.

aa7cf6f

feat(unit-test): Add tests for custom response validation error.

cb7fd6d

fix: Formatting.

1228632

fix(unit-test): fix failed CI.

b95d521

feat(unit-test): add tests for incorrect types and invalid configs

f849930

refactor: rename response_validation_error_http_status to response_va…

bafd19c

…lidation_error_http_code

refactor(tests): move unit tests into openapi_validation functional t…

9b09bb7

…est file

feat: add route-specific custom response validation and tests

bbbd989

fix: except Route implementation

ce7be15

fix: put custom_response_validation_http_code before middleware

95d9aee

feat: route's custom response validation must take precedence over ap…

210b765

…p's.

feat: added more tests.

575e713

refactor: improved error messagee and tests' descriptions.

440a3f4

feat: updated docs.

249554f

move veritifcation method of route custom http code to BaseRouter.

d0eadf0

amin-farjadi requested a review from a team as a code owner March 25, 2025 08:55

amin-farjadi requested a review from leandrodamascena March 25, 2025 08:55

boring-cyborg bot added documentation Improvements or additions to documentation event_handlers tests labels Mar 25, 2025

pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 25, 2025

amin-farjadi and others added 2 commits March 25, 2025 09:07

Merge branch 'develop' into feature/route-custom-response-validation

2316637

fix: add validate function for route http code to APIGatewayResolver …

59bb4aa

…not Router

leandrodamascena assigned amin-farjadi Mar 25, 2025

leandrodamascena linked an issue Mar 25, 2025 that may be closed by this pull request

Feature request: Custom response validation status code on routes #6245

Closed

2 tasks

github-actions bot added feature New feature or functionality and removed documentation Improvements or additions to documentation labels Mar 25, 2025

amin-farjadi added 2 commits March 25, 2025 09:42

feat: add custom_response_validation_http_code to the routes of Bedrock

020c973

fix: make mypy happy

5ea8ffa

boring-cyborg bot added the documentation Improvements or additions to documentation label Mar 25, 2025

Merge branch 'develop' into feature/route-custom-response-validation

ac5dbf4

leandrodamascena added 3 commits March 25, 2025 19:52

Merge branch 'develop' into feature/route-custom-response-validation

d23be99

Merge branch 'develop' into feature/route-custom-response-validation

ec113cb

Merge branch 'develop' into feature/route-custom-response-validation

5794c27

Merge branch 'develop' into feature/route-custom-response-validation

3e5fb6e

leandrodamascena requested changes Apr 3, 2025

View reviewed changes

aws_lambda_powertools/event_handler/api_gateway.py Outdated Show resolved Hide resolved

aws_lambda_powertools/event_handler/openapi/types.py Show resolved Hide resolved

leandrodamascena and others added 4 commits April 4, 2025 15:26

Merge branch 'develop' into feature/route-custom-response-validation

6d00446

fix: address comments

fca7db0

Merge branch 'develop' into feature/route-custom-response-validation

afbda76

fix(openapi): add response for response validation error and definiti…

2d7a73d

…on for it

amin-farjadi requested a review from leandrodamascena April 9, 2025 22:10

leandrodamascena added 3 commits April 10, 2025 14:18

Merge branch 'develop' into feature/route-custom-response-validation

1686c5c

minor changes

ba7d6c7

minor changes

9e04a63

anafalcao approved these changes Apr 10, 2025

View reviewed changes

leandrodamascena approved these changes Apr 10, 2025

View reviewed changes

leandrodamascena merged commit 89eb55b into aws-powertools:develop Apr 10, 2025
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(event_handler): add route-level custom response validation in OpenAPI utility #6341

feat(event_handler): add route-level custom response validation in OpenAPI utility #6341
leandrodamascena merged 32 commits intoaws-powertools:developfrom
amin-farjadi:feature/route-custom-response-validation

amin-farjadi commented Mar 25, 2025 •

edited

Loading

Uh oh!

amin-farjadi commented Mar 25, 2025

Uh oh!

leandrodamascena commented Mar 25, 2025

Uh oh!

codecov bot commented Mar 25, 2025 •

edited

Loading

Uh oh!

leandrodamascena commented Mar 31, 2025

Uh oh!

leandrodamascena left a comment

Uh oh!

Uh oh!

Uh oh!

amin-farjadi commented Apr 9, 2025

Uh oh!

sonarqubecloud bot commented Apr 10, 2025 •

edited

Loading

Uh oh!

anafalcao left a comment

Uh oh!

leandrodamascena left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

amin-farjadi commented Mar 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

User experience

Checklist

Acknowledgment

Uh oh!

amin-farjadi commented Mar 25, 2025

Uh oh!

leandrodamascena commented Mar 25, 2025

Uh oh!

codecov bot commented Mar 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

leandrodamascena commented Mar 31, 2025

Uh oh!

leandrodamascena left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

amin-farjadi commented Apr 9, 2025

Uh oh!

sonarqubecloud bot commented Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Quality Gate passed

Uh oh!

anafalcao left a comment

Choose a reason for hiding this comment

Uh oh!

leandrodamascena left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

amin-farjadi commented Mar 25, 2025 •

edited

Loading

codecov bot commented Mar 25, 2025 •

edited

Loading

sonarqubecloud bot commented Apr 10, 2025 •

edited

Loading