Skip to content
This repository has been archived by the owner on May 15, 2024. It is now read-only.

Latest commit

 

History

History
156 lines (93 loc) · 5.63 KB

CHANGELOG.md

File metadata and controls

156 lines (93 loc) · 5.63 KB
Raw

Changelog

All notable changes will be documented here.

v2.4.3 - 31-08-2021

Bugfixes

  • Fixed a bug with rules that validated objects, where it just completely messed up

v2.4.2 - 30-08-2021

Changes

v2.4.1 - 30-08-2021

Changes

v2.4.0 - 30-08-2021

Changes

  • We now actually apply the example to the response so it is now readable
  • The RicoNijeboer\Swagger\SwaggerServiceProvider now ensures that the RicoNijeboer\Swagger\Providers\ValidationServiceProvider is registered, making the documentation for development only installs correct again.
  • When validated input is in the query when called it is now stored as a parameter

Bugfixes

  • Fixed an error that occurred when displaying any request that contained a max rule in the request validation
  • Fixed a bug in the PathData::calculateMiddleware where it threw an exception when you did not add a specific guard to your auth middleware.
  • Fixed failing tests (sorry)

v2.3.3 - 2021-08-24

Bugfixes

  • Fixed error with the Str::startsWith method throwing an exception when haystack is an array

v2.3.2 - 2021-08-24

Bugfixes

  • Fixed a bug where the rule helper failed with nested rule arrays

v2.3.1 - 2021-08-24

Bugfixes

  • Fixed a bug where tags were not applied when using the swagger_tag middleware.

v2.3.0 - 2021-08-24

Changes

  • An example response body is now added for application/json responses. This body is completely anonymous, but is more representative of your actual response.
  • Security schemes are now applied to paths
    • When you use laravel/passport and your route requires certain scopes it also adds these to your path.

Bugfixes

  • Fixed a bug in the ValueHelper::jsonResponseProperty where it failed when the $value given is an empty array
  • It now only loads batches it can display

v2.2.1 - 2021-05-19

Bugfixes

  • When you have multiple routes on the same uri with different methods, it now displays all possible methods.
  • It stores tags correctly (based on the documentation) again.

v2.2.0 - 2021-05-15

Changes

  • When a field in your request validation has a regex rule. It gets a format rule within the Swagger config.
  • When a route-parameter has a where (or format in Swagger terms) it now adds this in the Swagger config.
  • Added support for server templating.
  • OAuth URLs are now relative when you don't supply a custom domain to them.
  • When a route has a custom domain using ->domain(...) it is now displayed in the Swagger config.
  • The SwaggerReader and SwaggerTag are now Terminable Middlewares, which means your users should feel even less of an impact when using your app

Upgrading

  • When updating to this version add an alter migration for the swagger_batches table which adds a nullable route_domain string-column
    $table->string('route_domain')->nullable();

v2.1.3 - 2021-05-17

Bugfixes

  • cascadeOnDelete instead of onDeleteCascade because the second one does not exist...

v2.1.2 - 2021-05-15

Bugfixes

  • The configured connection was not being used within the added migrations.
    • To ensure your tables are created in the right connection add a connection call to the Schema::create in the migration.
      Schema::connection(config('swagger.database.connection'))

v2.1.1 - 2021-05-15

Bugfixes

  • Fixed a bug where existing batches without a parameter entry would make your config get corrupted.

v2.1.0 - 2021-05-15

Features

  • Added Swagger UI option

Bugfixes

  • Fixed a bug with foreign key constraints not cascade deleting

v2.0.0 - 2021-05-14

  • Responses are now calculated and sent to the config as well.

Changes since version 1

When version 1 would create a Swagger config, it generated it by reading all the registered Routes that match the filters (defined by the developers). This worked fine, except there were a few hacks I had to do to not mess up any data sources you had in your database.

With version 2 this is a lot different; I don't execute your code based on the registered routes. You execute your code, and in the background I store just enough information to generate a Swagger config (with responses now 🎉). Because I want you to have safe data in your database, I completely obfuscate the json responses you are sending from your API. I have tried doing so and keeping the same data formats, although I may have missed one. (If you find one feel free to make a Pull Request or Issue, and I'll get to it).

With version 2 gone are all the filters that you had to define; You add the middleware and tag through the middleware. That's it.