Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit aa0e0d3

Browse files
committedJul 9, 2024
Adding docstring
1 parent 06c8e23 commit aa0e0d3

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed
 

‎aws_lambda_powertools/event_handler/api_gateway.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,8 @@ def __init__(
361361
Whether or not to include this route in the OpenAPI schema
362362
security: List[Dict[str, List[str]]], optional
363363
The OpenAPI security for this route
364+
openapi_extensions: Dict[str, Any], optional
365+
Additional OpenAPI extensions as a dictionary.
364366
middlewares: Optional[List[Callable[..., Response]]]
365367
The list of route middlewares to be called in order.
366368
"""
@@ -1591,6 +1593,8 @@ def get_openapi_schema(
15911593
A declaration of the security schemes available to be used in the specification.
15921594
security: List[Dict[str, List[str]]], optional
15931595
A declaration of which security mechanisms are applied globally across the API.
1596+
openapi_extensions: Dict[str, Any], optional
1597+
Additional OpenAPI extensions as a dictionary.
15941598
15951599
Returns
15961600
-------
@@ -1781,6 +1785,8 @@ def get_openapi_json_schema(
17811785
A declaration of the security schemes available to be used in the specification.
17821786
security: List[Dict[str, List[str]]], optional
17831787
A declaration of which security mechanisms are applied globally across the API.
1788+
openapi_extensions: Dict[str, Any], optional
1789+
Additional OpenAPI extensions as a dictionary.
17841790
17851791
Returns
17861792
-------
@@ -1874,6 +1880,8 @@ def enable_swagger(
18741880
The OAuth2 configuration for the Swagger UI.
18751881
persist_authorization: bool, optional
18761882
Whether to persist authorization data on browser close/refresh.
1883+
openapi_extensions: Dict[str, Any], optional
1884+
Additional OpenAPI extensions as a dictionary.
18771885
"""
18781886
from aws_lambda_powertools.event_handler.openapi.compat import model_json
18791887
from aws_lambda_powertools.event_handler.openapi.models import Server

0 commit comments

Comments
 (0)
Please sign in to comment.