Skip to content

Latest commit

 

History

History
346 lines (264 loc) · 19.2 KB

CHANGELOG.md

File metadata and controls

346 lines (264 loc) · 19.2 KB
Raw

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

4.8.0 - Saturday, 2 May 2020 (compare to previous)

Added

  • Support @hideFromAPIDocumentation on controllers. (mpociot#745)
  • Allow strategies to return null. (mpociot#739)

4.7.0 - Sunday, 12 April 2020 (compare to previous)

Added

4.6.0 - Wednesday, 8 April 2020 (compare to previous)

Added

  • Allow @authenticated to be set at controller level. (mpociot#726)

4.5.1 - Saturday, 4 April 2020 (compare to previous)

Fixed

4.5.0 - Tuesday, 31 March 2020 (compare to previous)

Fixed

  • Fix version constraints preventing installation on some Laravel 7 installations.

4.4.3 - Thursday, 26 March 2020 (compare to previous)

Fixed

  • Fixed link to Postman connection in docs when Laravel autoload is used (mpociot#714)

4.4.2 - Sunday, 21 March 2020 (compare to previous)

Fixed

  • Fixed double json encode when fetching collection in Laravel type docs (mpociot#713)

4.4.1 - Wednesday, 11 March 2020 (compare to previous)

Added

4.4.0 - Saturday, 7 March 2020 (compare to previous)

Fixed

  • Array query params can now be used and render properly (mpociot#700)

4.3.1 - Friday, 6 March 2020 (compare to previous)

Changed

  • Updated Documentarian dependency for Laravel v7 (mpociot#699)

4.3.0 - Saturday, 22 February 2020 (compare to previous)

Changed

  • Updated nunomaduro/collision to include v4 (mpociot#699)

Fixed

  • Use correct protocol for Postman collcetion URL (mpociot#697)

[4.2.4] - Saturday, 15 February 2020

Fixed

[4.2.3] - Tuesday, 4 February 2020

Changed

[4.2.2] - Tuesday, 21 January 2020

Fixed

  • Set a default value for the routematcher when fetching from config (mpociot#677)

[4.2.1] - Monday, 20 January 2020

Fixed

  • Fixed autogenerated docs endpoint address for Postman collection (mpociot#673)

[4.2.0] - Sunday, 19 January 2020

Added

  • New Postman collection generation features (mpociot#666):
    • Properly handle url parameters using the :param syntax (opposed to the Laravel-esque {param} syntax)
    • Allow configuring the auth section of Postman collection config
    • Add some documentation that was available but not exported in the Postman collection (for URL params and query params)

Changed

  • The package can now create a documentation endpoint automatically for laravel-type routes. This also allows users to install the package on dev-only enviornments but have their routes available in others, without writing custom routing code. (mpociot#659)

Fixed

  • Error when installing due to DI not working properly on constructor (mpociot#672)

[4.1.0] - Monday, 6 January 2019

Added

  • RouteMatcher to use can now be specified by user (mpociot#657)

Fixed

[4.0.2] - Monday, 25 November 2019

Fixed

[4.0.1] - Monday, 16 November 2019

Fixed

  • Update rebuild command to work with new docs locations (mpociot#646)

[4.0.0] - Thursday, 7 November 2019

Added

  • Added headers stage (mpociot#624)
  • Support for non-static docs, changed source files locations (mpociot#608)
  • Support for Eloquent API resources (mpociot#601)
  • bindings replaced by @urlParam annotation (mpociot#599)
  • Better support for arrays and objects in bodyParams (mpociot#597)

Modified

  • Postman collection now have the body as raw instead of formdata. (mpociot#627)
  • Nonexistent @responseFile annotations now show a warning and skip the route (mpociot#620)
  • Use symfony/var-exporter to export PHP arrays, ensuring short array syntax (mpociot#615)
  • Use single quotes in PHP example template (mpociot#612)
  • Transformer annotations are now given priority over all other response strategies (mpociot#620)
  • Made ResponseCalls strategy only execute if no successful responses exist. (mpociot#605)
  • Hide null responses in examples. (mpociot#605)
  • Made responses stage additive (mpociot#605)
  • Renamed query and body in response_calls config to queryParams and bodyParams (mpociot#603)

Removed

  • Removed apply.response_calls.headers in favour of apply.headers (mpociot#603)
  • Removed bindings in response_calls (mpociot#599)

[3.17.1] - Thursday, 12 September 2019

Fixed

[3.17.0] - Saturday, 7 September 2019

Added

  • Switched to a plugin architecture that allows support for external strategies (mpociot#570)

Changed

  • Exclude Laravel Telescope routes when present (mpociot#579)
  • Set status code for transformer response from tag if present (mpociot#581)
  • Set status code for response call from actual response (mpociot#581)

[3.16.3] - Thursday, 5 September 2019

Fixed

  • Removed references to removed helper functions in 6.0 (mpociot#576)

[3.16.2] - Wednesday, 4 September 2019

Fixed

[3.16.1] - Wednesday, 4 September 2019

Added

  • Use HTTPS in Postman collection if base_url is HTTPS (mpociot#575)

[3.16.0] - Wednesday, 4 September 2019

Added

[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

[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

Fixed

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

[3.10.0] - Sunday, 23 June 2019

Added

[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

[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

[3.7.0] - Thursday, 2 May 2019

Added

[3.6.0] - Monday, 29 April 2019

Added

[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

[3.4.0] - Wednesday, 27 February 2019

Added

[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

[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

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

[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

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)