Skip to content

Commit e27bebf

Browse files
Addressing Heitor's feedback
1 parent b9fb77b commit e27bebf

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

docs/core/event_handler/api_gateway.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1032,8 +1032,7 @@ Below is an example configuration for serving Swagger UI from a custom path or C
10321032
???-info "Does Powertools implement any of the security schemes?"
10331033
No. Powertools adds support for generating OpenAPI documentation with [security schemes](https://swagger.io/docs/specification/authentication/), but it doesn't implement any of the security schemes itself, so you must implement the security mechanisms separately.
10341034

1035-
OpenAPI uses the term security scheme for [authentication and authorization schemes](https://swagger.io/docs/specification/authentication/){target="_blank"}.
1036-
When you're describing your API, declare security schemes at the top level, and reference them globally or per operation. Remember to have the security configurations defined in the `security_schemes`, otherwise a `SchemaValidationError` will be raised.
1035+
Security schemes are declared at the top-level first. You can reference them globally or on a per path _(operation)_ level. **However**, if you reference security schemes that are not defined at the top-level it will lead to a `SchemaValidationError` _(invalid OpenAPI spec)_.
10371036

10381037
=== "Global OpenAPI security schemes"
10391038

0 commit comments

Comments
 (0)