Changelog
This page tracks breaking and notable additive changes to the Auradonors public API. Patch-level fixes that don’t change the contract are not listed; that’s what the error codes catalog is for.
Conventions
Section titled “Conventions”Each entry takes one of two shapes:
- Inline — three sentences or less, written directly under the date heading on this page.
- Linked — a separate file under
changelog/<yyyy-mm-dd>-<slug>.mdwith a longer write-up, summarized here in one line.
Headings follow this format, in reverse-chronological order:
## YYYY-MM-DD — One-line summary
**Breaking change:** (only when applicable)
The body. Two or three short paragraphs is plenty; longer narrativesmove to a linked file.A change that breaks an existing client gets the explicit
**Breaking change:** lead so it surfaces in skim reads. Anything else
is implicitly additive.
Breaking changes are gated
Section titled “Breaking changes are gated”The
breaking-change CI gate
fails any pull request that removes a public symbol from
Aura.Contracts/ without adding a new file under
Aura.Docs.Public/src/content/docs/changelog/. To override:
docs:internal-only— internal refactor, no wire change.docs:no-changelog— false-positive escape hatch.
If you’re seeing a breaking-change warning in your integration without finding a matching changelog entry, that’s a bug — file a ticket.
Versioning
Section titled “Versioning”The API is at v1. The single base URL (https://api.auradonors.com)
is the v1 surface. A future v2 — if it ships — will live at a separate
URL and have its own changelog. Until then, every entry below applies
to the v1 contract.
2026-05-06 — Conventions section split into four pages
Section titled “2026-05-06 — Conventions section split into four pages”The Conventions placeholder was promoted into four discrete pages —
pagination,
errors,
idempotency, and
rate limits.
No wire change. Bookmarked links to /conventions/ still resolve to a
landing page that points at the four sub-pages.
See 2026-05-06 — Conventions split for the full rationale.
2026-05-06 — Initial public-API documentation publication
Section titled “2026-05-06 — Initial public-API documentation publication”The Auradonors public API existed before this date — what’s new is the
narrative documentation around it. Authentication, conventions, webhook
delivery model, recipes, and the curated resource map all landed
together at docs.auradonors.com.
The OpenAPI feed at api.auradonors.com/openapi/v1.json is unchanged;
the Live API explorer renders it directly. Every endpoint
in the feed already carried summaries and descriptions before this
publication — see the previous Phase C documentation work for that
sweep.
See 2026-05-06 — Initial publication for the full rationale.
Earlier
Section titled “Earlier”The API itself shipped iteratively over the year leading up to this publication. Specific endpoint / DTO history before 2026-05-06 isn’t reproduced here — the changelog starts at the first publication date and grows forward.