Repository navigation
Releases
v2.3.0
v2.2.1
accepts a bodyless 204 success response without requiring a schema
v2.2.0
What's Changed
- Bump @playwright/test from 1.61.1 to 1.62.0 by @dependabot[bot] in #22
- Bump actions/checkout from 7.0.0 to 7.0.1 by @dependabot[bot] in #21
- Bump @playwright/test from 1.62.0 to 1.62.1 by @dependabot[bot] in #23
- V2.x by @tsitsishvili in #25
Full Changelog: v2.1.0...v2.2.0
v2.1.0
What's Changed
- Bump actions/setup-node from 6.4.0 to 7.0.0 by @dependabot[bot] in #19
- V2.x by @tsitsishvili in #20
Full Changelog: v2.0.3...v2.1.0
v2.0.3
What's Changed
- fix "Pagination parameters documented twice" by @tsitsishvili in #18
Full Changelog: v2.0.2...v2.0.3
v2.0.2
Documentator v2.0.2
This maintenance release restores complete release history after v2.0.1 was published without its required changelog entry.
Included v2.0.1 improvements
- Refined the built-in explorer with softer dark surfaces, borders, shadows, and response panels.
- Enabled automatic text detection and LF line-ending normalization through
.gitattributes.
Release metadata
- Added accurate changelog entries for v2.0.1 and v2.0.2.
- Verified the release tag against the changelog before publication.
Full Changelog: v2.0.1...v2.0.2
v2.0.1
v2.0.0
Documentator v2.0.0
This major release upgrades generated API descriptions to OpenAPI 3.2 and adds first-class support for the HTTP QUERY method.
Highlights
- Added end-to-end HTTP
QUERYsupport across generation, validation, contract diffs, section filtering, Postman exports, the built-in explorer, try-it requests, and code snippets. - Upgraded generated documents from OpenAPI 3.1 to OpenAPI 3.2.
- Reworked portable, Codex, Gemini, Cursor, Boost, and Agent Skills guidance with tested, tool-specific workflows.
- Added a dedicated v2 upgrade guide and cleaned Composer release archives so development-only files are excluded.
Upgrade notes
Existing Laravel routes, configuration, namespaces, and Documentator attributes require no source changes. Before upgrading, confirm that every downstream OpenAPI consumer supports OpenAPI 3.2.
composer require "tsitsishvili/documentator:^2.0" --with-all-dependenciesSee the v2 upgrade guide for the complete migration and rollback checklist.
Full Changelog: v1.8.0...v2.0.0
v1.8.0
Documentator v1.8.0
This release makes Documentator's inference more accurate, explainable, and
better suited to OpenAPI contract enforcement.
Highlights
- Added
documentator:explain METHOD URIto show which extraction strategies
produced each parameter, field, and response. Use--jsonfor tooling. - Added
--fail-on=breakingto
documentator:check --against=<spec>, allowing additive changes while
rejecting breaking contract changes. - Added inference for responses produced by
abort,abort_if,
abort_unless, authorization checks, and recognized HTTP exceptions. - Added PHP 8.5 to the test matrix.
Schema improvements
- Resource fields are now marked required more accurately.
- Conditional
when*andmergeWhenfields are optional instead of nullable. - Resource composition preserves field descriptions,
@vartypes, and
examples. - Spatie Data schemas respect input/output name mapping and
Optionalor
Lazyproperties. - Distinct responses sharing a status code are represented with
oneOf. - OpenAPI comparison now follows local references and checks constraints,
nullability, composites, headers, security scopes, and additional
properties.
Upgrade notes
This release has no intended package-level breaking changes. However,
regenerated OpenAPI documents may change because required fields, conditional
fields, error responses, and same-status response branches are now modeled more
accurately. Review the generated contract diff before updating committed
specifications or generated clients.
composer require tsitsishvili/documentator:^1.8Full Changelog: v1.7.1...v1.8.0