From 770998fc7c688e78632a45a828ce5096e838a2a5 Mon Sep 17 00:00:00 2001 From: Ronald van der Meer Date: Mon, 30 Mar 2026 01:34:58 +0200 Subject: [PATCH 1/2] Fix ETag wording in docs/index.md key features section ETag is a response header sent by the server; the client sends If-None-Match. Rephrased to: 'sends If-None-Match with the cached ETag' to avoid implying ETag is a request header. Addresses Copilot review comment on #14. --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 0d33874..4a7663d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ Async Python client library for the [Eve Online ESI API](https://esi.evetech.net ## Key features -- **Two-layer caching** — respects the ESI `Expires` header to skip HTTP requests entirely within the cache window, and sends `If-None-Match` / ETag headers so unchanged responses return HTTP 304 without a response body. Both layers work automatically with no configuration required. +- **Two-layer caching** — respects the ESI `Expires` header to skip HTTP requests entirely within the cache window, and sends `If-None-Match` with the cached ETag so unchanged responses return HTTP 304 without a response body. Both layers work automatically with no configuration required. - **Automatic pagination** — paginated endpoints (`async_get_wallet_journal()`, `async_get_contacts()`, `async_get_killmails()`) fetch all pages transparently and return a single combined list. - **23 endpoints** covering public and auth-gated ESI resources — see [Endpoints](endpoints.md) for the full list. - **Typed models** — all responses are frozen dataclasses with full type annotations and PEP 561 `py.typed` marker. From 30c1eb758b7a2a04af96af00a1476d20423745d4 Mon Sep 17 00:00:00 2001 From: Ronald van der Meer Date: Mon, 30 Mar 2026 01:38:20 +0200 Subject: [PATCH 2/2] Apply Copilot suggestion: format ETag as code in index.md --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 4a7663d..d839b33 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ Async Python client library for the [Eve Online ESI API](https://esi.evetech.net ## Key features -- **Two-layer caching** — respects the ESI `Expires` header to skip HTTP requests entirely within the cache window, and sends `If-None-Match` with the cached ETag so unchanged responses return HTTP 304 without a response body. Both layers work automatically with no configuration required. +- **Two-layer caching** — respects the ESI `Expires` header to skip HTTP requests entirely within the cache window, and sends `If-None-Match` with the cached `ETag` so unchanged responses return HTTP 304 without a response body. Both layers work automatically with no configuration required. - **Automatic pagination** — paginated endpoints (`async_get_wallet_journal()`, `async_get_contacts()`, `async_get_killmails()`) fetch all pages transparently and return a single combined list. - **23 endpoints** covering public and auth-gated ESI resources — see [Endpoints](endpoints.md) for the full list. - **Typed models** — all responses are frozen dataclasses with full type annotations and PEP 561 `py.typed` marker.