Feature request: add Support for Top-level externalDocs property in OpenAPI schema

[leandrodamascena]

Use case

Currently, there is no way for users to specify the top-level externalDocs property in the OpenAPI schema generation, despite having an existing data model for ExternalDocumentation in the repository. This issue proposes adding an argument to the configure_openapi() and enable_swagger() methods that allows users to pass an ExternalDocumentation object, enabling them to include links to external documentation in the generated OpenAPI specification as defined in the OpenAPI 3.1 specification.

Solution/User Experience

Add this field

Alternative solutions

Acknowledgment

• This feature request meets Powertools for AWS Lambda (Python) Tenets
• Should this be considered in other Powertools for AWS Lambda languages? i.e. Java, TypeScript, and .NET

[dreamorosi]

@leandrodamascena please ask the contributor to leave a comment under this issue so we can assign it to them and remove it from triage.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

[mhindery]

Thanks for quickly jumping on this and getting my PR through!