Changelog
Phase 2 docs package
Section titled “Phase 2 docs package”- Created a standalone
@afterlib/api-docspackage for public API documentation. - Added editorial guides for authentication, credits, ads, pages, collections, pagination, errors, and request logs.
- Added a Scalar API reference generated from the public OpenAPI snapshot.
- Added validation scripts to keep the published OpenAPI snapshot limited to the public API surface.
Change types
Section titled “Change types”Public API changes should be classified before the docs are published:
- Breaking: removes an endpoint, removes a response field, changes a field type, adds a required request field, removes a scope, changes credit charging behavior, or changes an error code that clients can handle.
- Non-breaking: adds an optional request field, adds a response field, adds a new endpoint, adds an example, or clarifies wording without changing behavior.
- Deprecation: keeps behavior working while announcing a future removal or replacement.
- Docs-only: changes examples, navigation, or explanations without changing the OpenAPI contract.
Breaking changes need a migration note, a changelog entry, and product approval before public launch. Deprecations should include the old behavior, the replacement, and the removal date once that date is known.
Entry format
Section titled “Entry format”Use this format for future entries:
## YYYY-MM-DD
- **Non-breaking:** Added ...- **Breaking:** Changed ...- **Deprecation:** Deprecated ...- **Docs-only:** Clarified ...