summaryrefslogtreecommitdiffstats
path: root/CHANGELOG.md
blob: df0c79314de1c94f65e25b916e00cb02925f281c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# Changelog

## 0.2.0

- `CepNotFoundException` now carries `faixa`: the municipality the CEP would
  have belonged to, when the API names one. Still a 404 — it is context for the
  error, not an address.
- New `Faixa` model. Its `cepIni`/`cepFim` are the smallest and the largest CEP
  that *exist* in the municipality, not the Correios' published bounds, and the
  interval between them is sparse — read `ceps` for how sparse.
- `CepNotFoundException.toString` mentions the municipality when there is one.
- A missing, empty or malformed `faixa` yields `null` and never turns a
  not-found into a parse failure.

## 0.1.0

- First release: `lookup`, `lookupMany`, `health` and `normalizeCep`, with
  retries, full-jitter backoff and `Retry-After` handling.