Skip to content

Releases: bearsunday/BEAR.ApiDoc

1.8.0

16 Feb 17:10

Choose a tag to compare

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
  • Add ALPS semantic dictionary fallback for empty descriptions (#73) Thanks @jingu
    • When description is empty, ALPS profile title, doc, or def is used as fallback
    • Applied to request parameters and response properties in HTML output
  • Add ray/input-query as direct dependency

Fixed

  • Fix XSD path in ConfigGenerator template: vendor/bear/apidocvendor/bear/api-doc

1.7.0

11 Jan 05:29

Choose a tag to compare

Added

  • Add llms format 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>
  • Default to ./apidoc.xml when -c option is not specified

Changed

  • Update apidoc.xml.dist default format to html,openapi,llms
  • Convert internal Generator to array for multiple format iteration

1.6.0

09 Jan 08:54

Choose a tag to compare

Added

  • Add apidoc init command to generate apidoc.xml from composer.json
  • Add helpful error message suggesting apidoc init when config not found
  • Add backwards compatibility symlink schema -> schemas

1.5.0

09 Jan 02:15
496f920

Choose a tag to compare

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@v1

ALPS Semantic Profiles

Machine-readable profiles for AI and tools:

  • alps/apidoc.xml - Defines meaning of HTML elements
  • alps/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.html with rel="schema" links
  • Markdown and OpenAPI 3.1 formats

Changed

  • PHP 8.2+ required
  • schema/schemas/

Breaking Changes

  • schema/ directory renamed to schemas/
  • ApiDoc::__invoke() signature changed

1.4.0

22 Nov 15:17

Choose a tag to compare

What's Changed

Major Changes

  • Remove doctrine/annotations dependency - Migrate to native PHP 8 Reflection API for reading attributes (#51)
    • doctrine/annotations package 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

28 Feb 13:19

Choose a tag to compare

What's Changed

Full Changelog: 1.3.0...1.3.1

1.3.0

09 Jun 11:46
dcd8051

Choose a tag to compare

What's Changed

  • Stop supporting PHP 7.1 and minimum required version 8.1 by @koriym in #48

Full Changelog: 1.2.0...1.3.0

1.2.0

11 Jan 01:26
acf3535

Choose a tag to compare

What's Changed

  • Enable php 8.3 compat and support for newer version dependencies by @koriym in #46

Full Changelog: 1.1.3...1.14

1.1.3

07 Jul 16:19
b780288

Choose a tag to compare

What's Changed

New Contributors

Full Changelog: 1.1.2...1.1.3

1.1.2

01 Mar 09:02
b226de2

Choose a tag to compare

What's Changed

  • fix set require/description issue from schema prop by @jingu in #43

New Contributors

  • @jingu made their first contribution in #43

Full Changelog: 1.1.1...1.1.2