feat(event_handler): add custom method for OpenAPI configuration

[leandrodamascena]

Issue number: #6122

Summary

Changes

This PR introduces a new method configure_openapi() to simplify OpenAPI configuration while maintaining backwards compatibility.

Currently, OpenAPI configuration must be specified in both enable_swagger() and get_openapi_json_schema() methods, leading to:

• Duplication of configuration
• Inconsistent documentation when configurations differ
• More complex maintenance

User experience

Introduce a new configure_openapi() method while preserving existing functionality:

from aws_lambda_powertools.event_handler import APIGatewayRestResolver

app = APIGatewayRestResolver(enable_validation=True)
# New configuration approach
app.configure_openapi(
    title="My API",
    version="1.0.0",
    description="API Description"
)

# Existing methods continue to work
app.enable_swagger(path="/docs")  # Uses configured values

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.32%. Comparing base (7e56fe1) to head (6a30901).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #6204      +/-   ##
===========================================
+ Coverage    96.30%   96.32%   +0.01%     
===========================================
  Files          240      241       +1     
  Lines        11596    11633      +37     
  Branches       862      864       +2     
===========================================
+ Hits         11168    11205      +37     
  Misses         336      336              
  Partials        92       92              

☔ 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]

e2e is green: https://github.com/aws-powertools/powertools-lambda-python/actions/runs/13902540938/job/38897630479

[dreamorosi]

Left only one comment about a default value, other than that it looks good.

Great improvement for customers!

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud