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.16.0] - Wednesday, 4 September 2019

Added

Support for Laravel 6 (mpociot#572)

[3.15.0] - Saturday, 31 August 2019

Added

Ability to exclude a query or body parameter from being included in the example requests (mpociot#552)

[3.14.0] - Saturday, 31 August 2019

Fixed

Backwards compatibility for the changes to @group introduced in 3.12.0 (https://github.com/mpociot/laravel-apidoc-generator/commit/5647eda35ebb7f8aed35b31790c5f220b736e985)

[3.13.0] (deleted)

[3.12.0] - Sunday, 25 August 2019

Fixed

Specifying an @group for a method no longer requires you to add the description. (mpociot#556)
Pass the verbosity level down to the Collision library. (mpociot#556)

[3.11.0] - Friday, 9 August 2019

Added

Support for query parameters in the bash template (mpociot#545)
Include query parameters and headers in the generated Postman collection (mpociot#537)
Include Python out of the box as example language (mpociot#524)

Changed

Moved nunomaduro/collision to "suggested" so it doesn't break PHP 7.0 (https://github.com/mpociot/laravel-apidoc-generator/commit/2f3a2144e1a4f1eb0229aea8b4d11707cb4aabbf)

Fixed

Stopped using config helper inside config file (mpociot#548)

[3.10.0] - Sunday, 23 June 2019

Added

--verbose flag to show exception encountered when making response calls (https://github.com/mpociot/laravel-apidoc-generator/commit/dc987f296e5a3d073f56c67911b2cb61ae47e9dc)

[3.9.0] - Saturday, 8 June 2019

Modified

Postman collections and URLs in example requests now use the apidoc.base_url config variable (mpociot#523)

[3.8.0] - Wednesday, 29 May 2019

Added

Support for PHP array callable syntax in route action (mpociot#516)

[3.7.3] - Thursday, 23 May 2019

Fixed

Added faker_seed (https://github.com/mpociot/laravel-apidoc-generator/commit/d2901e51a68c17066d4dd96054ff5bfdf124945b)

[3.7.2] - Sunday, 19 May 2019

Added

Support for URL paths in include/exclude rules (mpociot#507)

[3.7.1] - Friday, 17 May 2019

Fixed

Handle exception for no URL::forceRootURL() method in Lumen (https://github.com/mpociot/laravel-apidoc-generator/commit/2146fa114dc18bc32c00b5c5550266d753d5aef3)
Url parameter bindings (https://github.com/mpociot/laravel-apidoc-generator/commit/f0dc118c6b7792894bf9baa352d7fc4ca8ca74b5)

[3.7.0] - Thursday, 2 May 2019

Added

Support for @queryParams in Dingo FormRequests (mpociot#506)
Easier customisation of example languages (https://github.com/mpociot/laravel-apidoc-generator/commit/0aa737a2e54a913eab4d024a1644c5ddd5dee8b8)
Include PHP as example language (https://github.com/mpociot/laravel-apidoc-generator/commit/c5814762fa52095fe645716554839b6ae110ef89)

[3.6.0] - Monday, 29 April 2019

Added

Support for @queryParams in FormRequests (mpociot#504)
Added default_group key to replace ungrouped_name (https://github.com/mpociot/laravel-apidoc-generator/commit/72b5f546c1b84e69fe43c720a04f448c3b96e345)

[3.5.0] - Tuesday, 23 April 2019

Added

Option to seed faker for deterministic output (mpociot#503)
Support for binding prefixes (mpociot#498)
Ability to override Laravel config (mpociot#496)
Allow override of the name 'general' for ungrouped routes (mpociot#491)

Changed

Use parameter-bound URL in doc examples (mpociot#500)

Fixed

Request router now matches when router has sub-domain (mpociot#493)

[3.4.4] - Saturday, 30 March 2019

Fixed

Allow users specify custom Content-type header for Markdown examples (mpociot#486)

[3.4.3] - Wednesday, 13 March 2019

Fixed

Ignore scalar type hints when checking for FormRequests (mpociot#474)

[3.4.2] - Sunday, 10 March 2019

Added

Ability to set cookies on response calls (mpociot#471)

[3.4.1] - Monday, 4 March 2019

Fixed

Support for Lumen 5.7 (mpociot#467)

[3.4.0] - Wednesday, 27 February 2019

Added

Support for Laravel 5.8 (mpociot#462)
Ability to annotate body parameters on FormRequest (mpociot#460)

[3.3.2] - Tuesday, 12 February 2019

Added

Ability to specify array and object body/query params using dot notation (mpociot#445)
Ability to specify name and description of Postman collection (mpociot#443)

Fixed

Postman collection and documentation base URL now uses config('app.url') (mpociot#458)

[3.3.1] - Tuesday, 8 January 2019

Fixed

Fixed vendor tags (mpociot#444)

[3.3.0] - Wednesday, 2 January 2019

Added

Ability to replace json key values in response file (mpociot#434)
Support for custom transfer serializers (mpociot#441)

[3.2.0] - Wednesday, 12 December 2018

Changed

API groups are now sorted "naturally" (mpociot#428)

Fixed

Partial resource controllers are now properly supported (mpociot#429)
PUT request body now formatted as urlencoded in Postman collection (mpociot#418)
@responseFile strategy now properly renders responses (mpociot#427)

[3.1.1] - Wednesday, 5 December 2018

Added

Ability to specify different responses for different status codes. (mpociot#416)

[3.1.0] - Wednesday, 28 November 2018

Added

Add ResponseFileStrategy to retrieve responses from files. (mpociot#410)

Modified

Switch from jQuery to fetch in JavaScript examples. (mpociot#411)

[3.0.6] - Saturday, 24 November 2018

Added

include and exclude route options now support wildcards (mpociot#409)

[3.0.5] - Thursday, 15 November 2018

Fixed

Make router option case-insensitive (mpociot#407)

[3.0.4] - Wednesday, 7 November 2018

Fixed

Replaced use of Storage::copy with PHP's copy to work with absolute paths (mpociot#404)

[3.0.3] - Friday, 2 November 2018

Fixed

Replaced use of config_path with more generic option for better Lumen compatibility (mpociot#398)

[3.0.2] - Friday, 26 October 2018

Added

Ability to specify examples for body and query parameters (mpociot#394)

Fixed

Rendering of example requests' descriptions (mpociot#393)

[3.0.1] - Monday, 22 October 2018

Fixed

Rendering of query parameters' descriptions (mpociot#387)

[3.0] - Sunday, 21 October 2018

Added

Official Lumen support (mpociot#382)
@queryParam annotation (mpociot#383)
@bodyParam annotation (mpociot#362, mpociot#366)
@authenticated annotation (mpociot#369)
Ability to override the controller @group from the method. (mpociot#372)
Ability to use a custom logo (mpociot#368)

Changed

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

Fixed

Removed

FormRequest parsing is no longer supported (mpociot#362)