v1.7.0

[v1.7.0] - 2024-07-23

Added

• @responseResource Annotation: Easily document complex response structures using Laravel API Resources.
• Custom Configuration Generator: Generate API documentation using custom configuration files with the idoc:custom command.
• Multiple API Documentation Sets: Manage and generate multiple sets of API documentation for different applications within the same Laravel application.
• Example Responses: Provide example responses for routes using @response, @responseFile, and @responseResource annotations.
• Transformer Support: Define transformers for the result of routes using @transformer, @transformerCollection, and @transformerModel annotations.

Changed

• Improved Documentation: Enhanced and reorganized the README.md file for better readability and presentation.
• Configuration Options: Added new configuration options for servers, external descriptions, language tabs, and security schemes.

Fixed

• Bug Fixes: Various bug fixes and performance improvements.

Removed

• Deprecated Methods: Removed deprecated methods and annotations to streamline the documentation process.

Documentation

• Extensive Documentation: Added detailed documentation for new features and configuration options.
• Examples: Included examples for using new annotations and configuration settings.

Migration Notes

• Configuration Update: Ensure to update your config/idoc.php file with the new configuration options.
• Custom Routes: Define custom routes in your routes/web.php to serve the generated documentation for each custom configuration.

Contributors

• Special Thanks: A big thank you to all the contributors who helped make this release possible.

How to Upgrade

1. Update Package: Run composer update ovac/idoc to get the latest version.
2. Publish Config: If you haven't already, publish the configuration file using php artisan vendor:publish --tag=idoc-config.
3. Update Config: Update your config/idoc.php file with the new configuration options.
4. Generate Documentation: Run php artisan idoc:generate to generate the updated documentation.

Full Changelog: v1.6.2...v1.7.0

v1.6.2

Laravel 11.x version compatibility

v1.6.1

Fix issue #39

v1.6.0

Laravel 10 support by @pedram-davoodi

v1.5.0

This version should work seamlessly with Laravel v9 - Thanks to @sharifnezhad

What's Changed

• FEAT: Disable middlewares in auto-generated responses by @js-moreno in #25
• bug-fix for lumen frame work: by @phpooya in #28
• Laravel 9 support by @sharifnezhad in #33

New Contributors

• @phpooya made their first contribution in #28
• @sharifnezhad made their first contribution in #33

Full Changelog: v1.4.0...1.5.0

Laravel 8 support

This version should work seamlessly with Laravel v8 - Thanks to @mikebronner

Fixes:

• Side menu behavior in Chrome by @js-moreno
• Use x-tagGroups by @js-moreno
• Documentation updates by @js-moreno

Big thanks for your contributions 🙏

Laravel 7 support

This version should work seamlessly with Laravel v7 - Thanks to @Midstackdev

Laravel 6 support

This version should work seamlessly with Laravel v6 - Thanks to @dluague

Bug fix for missing factory import

The should fix issue #1

Stable release

v1.1.0

Update README.md