feat(event_handler): support richer top level Tags

[rubenfonseca]

Issue number: #3533

Summary

Changes

Please provide a summary of what's being changed

This PR adds support for richer top level Tags, acording to the OpenAPI specification.

User experience

Please share what the user experience looks like before and after this change

This code:

from pydantic import AnyUrl

from aws_lambda_powertools.event_handler import APIGatewayRestResolver
from aws_lambda_powertools.event_handler.openapi.models import ExternalDocumentation, Tag

app = APIGatewayRestResolver(enable_validation=True)


@app.put("/example-resource")
def put():
    pass


if __name__ == "__main__":
    print(
        app.get_openapi_json_schema(
            tags=[
                Tag(
                    name="Example",
                    description="This is a description",
                    externalDocs=ExternalDocumentation(
                        url=AnyUrl("https://example.org", scheme="https"),
                        description="Example website",
                    ),
                ),
            ],
        ),
    )

Now produces the following OpenAPI json schema

{
  ...
  "tags": [
    {
      "name": "Example",
      "description": "This is a description",
      "externalDocs": {
        "description": "Example website",
        "url": "https://example.org"
      }
    }
  ]
}

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.

[sonarqubecloud]

Quality Gate passed

Kudos, no new issues were introduced!

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

See analysis details on SonarCloud