CHANGELOG.md

=========== Changelog

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

• Fixed to_json encoding error that occurs with uploaded file parameters. #429 (hossenlopp)
• Render enum param values as CODE #426 (febeling)
• Fix layout path (Rails 4.2.5.1 compatibility) #425 (halilim)
• Unify indentations across all locale files #423 (springerigor)
• Fix typo in Action Aware Params section of readme #419 (ryanlabouve)
• Rails4.2 #413 (ferdinandrosario)
• Add viewport meta tag. #412 (buren)
• removed beta version #411 (ferdinandrosario)
• updated patch #410 (ferdinandrosario)
• Nerian layout fix #409 (Pajk)
• Add Turkish translations #407 (halilim)
• Update README.rst #405 (type-face)
• add german locale #394 (mjansing)
• Add custom message support for missing parameters #390 (jcalvert)
• A boolean parameters can be configured with both :bool and :boolean #124 (Nerian)

v0.3.5

• Cleaning up unreachable code #385 @voxik
• Russian translation #352 @Le6ow5k1
• Ability to hide controller methods from documentation #356 @davidcollie
• Use doc_path configuration in rake tasks #358 @saneshark
• Chinese translation #363 @debbbbie
• Polish translation #375 @dbackowski
• Spanish translation #376 @isseu
• Add an alternative to action aware required param #377 @mourad-ifeelgoods

v0.3.4

• Fixing occasional NoMethodError with ActionDispatch::Reloader #348 @saneshark
• Portuguese translation #344 @dadario

v0.3.3

• Support for describing headers #341 @iliabylich

v0.3.2

• PATCH support for examples recording #332 @akenger
• Recursively search for API controllers by default for new projects #333 @baweaver
• Handling recursive route definitions with api! keyword #338 @stormsilver
• Support for eager-loaded controllers #329 @mtparet

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

• fix ruby 1.8.7 compatibility #272 @domcleal

v0.2.3

• add an option to flag an api route as deprecated #268 @komidore64
• add ability to pass additional options to apipie route #269 @exAspArk
• enhanced array validator #259 @mourad-ifeelgoods

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

• fix typo in the localization string #244 @alem0lars
• fix syntax errors in 404 page #246 @richardsondx

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.

• dump examples as json #125 @johanneswuerbach
• support for localized API documentation #232 @mbacovsky
• configuration option to always record examples #239 @arathunku
• deprecate Rails 3.0 #241 @iNecas

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

• backward compatibility with Ruby 1.8 #218 @mbacovsky
• checksum calculation is lazy and respect use_cache config #220 @mbacovsky
• fix generating the cache in production environment #223 @iNecas
• fix loading regression with SafeYAML #224 @iNecas

v0.1.0

• middleware for computing Apipie checksum for dynamic bindings #215 @mbacovsky
• api_base_url inherited properly #214 @mbacovsky
• ability to hide specific parameters #208 @nathanhoel
• fix for SafeYAML compatibility #207 @pivotalshiny
• option to show all examples in the documentation #203 @pivotalshiny
• support for array of hashes validation #189 @mtparet
• support for saving the values based on documentation into @api_params variable #188 @mtparet
• support for json generated from rake task rake apipie:static_json #186 @mtparet
• fix undefined method 'has_key?' for nil:NilClass when validating Hash against non-hash value #185 @mtparet
• fix NoMethorError when validating Hash against non-hash value #183 @nathanhoel
• support for metadata for params #181 @tstrachota
• fix camelization of class names #170 @yonpols
• new array class validator #169 @mkrajewski

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