Skip to content

Commit c8204ca

Browse files
dreamorosiAndrea Amorosi
dreamorosi
and
Andrea Amorosi
authored
chore(docs): fix broken images (#7644)
Co-authored-by: Andrea Amorosi <aamorosi@amazon.es>
1 parent 36aa440 commit c8204ca

File tree

3 files changed

+26
-27
lines changed

3 files changed

+26
-27
lines changed

‎docs/contributing/setup.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Setting up your development environment for contribution
55

66
<!-- markdownlint-disable MD043 -->
77

8-
[![Join our Discord](https://dcbadge.vercel.app/api/server/B8zZKbbyET)](https://discord.gg/B8zZKbbyET){target="_blank" rel="nofollow"}
8+
[![Join our Discord](https://img.shields.io/badge/Discord-Join_Community-7289da.svg)](https://discord.gg/B8zZKbbyET){target="_blank"}
99

1010
This page describes how to setup your development environment (Cloud or locally) to contribute to Powertools for AWS Lambda.
1111

‎docs/core/event_handler/api_gateway.md‎

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -221,11 +221,11 @@ Dynamic path parameters are defined using angle brackets `<parameter_name>` synt
221221
* **Parameter names** must contain only word characters (letters, numbers, underscore)
222222
* **Captured values** can contain letters, numbers, underscores, and these special characters: `-._~()'!*:@,;=+&$%<> \[]{}|^`. Reserved characters must be percent-encoded in URLs to prevent errors.
223223

224-
| Route Pattern | Matches | Doesn't Match |
225-
|---------------|---------|---------------|
226-
| `/users/<user_id>` | `/users/123`, `/users/user-456` | `/users/123/profile` |
227-
| `/api/<version>/users` | `/api/v1/users`, `/api/2.0/users` | `/api/users` |
228-
| `/files/<path>` | `/files/document.pdf`, `/files/folder%20name` | `/files/sub/folder/file.txt` |
224+
| Route Pattern | Matches | Doesn't Match |
225+
| ------------------------ | ------------------------------------------------ | ---------------------------- |
226+
| `/users/<user_id>` | `/users/123`, `/users/user-456` | `/users/123/profile` |
227+
| `/api/<version>/users` | `/api/v1/users`, `/api/2.0/users` | `/api/users` |
228+
| `/files/<path>` | `/files/document.pdf`, `/files/folder%20name` | `/files/sub/folder/file.txt` |
229229
| `/files/<folder>/<name>` | `/files/src/document.pdf`, `/files/src/test.txt` | `/files/sub/folder/file.txt` |
230230

231231
=== "routing_syntax_basic.py"
@@ -253,12 +253,12 @@ For scenarios where you need to handle arbitrary or deeply nested paths, you can
253253

254254
You can use standard [Python regex patterns](https://docs.python.org/3/library/re.html#regular-expression-syntax){target="_blank" rel="nofollow"} in your route definitions, for example:
255255

256-
| Pattern | Description | Examples |
257-
|---------|-------------|----------|
258-
| `.+` | Matches one or more characters (greedy) | `/proxy/.+` matches `/proxy/any/deep/path` |
259-
| `.*` | Matches zero or more characters (greedy) | `/files/.*` matches `/files/` and `/files/deep/path` |
256+
| Pattern | Description | Examples |
257+
| ------- | ---------------------------------------- | ------------------------------------------------------ |
258+
| `.+` | Matches one or more characters (greedy) | `/proxy/.+` matches `/proxy/any/deep/path` |
259+
| `.*` | Matches zero or more characters (greedy) | `/files/.*` matches `/files/` and `/files/deep/path` |
260260
| `[^/]+` | Matches one or more non-slash characters | `/api/[^/]+` matches `/api/v1` but not `/api/v1/users` |
261-
| `\w+` | Matches one or more word characters | `/users/\w+` matches `/users/john123` |
261+
| `\w+` | Matches one or more word characters | `/users/\w+` matches `/users/john123` |
262262

263263
=== "dynamic_routes_catch_all.py"
264264

@@ -889,12 +889,11 @@ Here's a sample middleware that extracts and injects correlation ID, using `APIG
889889

890890
#### Global middlewares
891891

892-
<center>
893-
![Combining middlewares](../../media/middlewares_normal_processing-light.svg#only-light)
894-
![Combining middlewares](../../media/middlewares_normal_processing-dark.svg#only-dark)
895-
896-
_Request flowing through multiple registered middlewares_
897-
</center>
892+
<figure markdown="span">
893+
![Combining middlewares](../../media/middlewares_normal_processing-light.svg#only-light)
894+
![Combining middlewares](../../media/middlewares_normal_processing-dark.svg#only-dark)
895+
<figcaption>Request flowing through multiple registered middlewares</figcaption>
896+
</figure>
898897

899898
You can use `app.use` to register middlewares that should always run regardless of the route, also known as global middlewares.
900899

@@ -1043,8 +1042,8 @@ This ensures your middlewares can return early responses (401, 403, 429, etc.) w
10431042

10441043
These are native middlewares that may become native features depending on customer demand.
10451044

1046-
| Middleware | Purpose |
1047-
| ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
1045+
| Middleware | Purpose |
1046+
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
10481047
| SchemaValidationMiddleware | Validates API request body and response against JSON Schema, using [Validation utility](../../utilities/validation.md){target="_blank"} |
10491048

10501049
#### Being a good citizen
@@ -1267,13 +1266,13 @@ Security schemes are declared at the top-level first. You can reference them glo
12671266

12681267
OpenAPI 3 lets you describe APIs protected using the following security schemes:
12691268

1270-
| Security Scheme | Type | Description |
1271-
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1272-
| [HTTP auth](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml){target="_blank"} | `HTTPBase` | HTTP authentication schemes using the Authorization header (e.g: [Basic auth](https://swagger.io/docs/specification/authentication/basic-authentication/){target="_blank"}, [Bearer](https://swagger.io/docs/specification/authentication/bearer-authentication/){target="_blank"}) |
1273-
| [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"}. |
1274-
| [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. |
1275-
| [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. |
1276-
| [Mutual TLS](https://swagger.io/specification/#security-scheme-object){target="_blank"}. | `MutualTLS` | Client/server certificate mutual authentication scheme. |
1269+
| Security Scheme | Type | Description |
1270+
| --------------------------------------------------------------------------------------------------------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1271+
| [HTTP auth](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml){target="_blank"} | `HTTPBase` | HTTP authentication schemes using the Authorization header (e.g: [Basic auth](https://swagger.io/docs/specification/authentication/basic-authentication/){target="_blank"}, [Bearer](https://swagger.io/docs/specification/authentication/bearer-authentication/){target="_blank"}) |
1272+
| [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"}. |
1273+
| [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. |
1274+
| [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. |
1275+
| [Mutual TLS](https://swagger.io/specification/#security-scheme-object){target="_blank"}. | `MutualTLS` | Client/server certificate mutual authentication scheme. |
12771276

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

‎docs/we_made_this.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This space is dedicated to highlight our awesome community content featuring Pow
1111

1212
## Connect
1313

14-
[![Join our Discord](https://dcbadge.vercel.app/api/server/B8zZKbbyET)](https://discord.gg/B8zZKbbyET){target="_blank" rel="nofollow"}
14+
[![Join our Discord](https://img.shields.io/badge/Discord-Join_Community-7289da.svg)](https://discord.gg/B8zZKbbyET){target="_blank"}
1515

1616
Join us on [Discord](https://discord.gg/B8zZKbbyET){target="_blank" rel="nofollow"} to connect with the Powertools for AWS Lambda (Python) community 👋. Ask questions, learn from each other, contribute, hang out with key contributors, and more!
1717

0 commit comments

Comments
 (0)