root
/
grape-swagger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
grape-swagger/CHANGELOG.md

48 KiB
Raw Permalink Blame History

Next

Features

  • your contribution

Fixes

  • your contribution
  • #948: Grape 2.3.0 and Ruby 3.5 compatibility - @numbata

2.1.2 (Jan 7, 2025)

Features

Fixes

  • #943: Fix route_param documentation and type - @4ndv
  • #944: Amend a few typographic errors - @pieterocp
  • Your contribution here.

2.1.1 (Sep 21, 2024)

Fixes

2.1.0 (May 14, 2024)

Features

Fixes

  • #926: Refactor route and namespace combination logic - @numbata

2.0.3 (April 26, 2024)

Fixes

  • #922: Force request body to be an schema object - @numbata
  • #923: Enabled schema definitions for body parameters in DELETE requests - @numbata
  • #924: fix: Use mount_path to narrow down urls_for - @chibicco

2.0.2 (Februar 2, 2024)

Fixes

  • #918: Fix params extension does not work when param_type is body - @numbata

2.0.1 (Januar 2, 2024)

Features

Fixes

2.0.0 (November 7, 2023)

Features

Fixes

1.6.1 (May 21, 2023)

Fixes

1.6.0 (March 19, 2023)

Features

  • #872: Add consumes and produces options to add_swagger_documentation - @spaceraccoon
  • #868: Add default endpoint option to specify default response - @dhruvCW

1.5.0 (July 28, 2022)

Features

  • #862: Allow using nicknames for body definitions - @magni-

Fixes

1.4.3 (January 5, 2022)

Fixes

  • #850: Fix value of enum to be Array - @takahashim
  • #846: Fixes oapi rake tasks, allows generating sepcs for different API versions.
  • #852: Fix example to work without error - @takahashim
  • #853: Add webrick gem so that example works in Ruby 3.x - @takahashim
  • #844: Fixes the regexp used for parsing routes - @senhalil
  • #862: Allow using nicknames for body definitions - @magni-

1.4.2 (October 22, 2021)

Fixes

  • #840: Fixes documentation of additionalProperties field when used with array parameters, or when setting it to false - @magni-
  • #841: Fixes type and format values for object fields nested in an array (#832) - @magni-
  • #839: Fixes documentation of false or nil default parameter values - @magni-

1.4.1 (September 15, 2021)

Fixes

  • #833: Fixes issue of examples not showing for in: 'body' parameters - @stevenou

1.4.0 (March 20, 2021)

Features

Fixes

  • #822: Corrected the related parameter lookup on request params - @Jack12816.

1.3.1 (November 1, 2020)

Features

Fixes

1.3.0 (September 3, 2020)

Features

  • #804: Don't overwrite model description with the route description - @Bhacaz.

1.2.1 (July 15, 2020)

Fixes

  • #801: Fixes behaviour after grape upgrade to 1.4.0 - @LeFnord.

1.2.0 (July 1, 2020)

Features

  • #794: Allow entity_name to be inherited, fixes issue #659 - @urkle.
  • #793: Features/inheritance and discriminator - @MaximeRDY.

Fixes

1.1.0 (April 20, 2020)

Features

1.0.0 (February 10, 2020)

Features

  • #777: Make usage of grape >= 1.3, rack >= 2.1 - @LeFnord.
  • #775: Add in token_owner support to param hidden procs - @urkle.

0.34.2 (January 20, 2020)

Fixes

0.34.0 (January 11, 2020)

Features

  • #768: Uses ruby 2.7, fixes grape to 1.2.5 (cause of dry-types) - @LeFnord.
  • #761: Add an option to configure root element for responses - @bikolya.
  • #749: Drop support for Ruby 2.3 and below - @LeFnord.

Fixes

  • #758: Handle cases where a route's prefix is a nested URL - @SimonKaluza.
  • #757: Fix array_use_braces for nested body params - @bikolya.
  • #756: Fix reference creation when custom type for documentation is provided - @bikolya.
  • #764: Fix root element for multi-word entities - @bikolya.

0.33.0 (June 21, 2019)

Fixes

0.32.1 (December 7, 2018)

Fixes

  • #731: Skip empty parameters and tags arrays - @fotos.
  • #729: Allow empty security array for endpoints - @fotos.

0.32.0 (November 26, 2018)

Features

Fixes

  • #720: Fix: corrected termsOfService field name in additional info - @dblock.

0.31.1 (October 23, 2018)

Features

  • #710: Re-implement api_documentation and specific_api_documentation options - @dblock.

0.31.0 (August 22, 2018)

Features

  • #622: Add support for 'brackets' collection format - @korstiaan.
  • #637: Add an option to add braces to array params - @adie.
  • #688: Use deep merge for nested parameter definitions - @jdmurphy.
  • #691: Disregard order when parsing request params for arrays - @jdmurphy.
  • #696: Delegate required properties parsing to model parsers - @Bugagazavr.

0.30.1 (July 19, 2018)

Features

  • #686: Allow response headers for responses with no content and for files - @jdmurphy.

0.30.0 (July 19, 2018)

Features

Fixes

  • #681: Provide error schemas when an endpoint can return a 204 - @adstratm.
  • #683: Fix handling of arrays of complex entities in params so that valid OpenAPI spec is generated - @jdmurphy.

0.29.0 (May 22, 2018)

Features

Fixes

  • #664: Removed all references to obsolete hide_format parameter - @jonmchan.
  • #669: Fix handling of http status codes from routes - @milgner.
  • #672: Rename 'notes' to 'detail' in README - @kjleitz.

0.28.0 (February 3, 2018)

Features

Fixes

0.27.3 (July 11, 2017)

Features

Fixes

0.27.2 (May 11, 2017)

Features

  • #608: Support extensions on the root object - @thogg4.
  • #596: Use route_settings for hidden and operations extensions - @thogg4.
  • #607: Allow body parameter name to be specified - @tjwp.

0.27.1 (April 28, 2017)

Features

0.27.0 (March 27, 2017)

Features

  • #583: Issue #582: document file response - @LeFnord.
  • #588: Allow extension keys in Info object - @mattyr.
  • #589: Allow overriding tag definitions in Info object - @mattyr.

Fixes

  • #580: Issue #578: fixes duplicated path params - @LeFnord.
  • #585: Issue #584: do not mutate route.path - @LeFnord.
  • #586: Issue #587: Parameters delimited by dash cause exception - @risa.
  • #593: Clarify hidden option in readme - @thogg4.

0.26.1 (February 3, 2017)

Features

Fixes

0.26.0 (January 9, 2017)

Features

  • #558: Version cascading including dependency updates (includes: LeFnord#27) - @LeFnord.
  • #535: Add support for grape version cascading - @qinix.
  • #560: Map clearly Grape desc/detail to Swagger summary/description - @frodrigo.

Fixes

0.25.3 (December 18, 2016)

Features

Fixes

0.25.2 (November 30, 2016)

Fixes

  • #544: Fixes #539 and #542; not all of 530 was commited - @LeFnord.

0.25.1 (November 29, 2016)

Features

Fixes

0.25.0 (October 31, 2016)

Features

  • #524: Use route tags for global tag set - @LeFnord.
  • #523: Allow specifying custom tags at the route level - @jordanfbrown.
  • #520: Response model can have required attributes - @WojciechKo.
  • #510: Use 'token_owner' instead of 'oauth_token' on Swagger UI endpoint authorization - @texpert.

Fixes

  • #527: Accepts string as entity - @LeFnord.
  • #515: Removes limit on model names - @LeFnord.
  • #511: Fix incorrect data type linking for request params of entity types - @serggl.

0.24.0 (September 23, 2016)

Features

  • #504: Added support for set the 'collectionFormat' of arrays - @rczjns.
  • #502: Adds specs for rake tasks - @LeFnord.
  • #501: Adds getting of a specified resource for Rake Tasks - @LeFnord.
  • #500: Adds Rake tasks to get and validate OAPI/Swagger documentation - @LeFnord.
  • #493: Swagger UI endpoint authorization - @texpert.
  • #492: Define security requirements on endpoint methods - @tomregelink.
  • #497: Use ruby-grape-danger in Dangerfile - @dblock.

Fixes

  • #503: Corrects exposing of inline definitions - @LeFnord.
  • #494: Header parametes are now included in documentation when body parameters have been defined - @anakinj.
  • #505: Combines namespaces with their mounted paths to allow APIs with specified mount_paths - @KevinLiddle.

0.23.0 (August 5, 2016)

Features

Fixes

  • #489: Makes version settings/usage more clear; updates UPGRADE.md, README.md - @LeFnord.
  • #476: Fixes for handling the parameter type when body parameters are defined inside desc block - @anakinj.
  • #478: Refactors building of properties, corrects documentation of array items - @LeFnord.
  • #479: Fix regex for Array and Multi Type in doc_methods. Parsing of "[APoint]" should return "APoint" - @frodrigo.
  • #483: Added support for nicknamed routes - @pbendersky.

0.22.0 (July 12, 2016)

Features

  • #470: Document request definitions inline - @LeFnord.
  • #448: Header parameters are now prepended to the parameter list - @anakinj.
  • #444: With multi types parameter the first type is use as the documentation type - @scauglog.
  • #463: Added 'hidden' option for parameter to be exclude from generated documentation - @anakinj.
  • #471: Allow Security Definitions Objects to be defined - @bendodd.

Fixes

  • #472: Fixes required property for request definitions - @LeFnord.
  • #467: Refactors moving of body params - @LeFnord.
  • #464: Fixes array params, sets correct type and format for items - @LeFnord.
  • #461: Fixes issue by adding extensions to definitions. It appeared, if for the given status code, no definition could be found - @LeFnord.
  • #455: Setting type: option as Array[Class] creates array type in JSON - @tyspring.
  • #450: Do not add :description to definitions if :description is missing on path - @texpert.
  • #447: Version part of the url is now ignored when generating tags for endpoint - @anakinj.
  • #444: Default value provided in the documentation hash, override the grape default - @scauglog.
  • #443: Type provided in the documentation hash, override the grape type - @scauglog.
  • #454: Include documented Hashes in documentation output - @aschuster3.
  • #457: Using camel case on namespace throws exception on add_swagger_documentation method - @rayko.

0.21.0 (June 1, 2016)

Features

  • #413: Move all model parsing logic to separate gems grape-swagger-entity and added representable parser grape-swagger - @Bugagazavr.
  • #434: Add summary to the operation object generator to be more compliant with OpenAPI v2 - @aschuster3.
  • #441: Accepting String, lambda and proc for host and base_path - @LeFnord.

Fixes

  • #416: Support recursive models - @lest.
  • #419: Replaced github ref to rubygems for external gems - @Bugagazavr.
  • #420: Raise SwaggerSpec exception if swagger spec isn't satisfied, when no parser for model is registered or response model is empty - @Bugagazavr.
  • #438: Route version was missing in :options passed to PathString, so Endpoint.path_and_definitions_objects wasn't returning a versioned path when required - @texpert.

0.20.3 (May 9, 2016)

Features

Fixes

0.20.2 (April 22, 2016)

Fixes

0.20.1 (April 17, 2016)

Features

  • #382: Made schemes optional - @wleeper.
  • #381: Added entity property description when property documentation desc option is present - @elciok.

Fixes

  • #383: Fixed support for Grape 0.12.0 through 0.14.0 - @LeFnord.

0.20.0 (April 9, 2016)

Features

  • #336: Added Swagger 2.0 support - @LeFnord.
  • #371: Added param type body handling - @LeFnord.
  • #367: Set default type: Integer and required: true for path params, if they weren't specified inside the params block as required - @LeFnord.
  • #365: Fixed passing markdown with redcarpet even with nil description and detail - @LeFnord.
  • #358: Removed allowMultiple property from params, added format to definition property and renamed defaultValue to default - @LeFnord.
  • #356: Added consumes - @LeFnord.
  • #354: Fixed setting of base_path and host, added possibility to configure the setting of version and base_path in documented path and operationId - @LeFnord.
  • #353, #352: Fixed exception with routes having a dynamic :section - @LeFnord.

0.10.5 (April 12, 2016)

  • #344: Namespace based tag included in Swagger JSON - @LeFnord.

0.10.2 (August 19, 2015)

Features

  • #215: Support swagger defaultValue without the need to set a Grape default - @jv-dan.

Fixes

  • #273: Fix for hide_format when API class uses a single format with Grape 0.12.0 - @mattolson.
  • #264: Consistent header param types - @QuickPay.
  • #260, #261: Fixed endpoints that would wrongly be hidden if hide_documentation_path is set - @QuickPay.
  • #259: Fixed range values and converting integer :values range to a minimum/maximum numeric Range - @u2.
  • #252: Allow docs to mounted in separate class than target - @iangreenleaf.
  • #251: Fixed model id equal to model name when root existing in entities - @aitortomas.
  • #232: Fixed missing raw array params - @u2.
  • #234: Fixed range :values with float - @azhi.
  • #225: Fixed param_type to have it read from parameter's documentation hash - @zsxking.
  • #235: Fixed nested entity names in parameters and as $ref in models - @frodrigo.
  • #206: Fixed 'is_array' in the return entity being ignored - @igormoochnick.
  • #266: Respect primitive mapping on type and format attributes of 1.2 swagger spec - @frodrigo.
  • #268: Fixed handling of type: Array[...] - @frodrigo.
  • #284: Use new params syntax for swagger doc endpoint, fix an issue that :name params not recognized by declared method - @calfzhou.
  • #286: Use detail value for notes - fix an issue where detail value specified in a block passed to desc was ignored - @rngtng.

0.10.1 (March 11, 2015)

  • #227: Fix: nested routes under prefix not documented - @dblock.
  • #226: Fix: be defensive with nil exposure types - @dblock.

0.10.0 (March 10, 2015)

Features

  • #217: Support Array of entities for proper rendering of grape-entity input dependencies - @swistaczek.
  • #214: Allow anything that responds to call to be used in :hidden - @zbelzer.
  • #196: If :type is omitted, see if it's available in :using - @jhollinger.
  • #200: Treat type: Symbol as string form parameter - @ypresto.
  • #207: Support grape mutually_exclusive - @mintuhouse.
  • #220: Support standalone appearance of namespace routes with a custom name instead of forced nesting - @croeck.

Fixes

  • #221: Fixed group parameters' name with type Array - @u2.
  • #211: Fixed the dependency, just require 'grape' - @u2.
  • #210: Fixed the range :values option, now exposed as enum parameters - @u2.
  • #208: Fixed Float parameters, exposed as Swagger float types - @u2.
  • #216, #192, #189: Fixed API route paths matching for root endpoints with grape ~> 0.10.0, specific format and :path versioning - @dm1try, @minch.

0.9.0 (December 19, 2014)

0.8.0 (August 30, 2014)

Features

  • #139: Added support for Rack::Multipart::UploadedFile parameters - @timgluz.
  • #136, #94: Recurse combination of namespaces when using mounted apps - @renier.
  • #100: Added ability to specify a nickname for an endpoint - @lhorne.
  • #94: Added support for namespace descriptions - @renier.
  • #110, #111: Added responseModel support - @bagilevi.
  • #114: Added support for generating nested models from composed Grape Entities - @dspaeth-faber.
  • #124: Added ability to change the description and parameters of the API endpoints generated by grape-swagger - @dblock.
  • #128: Combine global models and endpoint entities - @dspaeth-faber.
  • #132: Addes support for enum values in entity documentation and form parameters - @Antek-drzewiecki.
  • #142, #143: Added support for kramdown, redcarpet and custom formatters - @Antek-drzewiecki.

Fixes

  • #105: Fixed compatibility with Swagger-UI - @CraigCottingham.
  • #87: Fixed mapping of default to defaultValue - @m-o-e.
  • #127: Fixed undefined method 'reject' for nil:NilClass error for an invalid route, now returning 404 Not Found - @dblock.
  • #135: Fixed model inclusion in models with aliased references - @cdarne.

Dev

  • #126: Rewritten demo in the test folder with CORS enabled - @dblock.
  • Rewritten .gemspec and removed Jeweler - @dblock.
  • Added GrapeSwagger::VERSION - @dblock.
  • Added Rubocop, Ruby-style linter - @dblock.

0.7.2 (February 6, 2014)

  • #84: Markdown is now Github Flavored Markdown - @jeromegn.
  • #83: Improved support for nested Entity types - @jeromegn.
  • #79: Added dataType to the params output - @Phobos98.
  • #75, #82: Added Swagger 1.2 support - @joelvh, @jeromegn.
  • #73: Added the ability to add additional API info - @mattbeedle.
  • #69: Make relative base_path values absolute - @dm1try.
  • #66: Fixed documentation generated for paths that don't match the base URL pattern - @swistaczek.
  • #63: Added support for hiding endpoints from the documentation - @arturoherrero.
  • #62: Fixed handling of URLs with the - character - @dadario.
  • #57: Fixed documenting of multiple API versions - @Drakula2k.
  • #58: Fixed resource groupings for prefixed APIs - @aew.
  • #56: Fixed hide_documentation_path on prefixed APIs - @spier.
  • #54: Adding support for generating swagger responseClass and models from Grape Entities - @calebwoods.
  • #46: Fixed translating parameter type to String, enables using Mongoid fields as parameter definitions - @dblock.

0.6.0 (June 19, 2013)

  • Added Rails 4 support - @jrhe.
  • Fix: document APIs at root level - @dblock.
  • Added support for procs in basepath - @ruby-grape.
  • Support both :desc and :description when describing parameters - @dblock.
  • Fix: allow parameters such as name[] - @dblock.

0.5.0 (March 28, 2013)

0.4.0 (March 28, 2013)

0.3.0 (October 19, 2012)

  • Added version support - @agileanimal, @fknappe.
  • Added support for nested parameters - @ruby-grape.
  • Added basic support for specifying parameters that need to be passed in the header - @agileanimal.
  • Add possibility to hide the documentation paths in the generated swagger documentation - @ruby-grape.

0.2.1 (August 17, 2012)

0.2.0 (July 27, 2012)

0.1.0 (July 19, 2012)

  • Added some configurability to the generated documentation - @ruby-grape.
  • Adapted to rails plugin structure - @ruby-grape.
  • Allowed cross origin, so swagger can be used from official site - @ruby-grape.

0.0.0 (July 19, 2012)