mirror of
https://github.com/ambieco/scribe.git
synced 2026-04-01 22:34:38 +08:00
12 KiB
12 KiB
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.0.0]
Added
bindingsreplaced by@urlParamannotation (https://github.com/mpociot/laravel-apidoc-generator/pull/599)- Better support for arrays and objects in bodyParams (https://github.com/mpociot/laravel-apidoc-generator/pull/597)
[3.17.1] - Thursday, 12 September 2019
Fixed
- ResponseCalls: Call Lumen application correctly since it does not use HttpKernel (https://github.com/mpociot/laravel-apidoc-generator/pull/585)
- Update usage of
clean*Parametersin python template (02fb719d0d) - Bugfix: really exclude parameters from examples, not just send empty strings (
762e2e1003,e54b474578)
[3.17.0] - Saturday, 7 September 2019
Added
- Switched to a plugin architecture that allows support for external strategies (https://github.com/mpociot/laravel-apidoc-generator/pull/570)
Changed
- Exclude Laravel Telescope routes when present (https://github.com/mpociot/laravel-apidoc-generator/pull/579)
- Set status code for transformer response from tag if present (https://github.com/mpociot/laravel-apidoc-generator/pull/581)
- Set status code for response call from actual response (https://github.com/mpociot/laravel-apidoc-generator/pull/581)
[3.16.3] - Thursday, 5 September 2019
Fixed
- Removed references to removed helper functions in 6.0 (https://github.com/mpociot/laravel-apidoc-generator/pull/576)
[3.16.2] - Wednesday, 4 September 2019
Fixed
- Support for Laravel 6 (
f7dd8d19b7)
[3.16.1] - Wednesday, 4 September 2019
Added
- Use HTTPS in Postman collection if base_url is HTTPS (https://github.com/mpociot/laravel-apidoc-generator/pull/575)
[3.16.0] - Wednesday, 4 September 2019
Added
- Support for Laravel 6 (https://github.com/mpociot/laravel-apidoc-generator/pull/572)
[3.15.0] - Saturday, 31 August 2019
Added
- Ability to exclude a query or body parameter from being included in the example requests (https://github.com/mpociot/laravel-apidoc-generator/pull/552)
[3.14.0] - Saturday, 31 August 2019
Fixed
- Backwards compatibility for the changes to
@groupintroduced in 3.12.0 (5647eda35e)
[3.13.0] (deleted)
[3.12.0] - Sunday, 25 August 2019
Fixed
- Specifying an
@groupfor a method no longer requires you to add the description. (https://github.com/mpociot/laravel-apidoc-generator/pull/556) - Pass the verbosity level down to the Collision library. (https://github.com/mpociot/laravel-apidoc-generator/pull/556)
[3.11.0] - Friday, 9 August 2019
Added
- Support for query parameters in the bash template (https://github.com/mpociot/laravel-apidoc-generator/pull/545)
- Include query parameters and headers in the generated Postman collection (https://github.com/mpociot/laravel-apidoc-generator/pull/537)
- Include Python out of the box as example language (https://github.com/mpociot/laravel-apidoc-generator/pull/524)
Changed
- Moved nunomaduro/collision to "suggested" so it doesn't break PHP 7.0 (
2f3a2144e1)
Fixed
- Stopped using config helper inside config file (https://github.com/mpociot/laravel-apidoc-generator/pull/548)
[3.10.0] - Sunday, 23 June 2019
Added
--verboseflag to show exception encountered when making response calls (dc987f296e)
[3.9.0] - Saturday, 8 June 2019
Modified
- Postman collections and URLs in example requests now use the
apidoc.base_urlconfig variable (https://github.com/mpociot/laravel-apidoc-generator/pull/523)
[3.8.0] - Wednesday, 29 May 2019
Added
- Support for PHP array callable syntax in route action (https://github.com/mpociot/laravel-apidoc-generator/pull/516)
[3.7.3] - Thursday, 23 May 2019
Fixed
- Added faker_seed (
d2901e51a6)
[3.7.2] - Sunday, 19 May 2019
Added
- Support for URL paths in include/exclude rules (https://github.com/mpociot/laravel-apidoc-generator/pull/507)
[3.7.1] - Friday, 17 May 2019
Fixed
- Handle exception for no URL::forceRootURL() method in Lumen (
2146fa114d) - Url parameter bindings (
f0dc118c6b)
[3.7.0] - Thursday, 2 May 2019
Added
- Support for
@queryParamsin Dingo FormRequests (https://github.com/mpociot/laravel-apidoc-generator/pull/506) - Easier customisation of example languages (
0aa737a2e5) - Include PHP as example language (
c5814762fa)
[3.6.0] - Monday, 29 April 2019
Added
- Support for
@queryParamsin FormRequests (https://github.com/mpociot/laravel-apidoc-generator/pull/504) - Added
default_groupkey to replaceungrouped_name(72b5f546c1)
[3.5.0] - Tuesday, 23 April 2019
Added
- Option to seed faker for deterministic output (https://github.com/mpociot/laravel-apidoc-generator/pull/503)
- Support for binding prefixes (https://github.com/mpociot/laravel-apidoc-generator/pull/498)
- Ability to override Laravel
config(https://github.com/mpociot/laravel-apidoc-generator/pull/496) - Allow override of the name 'general' for ungrouped routes (https://github.com/mpociot/laravel-apidoc-generator/pull/491)
Changed
- Use parameter-bound URL in doc examples (https://github.com/mpociot/laravel-apidoc-generator/pull/500)
Fixed
- Request router now matches when router has sub-domain (https://github.com/mpociot/laravel-apidoc-generator/pull/493)
[3.4.4] - Saturday, 30 March 2019
Fixed
- Allow users specify custom Content-type header for Markdown examples (https://github.com/mpociot/laravel-apidoc-generator/pull/486)
[3.4.3] - Wednesday, 13 March 2019
Fixed
- Ignore scalar type hints when checking for FormRequests (https://github.com/mpociot/laravel-apidoc-generator/pull/474)
[3.4.2] - Sunday, 10 March 2019
Added
- Ability to set cookies on response calls (https://github.com/mpociot/laravel-apidoc-generator/pull/471)
[3.4.1] - Monday, 4 March 2019
Fixed
- Support for Lumen 5.7 (https://github.com/mpociot/laravel-apidoc-generator/pull/467)
[3.4.0] - Wednesday, 27 February 2019
Added
- Support for Laravel 5.8 (https://github.com/mpociot/laravel-apidoc-generator/pull/462)
- Ability to annotate body parameters on FormRequest (https://github.com/mpociot/laravel-apidoc-generator/pull/460)
[3.3.2] - Tuesday, 12 February 2019
Added
- Ability to specify array and object body/query params using dot notation (https://github.com/mpociot/laravel-apidoc-generator/pull/445)
- Ability to specify name and description of Postman collection (https://github.com/mpociot/laravel-apidoc-generator/pull/443)
Fixed
- Postman collection and documentation base URL now uses
config('app.url')(https://github.com/mpociot/laravel-apidoc-generator/pull/458)
[3.3.1] - Tuesday, 8 January 2019
Fixed
- Fixed vendor tags (https://github.com/mpociot/laravel-apidoc-generator/pull/444)
[3.3.0] - Wednesday, 2 January 2019
Added
- Ability to replace json key values in response file (https://github.com/mpociot/laravel-apidoc-generator/pull/434)
- Support for custom transfer serializers (https://github.com/mpociot/laravel-apidoc-generator/pull/441)
[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
urlencodedin Postman collection (https://github.com/mpociot/laravel-apidoc-generator/pull/418) @responseFilestrategy 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
ResponseFileStrategyto retrieve responses from files. (https://github.com/mpociot/laravel-apidoc-generator/pull/410)
Modified
- Switch from
jQuerytofetchin JavaScript examples. (https://github.com/mpociot/laravel-apidoc-generator/pull/411)
[3.0.6] - Saturday, 24 November 2018
Added
includeandexcluderoute options now support wildcards (https://github.com/mpociot/laravel-apidoc-generator/pull/409)
[3.0.5] - Thursday, 15 November 2018
Fixed
- Make
routeroption case-insensitive (https://github.com/mpociot/laravel-apidoc-generator/pull/407)
[3.0.4] - Wednesday, 7 November 2018
Fixed
- Replaced use of
Storage::copywith PHP'scopyto 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_pathwith 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)
@queryParamannotation (https://github.com/mpociot/laravel-apidoc-generator/pull/383)@bodyParamannotation (https://github.com/mpociot/laravel-apidoc-generator/pull/362, https://github.com/mpociot/laravel-apidoc-generator/pull/366)@authenticatedannotation (https://github.com/mpociot/laravel-apidoc-generator/pull/369)- Ability to override the controller
@groupfrom 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
apidocnamespace (previouslyapi). (https://github.com/mpociot/laravel-apidoc-generator/pull/350) - The
updatecommand has been renamed torebuildand now uses the output path configured in the config file. (https://github.com/mpociot/laravel-apidoc-generator/pull/370) @resourcerenamed 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)