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

[amin-farjadi]

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.

[amin-farjadi]

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]

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]

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]

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.

[amin-farjadi]

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

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

[sonarqubecloud]

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!!