scribe/CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Added

Changed

Fixed

Removed

[3.2.0] - Wednesday, 12 December 2018

Changed

• API groups are now sorted "naturally" (https://github.com/mpociot/laravel-apidoc-generator/pull/428)

Fixed

• Partial resource controllers are now properly supported (https://github.com/mpociot/laravel-apidoc-generator/pull/429)
• PUT request body now formatted as urlencoded in Postman collection (https://github.com/mpociot/laravel-apidoc-generator/pull/418)
• @responseFile strategy now properly renders responses (https://github.com/mpociot/laravel-apidoc-generator/pull/427)

[3.1.1] - Wednesday, 5 December 2018

Added

• Ability to specify different responses for different status codes. (https://github.com/mpociot/laravel-apidoc-generator/pull/416)

[3.1.0] - Wednesday, 28 November 2018

Added

• Add ResponseFileStrategy to retrieve responses from files. (https://github.com/mpociot/laravel-apidoc-generator/pull/410)

Modified

• Switch from jQuery to fetch in JavaScript examples. (https://github.com/mpociot/laravel-apidoc-generator/pull/411)

[3.0.6] - Saturday, 24 November 2018

Added

• include and exclude route options now support wildcards (https://github.com/mpociot/laravel-apidoc-generator/pull/409)

[3.0.5] - Thursday, 15 November 2018

Fixed

• Make router option case-insensitive (https://github.com/mpociot/laravel-apidoc-generator/pull/407)

[3.0.4] - Wednesday, 7 November 2018

Fixed

• Replaced use of Storage::copy with PHP's copy to work with absolute paths (https://github.com/mpociot/laravel-apidoc-generator/pull/404)

[3.0.3] - Friday, 2 November 2018

Fixed

• Replaced use of config_path with more generic option for better Lumen compatibility (https://github.com/mpociot/laravel-apidoc-generator/pull/398)

[3.0.2] - Friday, 26 October 2018

Added

• Ability to specify examples for body and query parameters (https://github.com/mpociot/laravel-apidoc-generator/pull/394)

  Fixed

• Rendering of example requests' descriptions (https://github.com/mpociot/laravel-apidoc-generator/pull/393)

[3.0.1] - Monday, 22 October 2018

Fixed

• Rendering of query parameters' descriptions (https://github.com/mpociot/laravel-apidoc-generator/pull/387)

[3.0] - Sunday, 21 October 2018

Added

• Official Lumen support (https://github.com/mpociot/laravel-apidoc-generator/pull/382)
• @queryParam annotation (https://github.com/mpociot/laravel-apidoc-generator/pull/383)
• @bodyParam annotation (https://github.com/mpociot/laravel-apidoc-generator/pull/362, https://github.com/mpociot/laravel-apidoc-generator/pull/366)
• @authenticated annotation (https://github.com/mpociot/laravel-apidoc-generator/pull/369)
• Ability to override the controller @group from the method. (https://github.com/mpociot/laravel-apidoc-generator/pull/372)
• Ability to use a custom logo (https://github.com/mpociot/laravel-apidoc-generator/pull/368)

Changed

• Moved from command-line options to a config file (https://github.com/mpociot/laravel-apidoc-generator/pull/362)
• Commands have been renamed to the apidoc namespace (previously api). (https://github.com/mpociot/laravel-apidoc-generator/pull/350)
• The update command has been renamed to rebuild and now uses the output path configured in the config file. (https://github.com/mpociot/laravel-apidoc-generator/pull/370)
• @resource renamed to @group (https://github.com/mpociot/laravel-apidoc-generator/pull/371)
• Added more configuration options for response calls (https://github.com/mpociot/laravel-apidoc-generator/pull/377)

Fixed

Removed

• FormRequest parsing is no longer supported (https://github.com/mpociot/laravel-apidoc-generator/pull/362)