Skip to content

Tags: laminas-api-tools/api-tools-documentation

Tags

1.6.0

Toggle 1.6.0's commit message

Verified

This tag was signed with the committer’s verified signature.
laminas-bot Laminas Bot
### Release Notes for [1.6.0](https://github.com/laminas-api-tools/ap…

…i-tools-documentation/milestone/7)

### Added

This release adds support for PHP 8.2.

### Removed

This release removes support for PHP 7 releases.

### 1.6.0

- Total issues resolved: **0**
- Total pull requests resolved: **2**
- Total contributors: **2**

#### Enhancement

 - [32: Drop PHP 7 support, add PHP 8.2 support](#32) thanks to @weierophinney
 - [30: Apply PHP 7.4 syntax](#30) thanks to @samsonasik

1.5.0

Toggle 1.5.0's commit message

Verified

This tag was signed with the committer’s verified signature.
laminas-bot Laminas Bot
### Release Notes for [1.5.0](https://github.com/laminas-api-tools/ap…

…i-tools-documentation/milestone/3)

### Added

- This release adds support for PHP 8.1.

### Removed

- This release removes support for PHP versions prior to 7.3.

- This release removes support for laminas-mvc v2 releases.

- This release removes support for laminas-servicemanager v2 releases.

- This release removes support for laminas-stdlib v2 releases.

### 1.5.0

- Total issues resolved: **2**
- Total pull requests resolved: **2**
- Total contributors: **2**

#### Enhancement

 - [29: Provide support for PHP 8.1](#29) thanks to @weierophinney
 - [27: Provide support for PHP 8.1.](#27) thanks to @weierophinney

#### Bug

 - [28: Add "extra.laminas.module" configuration to package](#28) thanks to @weierophinney and @haclong

1.4.1

Toggle 1.4.1's commit message

Verified

This tag was signed with the committer’s verified signature.
laminas-bot Laminas Bot
### Release Notes for [1.4.1](https://github.com/laminas-api-tools/ap…

…i-tools-documentation/milestone/2)

### Fixed

- This release adds the missing `~8.0.0` PHP constraint that was reported to be in the 1.4.0 release.

### 1.4.1

- Total issues resolved: **0**
- Total pull requests resolved: **1**
- Total contributors: **1**

#### Bug

 - [24: Missing php 8 in composer.json](#24) thanks to @snapshotpl

1.4.0

Toggle 1.4.0's commit message

Verified

This tag was signed with the committer’s verified signature.
laminas-bot Laminas Bot
### Release Notes for [1.4.0](https://github.com/laminas-api-tools/ap…

…i-tools-documentation/milestone/1)

### Added

- This release adds support for PHP 7.4 and 8.0.

### Removed

- This release removes support for PHP versions prior to 7.3.

### 1.4.0

- Total issues resolved: **0**
- Total pull requests resolved: **3**
- Total contributors: **2**

#### Enhancement

 - [23: WIP: Add support for PHP 8](#23) thanks to @internalsystemerror
 - [21: Switch to GHA CI workflow](#21) thanks to @internalsystemerror

#### Enhancement,hacktoberfest-accepted

 - [18: Qa/psalm](#18) thanks to @superrosko

1.3.0

Toggle 1.3.0's commit message
api-tools-documentation 1.3.0

Based on https://github.com/zfcampus/zf-apigility-documentation/releases/tag/1.3.0 (commit 38dfeeab304c9aa928b5ca84326c8f555d83c36f in this repo)

Added
-----

- [zfcampus/zf-apigility-documentation#69](zfcampus/zf-apigility-documentation#69) adds support for PHP 7.1 and 7.2.

- [zfcampus/zf-apigility-documentation#59](zfcampus/zf-apigility-documentation#59) adds the ability to specify examples for fields.

Changed
-------

- [zfcampus/zf-apigility-documentation#62](zfcampus/zf-apigility-documentation#62) updates the `Laminas\ApiTools\Documentation\Controller` to accept a `BasePath`
  view helper as a construction aregument; this is then used to prefix any generated links with
  the currently detected/configured base path to the application.

Deprecated
----------

- Nothing.

Removed
-------

- [zfcampus/zf-apigility-documentation#69](zfcampus/zf-apigility-documentation#69) removes support for HHVM.

Fixed
-----

- [zfcampus/zf-apigility-documentation#59](zfcampus/zf-apigility-documentation#59) provides a fix to configuration detection that removes an emitted
  notice when no api-tools-rpc and/or no api-tools-rest configuration is present.

- [zfcampus/zf-apigility-documentation#59](zfcampus/zf-apigility-documentation#59) fixes the "api" route parameter constraint to accept `%` characters, which
  are often present when multi-segment namespaces are used for a given API name.

1.2.3

Toggle 1.2.3's commit message
api-tools-documentation 1.2.3

Based on https://github.com/zfcampus/zf-apigility-documentation/releases/tag/1.2.3 (commit 814e9048ecb870a12bf5e4bf773eb49a16fdb474 in this repo)

Added
-----

- Nothing.

Deprecated
----------

- Nothing.

Removed
-------

- Nothing.

Fixed
-----

- [zfcampus/zf-apigility-documentation#49](zfcampus/zf-apigility-documentation#49) fixes
  representation of nested collections.
- [zfcampus/zf-apigility-documentation#50](zfcampus/zf-apigility-documentation#50) fixes
  escaping of field decriptions; previously, the template was improperly using
  `escapeTransformDescription()` instead of `agTransformDescription()`.
- [zfcampus/zf-apigility-documentation#52](zfcampus/zf-apigility-documentation#52) fixes
  output of fields when the `allows_only_fields_in_filter` parameter is present
  for an input filter.

1.2.2

Toggle 1.2.2's commit message
api-tools-documentation 1.3.3

Based on https://github.com/zfcampus/zf-apigility-documentation/releases/tag/1.2.2 (commit 676529cf0c6ca3ab03e2c798fa4284ce9e857f88 in this repo)

Added
-----

- Nothing.

Deprecated
----------

- Nothing.

Removed
-------

- Nothing.

Fixed
-----

- [zfcampus/zf-apigility-documentation#53](zfcampus/zf-apigility-documentation#53) fixes an
  import statement in the configuration file.

1.2.1

Toggle 1.2.1's commit message
api-tools-documentation 1.2.1

Based on https://github.com/zfcampus/zf-apigility-documentation/releases/tag/1.2.1 (commit 526fc78d4e377135d0b5c7de972aee61ee571813 in this repo)

Added
-----

- Nothing.

Deprecated
----------

- Nothing.

Removed
-------

- Nothing.

Fixed
-----

- [zfcampus/zf-apigility-documentation#48](zfcampus/zf-apigility-documentation#48) updates
  the `ControllerFactory` implementation to be forwards compatible with
  laminas-servicemanager v3.

1.2.0

Toggle 1.2.0's commit message
api-tools-documentation 1.2.0

Based on https://github.com/zfcampus/zf-apigility-documentation/releases/tag/1.2.0 (commit 17a53b6d080f2d7c753f9e1b4821959609c0d362 in this repo)

Added
-----

- [zfcampus/zf-apigility-documentation#43](zfcampus/zf-apigility-documentation#43) adds
  support for v3 releases of Laminas components, while retaining support
  for v2 releases.
- [zfcampus/zf-apigility-documentation#43](zfcampus/zf-apigility-documentation#43) extracts
  the `ApiFactory` factory inlined in the `Module` class to a first-class
  factory, `Laminas\ApiTools\Documentation\Factory\ApiFactoryFactory`.
- [zfcampus/zf-apigility-documentation#19](zfcampus/zf-apigility-documentation#19) adds
  support for displaying documentation of APIs with nested namespaces (e.g.,
  `Company\ApiName` vs just `ApiName`). Such services are now denoted with
  dot-notation: `Company.ApiName`.
- [zfcampus/zf-apigility-documentation#35](zfcampus/zf-apigility-documentation#35) adds
  a new view helper, `agTransformDescription()`, which will transform markdown
  descriptions to HTML. This is now used by default in the supplied view
  scripts. **This means you can now use markdown in your API descriptions!**
- [zfcampus/zf-apigility-documentation#38](zfcampus/zf-apigility-documentation#38) updates
  the `Field` class to allow setting the field type, and updates the operation
  view script to now display field types for given operations.

Deprecated
----------

- Nothing.

Removed
-------

- [zfcampus/zf-apigility-documentation#43](zfcampus/zf-apigility-documentation#43) removes
  support for PHP 5.5.

Fixed
-----

- Nothing.

1.1.1

Toggle 1.1.1's commit message
api-tools-documentation 1.1.1

Based on https://github.com/zfcampus/zf-apigility-documentation/releases/tag/1.1.1 (commit e33243910bbb5d92c892e42dcb5a1ccff6cd766c in this repo)

Added
-----

- Nothing.

Deprecated
----------

- Nothing.

Removed
-------

- Nothing.

Fixed
-----

- [zfcampus/zf-apigility-documentation#39](zfcampus/zf-apigility-documentation#39) updates
  the component to properly display information about laminas-inputfilter
  Collections when displaying operation validation information.
- [zfcampus/zf-apigility-documentation#40](zfcampus/zf-apigility-documentation#40) updates
  the Operations view script to:
  - display HTTP method-specific fields first, if present.
  - display general fields only if they exist (the fix prevents an empty row
    displaying).
  - insert a closing `</span>` tag within the table data cell containing the
    required flag.
- [zfcampus/zf-apigility-documentation#41](zfcampus/zf-apigility-documentation#41) updates
  the `ApiFactory` to ensure that if an entity has no collection associated with
  it, documentation will not attempt to retrieve the fields.