oas_rails

0.8.0 (2024-08-31)

Features

• route_extractor: feature ignore custom route (#54) (e34b3ee)
• view: support custom layout (#52) (abef8d3)

Bug Fixes

• yard_oas_rails_factory: set different expresion for request body examples (ceea6eb)

Tests

• feature ignore custom route (#55) (aedbe7b)

0.7.0 (2024-08-27)

Features

• view: Adding the title from the config initializer in the views title (#48) (61cf843)

Documentation

• readme: Fix 'Hash' missing (#49) (aed623d)

0.6.0 (2024-08-26)

Features

• add @response_example tag for document examples of responses. (#43) (16f37c4)

Bug Fixes

• default body response following the new syntax (a397555)

0.5.0 (2024-08-23)

Features

• disable autodiscover responses for endpoints with at least one documented response. (ecd1318)

Code Refactoring

• redefine the way request body and responses are described. BREAKING. (ed5eef5)

0.4.5 (2024-08-21)

Bug Fixes

• return self when default responses and autodiscover is disabled. (0d26fcc)

0.4.4 (2024-08-20)

Bug Fixes

• make the test works with rake under 3.1 (7220e26)
• manage when same route has two or more verbs (cb99f31)
• use Rack::Utils.status_code instead of Rack::Utils::SYMBOL_TO_STATUS_CODE (0c9dccb)

0.4.3 (2024-08-19)

Bug Fixes

• rails version was ~>7.0.0 which was not allowing to use 7.2 (8e9e6e2)

0.4.2 (2024-08-15)

Bug Fixes

• openapi document errors. (df4fb94)

Documentation

• readme: add badges for rails and ruby version (9125108)

Code Refactoring

• move json schema builder to builders module (#21) (8d32054)

0.4.1 (2024-08-11)

Bug Fixes

• engine mounted path was not working on the index view. (52e7936)
• try to detect model class from all the namespaces of the controller (d029862)

0.4.0 (2024-08-10)

Features

• add default responses configuration (errors). (e4b3666)

Code Refactoring

• move OAS creation logic to builders and replace common objects (64d7922)
• organize OAS models into Spec module. (#13) (71a1515)

0.3.0 (2024-08-02)

Features

• media_type: generate examples with factory bot if it is available and a factory is defined for detected class. (4c904a8)

Bug Fixes

• media_type: models and examples identify by default was equal. But in the practice there are some fields that are different ex: created_at is sended in a response but not in a create/update operation. (56a7b4c)
• route_extractor: rubocop offense route_extractor.rb:84:11: C: Style/MultilineBlockChain: Avoid multi-line chains of blocks. (cd8af2e)

Documentation

• readme: cover from my website (aa7f4aa)
• readme: update example image (59f43b3)

Code Refactoring

• route_extractor: move the RouteExtrator class into de Extractors module. (d06cf8a)

0.2.3 (2024-08-01)

Bug Fixes

• specification: clear_cache is an instance method, not class method. (7a30667)
• specification: Make the reload works. (be86263)

0.2.2 (2024-07-31)

Bug Fixes

• media_types: fixtures could be not present when looking for examples. It was raising an Errno::ENOENT. Now will be rescue and returned a default {}. (03ff14d)

0.2.1 (2024-07-31)

Bug Fixes

• route_extractor: Verify the correct implementation of a route. If (e8ab706)

0.2.0 (2024-07-30)

Features

• add a configuration for filter routes. So if you have your api in the namespace /api/v1 you could add config.api_path='/api/v1' for filter the routes to be included in the documentation. (22eaa9c)
• Add methods for documenting authorization. (f543146)
• add release please workflow and release all changes (1e137a4)
• add ruby version to repo (0ac81a3)
• preparing first version of gem (849922a)
• release version 0.1.0 (ca16692)
• release version 0.1.1 (2c2c5c6)

Bug Fixes

• protect_from_forgery should be called in OasRails::ApplicationController (76af772)
• protect_from_forgery should be configured with with: :exception (11fd990)
• extract functions from OasRails module to Utils module for fix offense of lenght module (f740dca)
• make the same route respond with the RapiDoc view or the json file (7fe53f3)
• release plase config names (c54f35f)
• remove unused style import (291efdf)
• rename configuration request_body_automatically to autodiscover_request_body (266828e)
• rubocop configuration and gemspec definition (2b05b3d)
• set sqlite version in gemfile (559d993)