Skip to content

docs: add patterns_version to /health example in README #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bk86a merged 1 commit into from
Mar 3, 2026
Merged

docs: add patterns_version to /health example in README #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ Returns service status and data statistics.
"total_nuts_names": 2190,
"nuts_version": "2024",
"extra_sources": 0,
"patterns_version": "1.0",
"data_stale": false,
"last_updated": "2025-01-15T12:00:00+00:00"
}
Expand All @@ -174,6 +175,7 @@ Returns service status and data statistics.
| `status` | `ok` if data is loaded, `no_data` otherwise |
| `total_nuts_names` | Number of NUTS region names loaded (0 if names CSV unavailable) |
| `extra_sources` | Number of extra ZIP source URLs configured (0 when not using extra sources) |
| `patterns_version` | Version of the `postal_patterns.json` file |
| `data_stale` | `true` if serving expired cache after a failed TERCET refresh |
| `last_updated` | ISO 8601 timestamp of when TERCET data was last successfully loaded |

Expand Down
Loading