Skip to content

Latest commit

 

History

History
689 lines (552 loc) · 42 KB

CHANGELOG.md

File metadata and controls

689 lines (552 loc) · 42 KB
Raw

Changelog

v1.4.2 (2024-07-20)

Full Changelog

  • Fix rubocop with most recent version 1.65.0 (#930) (Mathieu Jobin)
  • Fix error for hash object warnings with delegated method descriptions (#938) (Murray Steele)

v1.4.1 (2024-07-09)

Full Changelog

  • Fix multiple rubocop offenses via rubocop_challenger. (Mathieu Jobin)
    • RSpec/ExampleWording (#913)
    • Layout/FirstArrayElementIndentation (#914)
    • Style/BlockDelimiters (#917)
    • Style/MutableConstant (#916)
    • Layout/InitialIndentation (#915)
    • Performance/RegexpMatch (#918)
  • Fix CI: build green for modern ruby, rack, and rubocop-rspec (#939) (Murray Steele)

v1.4.0 (2024-05-30)

Full Changelog

  • Add Ruby 3.3.0 to CI build matrix (#906) Masato Nakamura
  • Fix rubocop CI (#910) (Masato Nakamura)
  • Add metadata for rubygems.org and use https URLs (#909) (Masato Nakamura)
  • Bump GHA actions/checkout to be on node20 by default (#911) (Masato Nakamura)
  • Convert readme to markdown (#920) (Panos Dalitsouris)
  • Fix typos, Found via codespell (#921) (Kian-Meng Ang)
  • Bump ruby versions on test jobs (#927) (Masato Nakamura)
  • Support for Ruby 3.4.0-preview1 (#929) (Masato Nakamura)
  • Add "blank allowed" message to api doc (#926) (Peko)
  • Custom headers responses (#924) (Panos Dalitsouris)

v1.3.0 (2023-12-19)

Full Changelog

  • rubocop fixes (#897) (Mathieu Jobin)
  • Fix usage of deprecated Rack::File in Rack 3.0 (#896) (James Dean Shepherd)
  • add rails 7.1 to the build matrix (#898) (Mathieu Jobin)
  • super small typo fix (#900) (Eric Pugh)
  • support for property example (#901) (Chien-Wei Huang (Michael))
  • Use array items type from validator (#904) (Panos Dalitsouris)

v1.2.3 (2023-10-11)

Full Changelog

  • Fix param: Consider default_value: nil as valid config (#894) (davidwessman)

v1.2.2 (2023-07-18)

Full Changelog

  • Fixed Swagger warnings for properties (#892) (shev-vadim-net)
  • Improved support for multipart/form-data example recording (#891) (Butiri Cristian & hossenlopp)
  • rubocop (1.54.2) fixes required with latest version (#893) (Mathieu Jobin)

v1.2.1 (2023-06-09)

Full Changelog

  • rspec: Fixes deprecated matcher (#882) (David Wessman)
  • Fix streaming bug (#677) (Hunter Braun)
  • Update README URLs based on HTTP redirects (#448) (ReadmeCritic)
  • Swagger: Adds option to skip default tags (#881) (David Wessman)
  • Parameter validation: Raises error for all missing (#886) (David Wessman)

v1.2.0 (2023-06-03)

Full Changelog

  • Allow resource_name to be inherited (#872) (Eric Hankins)
  • Fix cache rendering with namespaced resources (#874) (Eric Hankins)
  • Fix deprecated content_type on Rails >= 6 (#879) (Eric Hankins)
  • Fix typo in Collector (#877) (Eric Hankins)
  • Fix error climbing controller hierarchy (#875) (Eric Hankins)
  • Add Gemfile.tools for IDE usage (#876) (Eric Hankins)
  • Fix rubocop (#883) (Mathieu Jobin)
  • Performance/InefficientHashSearch-20230602233137 (#884) (RuboCop challenger)
  • Redo Github action script to not need individual gemfiles (#885) (Mathieu Jobin)

v1.1.0 (2023-05-16)

Full Changelog

  • Improve performance of route detection #870 (Eric Hankins)
  • Fix startup crash due to typo #869 (Eric Hankins)
  • Skip parse body for pdf responses #871 (Juan Gomez)
  • add missing 'returns' translation #868 (Anthony Robertson)

v1.0.0 (2023-04-26)

Full Changelog

  • Refactor Swagger generator #816 (Panos Dalitsouris)
  • Take into account validator options for required ParamDescription #863 (Panos Dalitsouris)
  • Replace get_resource_name with get_resource_id #864 (Panos Dalitsouris)
  • Namespace swagger configuration #862 (Panos Dalitsouris)
  • Allow boolean array [true, false] to be a valid argument for BooleanValidator #848 (Panos Dalitsouris)
  • Fix swagger warnings #865 (Panos Dalitsouris)
  • Update README - Adds the new Integer option you added recently to the documentation here. #866 (Jeremy Lupoli)
  • [Rubocop] More Rubocop Auto corrections #859

v0.9.4 (2023-04-11)

Full Changelog

  • [Fix] Separate nested resource name #855, #455 (Panos Dalitsouris)
  • [Rubocop] Disable a few Rubocop Rules, run Rubocop with ruby 3.2 #851, #853, #840, #841 (Panos Dalitsouris)
  • [Rubocop] More Rubocop Auto corrections #858, #849, #850, #844, #846, #834, #847 (Rubocop Challenger)

v0.9.3 (2023-03-08)

Full Changelog

  • [Feature] Allow Apipie::ParamDescription to be marked as deprecated #819, #811 (Panos Dalitsouris)
  • [Fix] Make html markup thread safe (#822) (Adam Růžička)
  • [Feature] Allow action matcher strategy to be configured #821 (Panos Dalitsouris)
  • [CI] Run Rubocop when opening PR #826 (Panos Dalitsouris)
  • [CI] Green rubocop - Fix after rubocop challenger upgrade #829 (Mathieu Jobin)
  • [Rubocop] More Rubocop Auto corrections #818, #825, #827, #837, #839 (Rubocop Challenger)

v0.9.2 (2023-02-07)

Full Changelog

  • [Rubocop] More Rubocop Auto corrections #795, #781, #791, #788 (Rubocop Challenger)
  • [Fix] Can't include translation in full description (#446) #808 (Peter Nagy)
  • [Refactor] Move swagger param description creation #810 (Panos Dalitsouris)
  • [Rubocop] Redo rubocop TODOs, set HashSyntax config to most used style #814 (Mathieu Jobin)
  • [Fix] Swagger missing i18n #815 (@jirubio)

v0.9.1 (2023-01-16)

Full Changelog

  • [Refactor] Create test cache files under a not version controlled directory #809 (Panos Dalitsouris)
  • [Ruby] Support for Ruby 3.2 #807 (Mathieu Jobin)
  • [Fix] Reverted conditional assignment operators that caused #559 #806 (Nick L. Deltik)
  • [Rubocop] Autocorrect Style/SymbolProc #793 (Rubocop Challenger)

v0.9.0 (2023-01-03)

Full Changelog

  • [Refactor] Move Swagger types and warnings under /generator namespace #803 (Panos Dalitsouris)
  • [Refactor] Creates Apipie::MethodDescription::ApisService #805 (Panos Dalitsouris)
  • [Refactor] Change output folder to spec/dummy/tmp/ #804 (Panos Dalitsouris)
  • Fix tiny typo in docs #798 (Erik-B. Ernst)
  • Fix Generated docs.json output #787 (Jeremy Liberman)
  • Rubocop Fixes #775, #778, #780, #790, #783, #785 (RuboCop)
  • Remove/clean up dev dependencies and unused rake tasks #777 (Mathieu Jobin)
    • remove unused rake task
  • Setup Rubocop Challenger #776 (Mathieu Jobin)

v0.8.2 (2022-09-03)

Full Changelog

  • Allow custom validators to opt out of allow_blank behavior #762. (Stephen Hanson)
  • Enforce test coverage, set current 89% as minimum #764. (Mathieu Jobin)
  • Add contributing instructions to readme #763. (Stephen Hanson)
  • Fix readme formatting #765. (Stephen Hanson)
  • Adds expected_type to IntegerValidator example #769. (Jeremy Liberman)
  • Update readme with error handling example #768. (Jesse Eisenberg)
  • Fix scope incorrectly set to nil when a param_group is used inside an array_of_hash and the param_group is in a different module / controller. #693 #774. (Omkar Joshi / Oliver Iyer)

v0.8.1 (2022-05-26)

Full Changelog

  • Remove warning that came back as of #752. #761 (Jorge Santos / Mathieu Jobin)

v0.8.0 (2022-05-24)

Full Changelog

  • Add support for scheme definition in Swagger docs. #710 (Dan Leyden)
  • Add support for Rails 7 #760 (Mathieu Jobin)
  • Clean up code base, removing all trace of unsupported Rails 4.x #752 (Mathieu Jobin)
  • fix: Controller resource set before version #744 (LuukvH)
  • fix: enable swagger generator to add referenced schema for an array of hashes param #689 (Francis San Juan)

v0.7.2 (2022-04-19)

Full Changelog

  • Added Korean locale. #480 (Jaehyun Shin ) #757 (Jorge Santos)
  • Security Upgraded Bootstrap from 2.0.2 to 2.3.2, JQuery from 1.11.3 to 1.12.4 #708 (Nicolas Waissbluth)
  • Fix ruby2 keyword argument warning #756 (Jorge Santos)

v0.7.1 (2022-04-06)

Full Changelog

  • Skip extra parameters while validating the keys. #690 (Omkar Joshi)
  • Support defining security mechanisms for Swagger #711 (Dan Leyden)
  • Update boolean handling of false #749 (Colin Bruce)

Note: Up until and including v0.6.x, apipie-rails was silently ignoring allow_blank == false on String validation. when allow_blank is not specified, it default to false. to allow blank strings, you must specify it as a parameter.

Alternatively, if you want to revert to the previous behavior, you can set this configuration option: Apipie.configuration.ignore_allow_blank_false = true.

v0.7.0 (2022-03-30)

Full Changelog

  • ArgumentError (invalid byte sequence in UTF-8) #746 (David Milanese)
  • Fix allow_blank does not work #733 (CHEN Song)
  • Fix schema generation for param descriptions using the array validator in option #732 (Frank Hock)
  • Remove support for Rails 4 and Ruby <= 2.5 #747 (Mathieu Jobin)

v0.6.0 (2022-03-29)

Full Changelog

  • Ruby 3.0 fixes #716 (hank-spokeo)
  • only depends on actionpack and activesupport #741 (Mathieu Jobin)
  • language fix, fallback to default locale #726 (Alex Coomans)

v0.5.20 (2022-03-16)

Full Changelog

  • Update rel-eng (Oleh Fedorenko)
  • Deprecate travis, run tests on github actions #740 (Mathieu Jobin)
  • Update validator.rb #739 (Dmytro Budnyk)
  • Fix wrong number of arguments for recorder#process #725 (rob mathews)
  • Change "an" to "a" #723 (Naokimi)

v0.5.19 (2021-07-25)

Full Changelog

  • Add rel-eng notebook (Oleh Fedorenko)
  • Correct the word parâmentros for brazilian portuguese #687 (Diego Noronha)
  • Fix depreciated file.exists. #721 (Diane Delallée)
  • Fix typo in changelog #703 (Pavel Rodionov)
  • Add rails 6.1 support in doc generation #702 (andrew-newell)

v0.5.18 (2020-05-20)

Full Changelog

  • Optional rdoc dependency with lazyload #683 (vkrizan)

v0.5.17 (2020-01-20)

Full Changelog

v0.5.16 (2019-05-22)

Full Changelog

  • Load file directly instead of using Rails constant #665 (speckins)

v0.5.15 (2019-01-03)

Full Changelog

  • Fix authorization of resources #655 (NielsKSchjoedt)
  • Use configured value when swagger_content_type_input argument is not passed #648 (nullnull)
  • Fix "ArgumentError: string contains null byte" on malformed stings #477 (avokhmin)

v0.5.14

  • HTML escape validator values #645 (ekohl)
  • Support for adding new params via update\_api #642 (iNecas)
  • Allow the "null" JSON string to be used as a parameter in Apipie spec examples (show\_in\_doc) #641 (enrique-guillen)
  • Fix examples recording for specific cases #640 (Marri)
  • Add description section to response #639 (X1ting)

v0.5.13

  • Fix swagger generation if a controller's parent doesn't define a resource_description #637 (enrique-guillen)

v0.5.12

v0.5.11

v0.5.10

v0.5.9

v0.5.8

  • Swagger json includes apipie's description as swagger's description #615 (gogotanaka)
  • Fix api! issue by using underscore when appending controller to the default controller string #613 (kevinmarx)
  • Possibility to compress examples #600 (Haniyya)
  • Possibility to describe responses #588 (elasti-ron)

v0.5.7

  • Fix example recording with Rails 5 #607 (adamruzicka)
  • Use SHA1 instead of MD5 to enable using APIPIE at FIPS-enables systems #605 (iNecas)
  • Replaced String#constantize with String#safe_constantize so apipie won't break on a missing constant #575 (Haniyya)
  • Added Swagger generation #569 (elasti-ron)

v0.5.6

v0.5.5

v0.5.4

  • Constantize controller class before calling superclass #558 (ydkn)

v0.5.3

  • Fix reloading when extending the apidoc from concern #557 (iNecas)
  • Fix example recording when using send_file #504 (tdeo)

v0.5.2

  • A way to extend an exiting API via concern #554 (iNecas)
  • Fallback to apipie views when application override isn't present #552 (tstrachota)
  • Updated setting default locale for api documentation #543 (DmitryKK)

v0.5.1

  • Use AD::Reloader on Rails 4, app.reloader only on Rails 5+ #541 (domcleal)
  • Recognize Rack Symbols as Status Codes #468(alex-tan)

v0.5.0

  • Fix Rails 5.1 deprecations #530 (@Onumis @sedx)
    • This release is no longer compatible with Ruby 1.9.x
  • Do not mutate strings passed as config options, fixes #461 #537 (samphilipd)
  • Added recursion for documentation, fixed bug in examples with paperclip #531 (blddmnd)
  • Added locales/ja.yml for Japanese #529 (kikuchi0808)

v0.4.0

v0.3.7

  • Handle blank data when parsing a example's response #453 (stbenjam)
  • Allow layouts to be overridable. Fixes a regression introduced in #425. #447 (nilseriksson)

v0.3.6

v0.3.5

v0.3.4

v0.3.3

v0.3.2

v0.3.1

  • Support for api! keyword in concerns #322 @iNecas
  • More explicit ordering of the static dispatcher middleware #315 @iNecas

v0.3.0

This should be a backward compatible release. However, the number of new significant features deserves new minor version bump.

  • Rubocop-blessed Ruby 1.9 syntax for generated DSL documentation #318 @burnettk
  • load API paths from routes.rb #187 @mtparet @iNecas
  • ability to use before_filter instead of overriding the action method for validation #306 @dprice-fiksu
  • support multi-part data when recording from tests #310 @bradrf
  • validate_keys option to raise exception when passing undocumented option #122 @dfharmon
  • handle static page generation when the doc_base_url has multiple folders #300 @ryanische
  • add ability to markup validator description #282 @exAspArk
  • don't specify protocol in Disqus script tag src #285 @chrise86
  • fix BooleanValidator to set expected_type as boolean #286 @dustin-rh

v0.2.6

  • better handling on cases where resource/method is not found when cache is turned off #284 @iNecas
  • fix disqus integration #281 @RajRoR

v0.2.5

  • Name substitution for referenced param_group defined in a concern #280 @tstrachota
  • expected_type 'array' for ArrayValidator #276 [@dustint-rh][]

THE FURTHER SUPPORT FOR RUBY 1.8.7 WILL NOT BE ENSURED IN THE MASTER AND THE >= 0.3.0 RELAEASES. We discourage anyone to keep using ruby 1.8.7 for anything. If you're aware of the issues and still willing to take the risk, we are willing to keep the v0.2.x releases based on the v0.2.x branch. However, we will not actively develop or backport any new features to this branch neither will we accept there features that are not in the master branch.

v0.2.4

v0.2.3

v0.2.2

  • prevent rspec 3 from being used. It is not compatible. #255 @lsylvester
  • fixed extractor root route (handle nil path) #257 @ctria
  • reduced rails dependency to development only #266 @klobuczek
  • add more options to apipie:cache to generate only parts of the static pages #262 @mbacovsky

v0.2.1

v0.2.0

This is not full backward compatible release, as the format of storing examples changed from YAML to JSON: the default location is at doc/apipie_examples.json. The migration should be as easy as running:

rake apipie:convert_examples

Also please not Rails 3.0 support was deprecated and the compatibility wont be tracked anymore in next releases.

v0.1.3

  • nested attributes showing in the documentation #230 @iNecas

v0.1.2

  • reloading works correctly with to_prepare blocks in the app #228 @iNecas
  • documentation bootstrapping now respects api_controllers_matcher #227 @clamoris

v0.1.1

v0.1.0

v0.0.24

  • fix DOS vulnerability for running in production without use_cache
  • ability to load descriptions from external files
  • improved examples extractor
  • fixed deprecation warnings in Rails 4
  • using StandardError instead of Exception for errors

v0.0.23

  • fix exceptions on unknown validator
  • fix concerns substitution in parameters
  • possibility to authenticate the API doc
  • support for array in api_controllers_matcher

v0.0.22

  • fix "named_resources" option
  • fix generating static files when concerns used

v0.0.21

  • fix RDoc 4.0 compatibility issue
  • validate_value and validate_presence options for better validation granularity

v0.0.20

  • namespaced resources - prevent collisions when one resource defined in more modules
  • Apipie::DSL::Concern for being able to use the DSL in module that is included into controllers

v0.0.19

  • fix examples recording when resource_id is set
  • use safe_yaml for loading examples file when available

v0.0.18

  • param_group and def_param_group keywords
  • :action_aware options for reusing param groups for create/update actions

v0.0.17

  • support for multiple see links at action and ability to provide description of see links

v0.0.16

  • Fix getting started being rendered even when documentation was available

v0.0.15

  • Fix case when there is no documentation yet: with link to how to start
  • Fix handling bad requests when cache is on
  • Fix params extractor in case there is already some documentation