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 88.46154% with 3 lines in your changes missing coverage. Please review.

Project coverage is 96.30%. Comparing base (5642a4a) to head (3e5fb6e).
Report is 7 commits behind head on develop.

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

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #6341      +/-   ##
===========================================
- Coverage    96.31%   96.30%   -0.02%     
===========================================
  Files          242      242              
  Lines        11710    11731      +21     
  Branches       871      875       +4     
===========================================
+ Hits         11279    11297      +18     
- Misses         337      339       +2     
- 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.

[leandrodamascena]

leftover?

[leandrodamascena]

You need to include this as part of the OpenAPI specification, otherwise customer will have the following code as part of the OpenAPI schema, but ResponseValidationError will be an unknown object.

operation_responses[http_code] = {
                "description": "Response Validation Error",
                "content": {"application/json": {"schema": {"$ref": f"{COMPONENT_REF_PREFIX}ResponseValidationError"}}},
            }

Check here: https://github.com/aws-powertools/powertools-lambda-python/blob/develop/aws_lambda_powertools/event_handler/api_gateway.py#L634

[sonarqubecloud]

Quality Gate passed

Issues
11 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
5.1% Duplication on New Code

See analysis details on SonarQube Cloud