From 6403f9228f8b3ea92d9d7da43e851392b920887a Mon Sep 17 00:00:00 2001 From: Renn F Date: Thu, 15 Oct 2026 15:02:58 +0200 Subject: [PATCH] docs(changelog): use the bullet style for the v8.1.1 notes The v8.1.1 section used ### headings, which the docs lint rejects (MD003 heading-style: the file uses setext headings). The categories now lead each bullet, matching earlier entries. --- CHANGELOG.md | 12 +++--------- docs/release-notes.md | 12 +++--------- 2 files changed, 6 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c52b63a7..bcbeee9b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,17 +9,11 @@ v8.1.1 (2026-10-15) The pure-ASGI metrics release: the pass-through path records request metrics like the classic middleware (v8.1.1) ----------------------------------------------------------------------------------------------------------------- -### Fixed +- **Fixed** - **`PureASGISecurityMiddleware` records request metrics on the pass-through path** (fastapi-guard #163, #164). The pure-ASGI middleware now records request metrics when the response starts, matching the classic middleware: `response_time` stops at the response start, and the body is still streamed, never buffered. Tests cover allowed, error and streaming responses. -- **`PureASGISecurityMiddleware` records request metrics on the pass-through path** (fastapi-guard #163, #164). The pure-ASGI middleware now records request metrics when the response starts, matching the classic middleware: `response_time` stops at the response start, and the body is still streamed, never buffered. Tests cover allowed, error and streaming responses. +- **Note** - The `guard-core` dependency floor rises from `>=4.1.0` to `>=4.4.0`, so upgrading fastapi-guard also brings the guard-core 4.4.0 detection and dynamic rule fixes (Cookie header scanned per pair, the per-request scan budget, the semantic-only header opt-out and dynamic rule versions applied over the base config). -### Note - -- The `guard-core` dependency floor rises from `>=4.1.0` to `>=4.4.0`, so upgrading fastapi-guard also brings the guard-core 4.4.0 detection and dynamic rule fixes (Cookie header scanned per pair, the per-request scan budget, the semantic-only header opt-out and dynamic rule versions applied over the base config). - -### Chore - -- The sponsor button points at the maintainer's Sponsors page, the mkdocs `site_url` drops `/latest/` so canonical URLs resolve, the family Discord relay workflow was added, and the `upload-sarif` action was bumped (fastapi-guard #158, #159, #161, #162). +- **Chore** - The sponsor button points at the maintainer's Sponsors page, the mkdocs `site_url` drops `/latest/` so canonical URLs resolve, the family Discord relay workflow was added, and the `upload-sarif` action was bumped (fastapi-guard #158, #159, #161, #162). ___ diff --git a/docs/release-notes.md b/docs/release-notes.md index 9ae811b1..a9873eb1 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -16,17 +16,11 @@ v8.1.1 (2026-10-15) The pure-ASGI metrics release: the pass-through path records request metrics like the classic middleware (v8.1.1) ----------------------------------------------------------------------------------------------------------------- -### Fixed +- **Fixed** - **`PureASGISecurityMiddleware` records request metrics on the pass-through path** (fastapi-guard #163, #164). The pure-ASGI middleware now records request metrics when the response starts, matching the classic middleware: `response_time` stops at the response start, and the body is still streamed, never buffered. Tests cover allowed, error and streaming responses. -- **`PureASGISecurityMiddleware` records request metrics on the pass-through path** (fastapi-guard #163, #164). The pure-ASGI middleware now records request metrics when the response starts, matching the classic middleware: `response_time` stops at the response start, and the body is still streamed, never buffered. Tests cover allowed, error and streaming responses. +- **Note** - The `guard-core` dependency floor rises from `>=4.1.0` to `>=4.4.0`, so upgrading fastapi-guard also brings the guard-core 4.4.0 detection and dynamic rule fixes (Cookie header scanned per pair, the per-request scan budget, the semantic-only header opt-out and dynamic rule versions applied over the base config). -### Note - -- The `guard-core` dependency floor rises from `>=4.1.0` to `>=4.4.0`, so upgrading fastapi-guard also brings the guard-core 4.4.0 detection and dynamic rule fixes (Cookie header scanned per pair, the per-request scan budget, the semantic-only header opt-out and dynamic rule versions applied over the base config). - -### Chore - -- The sponsor button points at the maintainer's Sponsors page, the mkdocs `site_url` drops `/latest/` so canonical URLs resolve, the family Discord relay workflow was added, and the `upload-sarif` action was bumped (fastapi-guard #158, #159, #161, #162). +- **Chore** - The sponsor button points at the maintainer's Sponsors page, the mkdocs `site_url` drops `/latest/` so canonical URLs resolve, the family Discord relay workflow was added, and the `upload-sarif` action was bumped (fastapi-guard #158, #159, #161, #162). ___