Releases: bearsunday/BEAR.ApiDoc
Releases · bearsunday/BEAR.ApiDoc
1.8.0
Added
- Add
#[Input]parameter expansion support for API documentation (#74)- Parameters annotated with
#[Input]are expanded to their constructor parameters in generated docs - Applied consistently across HTML, Markdown, and OpenAPI generators
- Parameters annotated with
- Add ALPS semantic dictionary fallback for empty descriptions (#73) Thanks @jingu
- When description is empty, ALPS profile
title,doc, ordefis used as fallback - Applied to request parameters and response properties in HTML output
- When description is empty, ALPS profile
- Add
ray/input-queryas direct dependency
Fixed
- Fix XSD path in
ConfigGeneratortemplate:vendor/bear/apidoc→vendor/bear/api-doc
1.7.0
Added
- Add
llmsformat for AI-readable documentation (llms.txt) (#70) - Support multiple output formats in single run with comma-separated values (#71)
- Example:
<format>html,openapi,llms</format>
- Example:
- Default to
./apidoc.xmlwhen-coption is not specified
Changed
- Update
apidoc.xml.distdefault format tohtml,openapi,llms - Convert internal Generator to array for multiple format iteration
1.6.0
1.5.0
Highlights
Hypermedia HTML
Generated HTML now fully supports hypermedia principles:
<link rel="profile">references ALPS profile- Semantic markup on all elements
- Links to JSON Schema files
- Embedded resources and hyperlinks display
GitHub Actions Workflow
Automate documentation generation and publishing:
uses: bearsunday/BEAR.ApiDoc/.github/workflows/apidoc.yml@v1ALPS Semantic Profiles
Machine-readable profiles for AI and tools:
alps/apidoc.xml- Defines meaning of HTML elementsalps/index-schema.xml- Schema index semantics
Added
- Hypermedia HTML output with semantic markup
- GitHub Actions reusable workflow
- ALPS semantic profiles
- External CSS (
apidoc.css) schemas/index.htmlwithrel="schema"links- Markdown and OpenAPI 3.1 formats
Changed
- PHP 8.2+ required
schema/→schemas/
Breaking Changes
schema/directory renamed toschemas/- ApiDoc::__invoke() signature changed
1.4.0
What's Changed
Major Changes
- Remove doctrine/annotations dependency - Migrate to native PHP 8 Reflection API for reading attributes (#51)
doctrine/annotationspackage is abandoned and no longer maintained- All annotation reading now uses native PHP 8
ReflectionMethod::getAttributes() - Better performance with native reflection instead of annotation reader abstraction
- All test fixtures converted from annotations to PHP 8 attributes
Improvements
- Simpler codebase with fewer abstractions
- Reduced code by 30+ lines
- Modern PHP 8+ syntax with native attributes
- All quality checks passing (PHPStan, PHPCS, PHPUnit)
Fixes
- Fix test router configuration for bear/aura-router-module upgrade
- Remove conflicting 'bin' script from composer.json
Breaking Changes
None - This is fully backward compatible for users who have already migrated to PHP 8 attributes.
Full Changelog: 1.3.1...1.4.0
1.3.1
What's Changed
- Update CI configuration for PHP 8.4 by @koriym in #49
- Allow rize/uri-template v0.4 by @NaokiTsuchiya in #50
Full Changelog: 1.3.0...1.3.1
1.3.0
1.2.0
1.1.3
What's Changed
- Fix require by @apple-x-co in #45
New Contributors
- @apple-x-co made their first contribution in #45
Full Changelog: 1.1.2...1.1.3