Skip to content

Commit 2b4e920

Browse files
committed
clarify v2 snapshot metadata
1 parent 477ea4e commit 2b4e920

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

docs/v2/affinity_api_docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This markdown version of the Affinity API v2 documentation was generated automat
2525
> **Note:** The live site renders dynamic multi-language request/response samples in-browser. Because those snippets are generated at runtime and are not embedded in the OpenAPI payload, they cannot be mirrored here. Refer to https://developer.affinity.co/ for the full interactive samples.
2626

2727
**Documentation Version:** This copy is based on the official documentation as it appeared on **November 05, 2025 at 18:08:51 UTC** (Last updated: 11/05/2025 18:08:51 UTC).
28-
**Snapshot:** `tmp/v2/developer_affinity_co.html`
28+
**Snapshot:** Captured HTML `developer_affinity_co.html` (archived with the sync artifacts for QA).
2929

3030
> **⚠️ Use at Your Own Risk**
3131
>

tools/v2_sync_pipeline/markdown_renderer.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
import textwrap
77
from dataclasses import dataclass
88
from datetime import datetime
9+
from pathlib import Path
910
from typing import Any, Dict, Iterable, List, Tuple
1011

1112
from .utils import build_toc, normalize_whitespace, format_description, fix_mojibake, slugify
@@ -241,6 +242,7 @@ def build(self) -> str:
241242
def _render_header(self, toc: str) -> str:
242243
long_ts = self.ctx.fetched_at.strftime("%B %d, %Y at %H:%M:%S %Z")
243244
short_ts = self.ctx.fetched_at.strftime("%m/%d/%Y %H:%M:%S %Z")
245+
snapshot_label = Path(self.ctx.snapshot_path).name if self.ctx.snapshot_path else "N/A"
244246
lines = [
245247
"# Affinity API v2 Documentation (Auto-synced)",
246248
"",
@@ -269,7 +271,7 @@ def _render_header(self, toc: str) -> str:
269271
"> **Note:** The live site renders dynamic multi-language request/response samples in-browser. Because those snippets are generated at runtime and are not embedded in the OpenAPI payload, they cannot be mirrored here. Refer to https://developer.affinity.co/ for the full interactive samples.",
270272
"",
271273
f"**Documentation Version:** This copy is based on the official documentation as it appeared on **{long_ts}** (Last updated: {short_ts}).",
272-
f"**Snapshot:** `{self.ctx.snapshot_path}`",
274+
f"**Snapshot:** Captured HTML `{snapshot_label}` (archived with the sync artifacts for QA).",
273275
"",
274276
"> **⚠️ Use at Your Own Risk**",
275277
">",

0 commit comments

Comments
 (0)