Skip to content

Commit cfd71d0

Browse files
committed
security scheme documentation updates
1 parent af6bac1 commit cfd71d0

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

aws_lambda_powertools/event_handler/openapi/models.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ class SecuritySchemeType(Enum):
363363
http = "http"
364364
oauth2 = "oauth2"
365365
openIdConnect = "openIdConnect"
366-
mutualTLS = 'mutualTLS'
366+
mutualTLS = "mutualTLS"
367367

368368

369369
class SecurityBase(OpenAPIExtensions):

docs/core/event_handler/api_gateway.md

+1
Original file line numberDiff line numberDiff line change
@@ -1111,6 +1111,7 @@ OpenAPI 3 lets you describe APIs protected using the following security schemes:
11111111
| [API keys](https://swagger.io/docs/specification/authentication/api-keys/https://swagger.io/docs/specification/authentication/api-keys/){target="_blank"} (e.g: query strings, cookies) | `APIKey` | API keys in headers, query strings or [cookies](https://swagger.io/docs/specification/authentication/cookie-authentication/){target="_blank"}. |
11121112
| [OAuth 2](https://swagger.io/docs/specification/authentication/oauth2/){target="_blank"} | `OAuth2` | Authorization protocol that gives an API client limited access to user data on a web server. |
11131113
| [OpenID Connect Discovery](https://swagger.io/docs/specification/authentication/openid-connect-discovery/){target="_blank"} | `OpenIdConnect` | Identity layer built [on top of the OAuth 2.0 protocol](https://openid.net/developers/how-connect-works/){target="_blank"} and supported by some OAuth 2.0. |
1114+
| [Mutual TLS](https://swagger.io/specification/#security-scheme-object){target="_blank"}. | `MutualTLS` | Client/server certificate mutual authentication scheme. |
11141115

11151116
???-note "Using OAuth2 with the Swagger UI?"
11161117
You can use the `OAuth2Config` option to configure a default OAuth2 app on the generated Swagger UI.

0 commit comments

Comments
 (0)