apipie-rails 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebba895c2d4385bd3ccc47fe9663ca6e5b06f213308e09c5899e9f8b7ee6b74c
-  data.tar.gz: 11f9e1572ae63af8b463b4c42a2d9c0b74f094f4ef523060f6948cc11172e089
+  metadata.gz: 51731d3325c2241c36c5cf0e19062525d982c2b98fa0d5e0b76a5ba8625ddacd
+  data.tar.gz: 45db678d7324e76064a8d8a632ac5e72048d85ba7d32329168202bd48723219b
 SHA512:
-  metadata.gz: 4fdb149329633f14091638be50d9b1f99c27bcdb4a5e279b042a835c16bc80b54fa750a7fe0fd69b3d0686badd82d93aef88b6b0c172a2ea9706509526f4dd0a
-  data.tar.gz: 98d1d2a93f9403b47dea88edec25761986b6bdc0fb0db9ed83737f72eb5ac3b3c3b4b1b1eddab54d6db48366ad0a3006c4e7bf58ce257586730ea9a3add04faf
+  metadata.gz: 1dc8a4c009d6dc3daee4ac98d2509d832edbf2dc8d9ec08a9f9205d9ef7614c0480ed60132f33116c6a09dd9a0ec3b056c60fc52e3e6a61b6cf67eb913985619
+  data.tar.gz: 4621285ca2c82670ec63c0b5a240b0d6024d37e445c724a243782e492c5c6be65091187ee07ef874ff7d0320d68109577277d885b8ea4a28e2aed8c2a94490cf

data/.github/workflows/build.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        rails: ["7.0", "6.1", "6.0"]
+        rails: ["7.1", "7.0", "6.1", "6.0"]
         ruby: ["3.2.2", "3.1.4", "3.0.6", "2.7.8"]
         include:
           - rails: "5.2"

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
-# `rubocop --auto-gen-config --exclude-limit 180`
-# on 2023-06-09 05:29:05 UTC using RuboCop version 1.52.0.
+# `rubocop --auto-gen-config --exclude-limit 200`
+# on 2023-10-11 12:02:42 UTC using RuboCop version 1.57.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -118,7 +118,7 @@ Layout/ElseAlignment:
     - 'lib/apipie/param_description.rb'
     - 'lib/apipie/resource_description.rb'
 
-# Offense count: 58
+# Offense count: 59
 # This cop supports safe autocorrection (--autocorrect).
 Layout/EmptyLineAfterGuardClause:
   Exclude:
@@ -140,7 +140,7 @@ Layout/EmptyLineAfterGuardClause:
 
 # Offense count: 13
 # This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EmptyLineBetweenMethodDefs, EmptyLineBetweenClassDefs, EmptyLineBetweenModuleDefs, AllowAdjacentOneLineDefs, NumberOfEmptyLines.
+# Configuration parameters: EmptyLineBetweenMethodDefs, EmptyLineBetweenClassDefs, EmptyLineBetweenModuleDefs, DefLikeMacros, AllowAdjacentOneLineDefs, NumberOfEmptyLines.
 Layout/EmptyLineBetweenDefs:
   Exclude:
     - 'app/controllers/apipie/apipies_controller.rb'
@@ -597,14 +597,13 @@ Layout/SpaceInsideParens:
     - 'spec/lib/apipie/method_description/apis_service_spec.rb'
     - 'spec/lib/swagger/swagger_dsl_spec.rb'
 
-# Offense count: 15
+# Offense count: 14
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: final_newline, final_blank_line
 Layout/TrailingEmptyLines:
   Exclude:
     - 'Rakefile'
-    - 'lib/apipie/extractor/collector.rb'
     - 'lib/apipie/method_description/apis_service.rb'
     - 'lib/apipie/rspec/response_validation_helper.rb'
     - 'spec/controllers/concerns_controller_spec.rb'
@@ -778,23 +777,17 @@ Lint/Void:
   Exclude:
     - 'spec/controllers/users_controller_spec.rb'
 
-# Offense count: 58
+# Offense count: 60
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 96
 
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
-# AllowedMethods: refine
-Metrics/BlockLength:
-  Max: 26
-
-# Offense count: 4
+# Offense count: 3
 # Configuration parameters: CountBlocks.
 Metrics/BlockNesting:
   Max: 4
 
-# Offense count: 24
+# Offense count: 25
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
   Max: 24
@@ -807,7 +800,7 @@ Metrics/MethodLength:
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 101
+  Max: 119
 
 # Offense count: 4
 # Configuration parameters: CountKeywordArgs.
@@ -815,7 +808,7 @@ Metrics/ParameterLists:
   MaxOptionalParameters: 5
   Max: 6
 
-# Offense count: 20
+# Offense count: 21
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
   Max: 25
@@ -961,7 +954,7 @@ RSpec/Be:
     - 'spec/controllers/concerns_controller_spec.rb'
     - 'spec/controllers/users_controller_spec.rb'
 
-# Offense count: 59
+# Offense count: 60
 # This cop supports unsafe autocorrection (--autocorrect-all).
 RSpec/BeEq:
   Exclude:
@@ -1054,7 +1047,7 @@ RSpec/EmptyLineAfterHook:
   Exclude:
     - 'spec/lib/apipie/apipies_controller_spec.rb'
 
-# Offense count: 51
+# Offense count: 52
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 85
@@ -1148,12 +1141,12 @@ RSpec/MessageSpies:
 RSpec/MultipleExpectations:
   Max: 19
 
-# Offense count: 156
+# Offense count: 160
 # Configuration parameters: AllowSubject.
 RSpec/MultipleMemoizedHelpers:
   Max: 15
 
-# Offense count: 82
+# Offense count: 85
 # Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
 # SupportedStyles: always, named_only
 RSpec/NamedSubject:
@@ -1173,7 +1166,7 @@ RSpec/NamedSubject:
     - 'spec/lib/swagger/rake_swagger_spec.rb'
     - 'spec/lib/swagger/swagger_dsl_spec.rb'
 
-# Offense count: 94
+# Offense count: 96
 # Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:
   Max: 6
@@ -1235,14 +1228,14 @@ RSpec/StubbedMock:
     - 'spec/lib/apipie/extractor/writer_spec.rb'
     - 'spec/lib/apipie/param_description_spec.rb'
 
-# Offense count: 5
+# Offense count: 6
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
 RSpec/VerifiedDoubles:
   Exclude:
     - 'spec/lib/apipie/apipies_controller_spec.rb'
+    - 'spec/lib/apipie/extractor/recorder_spec.rb'
     - 'spec/lib/apipie/extractor/writer_spec.rb'
     - 'spec/lib/validators/array_validator_spec.rb'
-    - 'spec/lib/apipie/extractor/recorder_spec.rb'
 
 # Offense count: 1
 RSpec/VoidExpect:
@@ -1266,6 +1259,7 @@ Rails/Delegate:
     - 'lib/apipie/response_description_adapter.rb'
 
 # Offense count: 24
+# This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: slashes, arguments
 Rails/FilePath:
@@ -1455,7 +1449,7 @@ Style/ClassCheck:
     - 'lib/apipie/validator.rb'
 
 # Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
+# This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 # AllowedMethods: ==, equal?, eql?
 Style/ClassEqualityComparison:
@@ -1747,7 +1741,7 @@ Style/ParallelAssignment:
     - 'lib/apipie/extractor.rb'
     - 'lib/apipie/extractor/recorder.rb'
 
-# Offense count: 6
+# Offense count: 8
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: PreferredDelimiters.
 Style/PercentLiteralDelimiters:
@@ -1826,7 +1820,7 @@ Style/RedundantPercentQ:
   Exclude:
     - 'apipie-rails.gemspec'
 
-# Offense count: 27
+# Offense count: 29
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowMultipleReturnValues.
 Style/RedundantReturn:
@@ -1927,7 +1921,7 @@ Style/StringConcatenation:
     - 'lib/apipie/application.rb'
     - 'lib/apipie/extractor/writer.rb'
 
-# Offense count: 1212
+# Offense count: 1214
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes

data/CHANGELOG.md

@@ -1,6 +1,19 @@
  Changelog
 ===========
 
+## [v1.3.0](https://github.com/Apipie/apipie-rails/tree/v1.3.0) (2023-12-19)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v1.2.3...v1.3.0)
+* rubocop fixes ([#897](https://github.com/Apipie/apipie-rails/pull/897)) (Mathieu Jobin)
+* Fix usage of deprecated Rack::File in Rack 3.0 ([#896](https://github.com/Apipie/apipie-rails/pull/896)) (James Dean Shepherd)
+* add rails 7.1 to the build matrix ([#898](https://github.com/Apipie/apipie-rails/pull/898)) (Mathieu Jobin)
+* super small typo fix ([#900](https://github.com/Apipie/apipie-rails/pull/900)) (Eric Pugh)
+* support for property example ([#901](https://github.com/Apipie/apipie-rails/pull/901)) (Chien-Wei Huang (Michael))
+* Use array items type from validator ([#904](https://github.com/Apipie/apipie-rails/pull/)) (Panos Dalitsouris)
+
+## [v1.2.3](https://github.com/Apipie/apipie-rails/tree/v1.2.3) (2023-10-11)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v1.2.2...v1.2.3)
+* Fix param: Consider default_value: nil as valid config ([#894](https://github.com/Apipie/apipie-rails/pull/894)) (davidwessman)
+
 ## [v1.2.2](https://github.com/Apipie/apipie-rails/tree/v1.2.2) (2023-07-18)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v1.2.1...v1.2.2)
 * Fixed Swagger warnings for properties ([#892](https://github.com/Apipie/apipie-rails/pull/892)) (shev-vadim-net)

data/README.rst

@@ -317,6 +317,9 @@ desc
 required
   Set this true/false to make it required/optional. Default is optional
 
+example
+  Provide the example for this parameter.
+
 allow_nil
   Setting this to true means that ``nil`` can be passed.
 
@@ -349,8 +352,8 @@ Example:
 .. code:: ruby
 
    param :user, Hash, :desc => "User info" do
-     param :username, String, :desc => "Username for login", :required => true
-     param :password, String, :desc => "Password for login", :required => true
+     param :username, String, :desc => "Username for login", :required => true, :example => 'John'
+     param :password, String, :desc => "Password for login", :required => true, :example => '1234567'
      param :membership, ["standard","premium"], :desc => "User membership"
      param :admin_override, String, :desc => "Not shown in documentation", :show => false
      param :ip_address, String, :desc => "IP address", :required => true, :missing_message => lambda { I18n.t("ip_address.required") }
@@ -1030,7 +1033,7 @@ layout
 
 ignored
   An array of controller names (strings) (might include actions as well)
-  to be ignored when generationg the documentation
+  to be ignored when generating the documentation
   e.g. ``%w[Api::CommentsController Api::PostsController#post]``
 
 namespaced_resources

data/lib/apipie/dsl_definition.rb

@@ -242,7 +242,7 @@ module Apipie
 
               if Apipie.configuration.validate_presence?
                 Validator::BaseValidator.raise_if_missing_params do |missing|
-                  method_params.each do |_, param|
+                  method_params.each_value do |param|
                     # check if required parameters are present
                     missing << param if param.required && !params.key?(param.name)
                   end
@@ -250,7 +250,7 @@ module Apipie
               end
 
               if Apipie.configuration.validate_value?
-                method_params.each do |_, param|
+                method_params.each_value do |param|
                   # params validations
                   param.validate(params[:"#{param.name}"]) if params.key?(param.name)
                 end
@@ -267,12 +267,11 @@ module Apipie
                 end
               end
 
-              if Apipie.configuration.process_value?
-                @api_params ||= {}
-                method_params.each do |_, param|
-                  # params processing
-                  @api_params[param.as] = param.process_value(params[:"#{param.name}"]) if params.key?(param.name)
-                end
+              return unless Apipie.configuration.process_value?
+              @api_params ||= {}
+              method_params.each_value do |param|
+                # params processing
+                @api_params[param.as] = param.process_value(params[:"#{param.name}"]) if params.key?(param.name)
               end
             end
           end

data/lib/apipie/errors.rb

@@ -62,7 +62,7 @@ module Apipie
     attr_accessor :value, :error
 
     def initialize(param, value, error)
-      super param
+      super(param)
       @value = value
       @error = error
     end

data/lib/apipie/extractor/collector.rb

@@ -89,7 +89,7 @@ module Apipie
       end
 
       def finalize_descriptions
-        @descriptions.each do |method, desc|
+        @descriptions.each_value do |desc|
           add_routes_info(desc)
         end
         return @descriptions

data/lib/apipie/extractor/recorder.rb

@@ -90,7 +90,7 @@ module Apipie
           lines << '' << %{... contents of "#{attrs[:name]}" ...}
         else
           # Look for subelements that contain a part.
-          attrs.each { |k,v| v.is_a?(Hash) and reformat_hash(boundary, v, lines) }
+          attrs.each_value { |v| v.is_a?(Hash) and reformat_hash(boundary, v, lines) }
         end
       end
 

data/lib/apipie/extractor/writer.rb

@@ -80,7 +80,7 @@ module Apipie
 
       def write_docs
         descriptions = @collector.finalize_descriptions
-        descriptions.each do |_, desc|
+        descriptions.each_value do |desc|
           if desc[:api].empty?
             logger.warn("REST_API: Couldn't find any path for #{desc_to_s(desc)}")
             next

data/lib/apipie/generator/swagger/config.rb

@@ -24,7 +24,7 @@ module Apipie
               HEREDOC
             )
 
-            send("#{attribute}=", value)
+            send(:"#{attribute}=", value)
           end
 
           old_setter_method = "swagger_#{attribute}"

data/lib/apipie/generator/swagger/method_description/parameters_service.rb

@@ -96,7 +96,7 @@ class Apipie::Generator::Swagger::MethodDescription::ParametersService
   def path_param_descriptions
     @path_param_descriptions ||= all_params
                                  .select { |k, _| @path.param?(k) }
-                                 .each { |_, desc| desc.required = true }
+                                 .each_value { |desc| desc.required = true }
                                  .values
   end
 

data/lib/apipie/generator/swagger/param_description/builder.rb

@@ -53,6 +53,7 @@ class Apipie::Generator::Swagger::ParamDescription::Builder
 
     definition.merge!(for_default)
     definition.merge!(for_required)
+    definition.merge!(for_example)
     definition.merge!(@description.to_hash) if @description.present?
 
     warn_optional_without_default_value(definition)
@@ -71,13 +72,21 @@ class Apipie::Generator::Swagger::ParamDescription::Builder
   end
 
   def for_default
-    return {} if @param_description.options[:default_value].blank?
+    return {} unless @param_description.options.key?(:default_value)
 
     {
       default: @param_description.options[:default_value],
     }
   end
 
+  def for_example
+    return {} unless @param_description.options.key?(:example)
+
+    {
+      example: @param_description.options[:example],
+    }
+  end
+
   def required?
     required_from_path? || @param_description.required
   end

data/lib/apipie/generator/swagger/param_description/type.rb

@@ -56,7 +56,7 @@ class Apipie::Generator::Swagger::ParamDescription::Type
 
   def for_array_type
     validator_opts = validator.param_description.options
-    items_type = validator_opts[:of].to_s || validator_opts[:array_of].to_s
+    items_type = (validator_opts[:of] || validator_opts[:array_of]).to_s
 
     if items_type == 'Hash' && params_in_body_use_reference?
       reference_name = Apipie::Generator::Swagger::OperationId.
@@ -67,7 +67,7 @@ class Apipie::Generator::Swagger::ParamDescription::Type
         '$ref' => reference_name
       }
     else
-      items = { type: 'string' }
+      items = { type: array_items_type(items_type).to_s }
     end
 
     enum = @param_description.options[:in]
@@ -80,6 +80,19 @@ class Apipie::Generator::Swagger::ParamDescription::Type
     }
   end
 
+  # @param [String] items_type
+  #
+  # @return [Apipie::Generator::Swagger::Type]
+  def array_items_type(items_type)
+    type = Apipie::Generator::Swagger::TypeExtractor::TYPES[items_type.downcase.to_sym]
+
+    if type == 'object' || type.blank?
+      Apipie::Generator::Swagger::TypeExtractor::TYPES[:string]
+    else
+      type
+    end
+  end
+
   def for_enum_type
     {
       type: 'string',

data/lib/apipie/generator/swagger/resource_description_collection.rb

@@ -19,9 +19,9 @@ class Apipie::Generator::Swagger::ResourceDescriptionsCollection
 
     if method_name.present?
       resources = resources.select do |resource_description|
-        resource_description._methods.select do |method_description_name, _|
+        resource_description._methods.any? do |method_description_name, _|
           method_description_name == method_name
-        end.present?
+        end
       end
     end
 

data/lib/apipie/response_description_adapter.rb

@@ -57,7 +57,7 @@ module Apipie
         attr_reader :expected_type
 
         def [](key)
-          return self.send(key) if self.respond_to?(key.to_s)
+          self.send(key) if self.respond_to?(key.to_s)
         end
 
         def initialize(expected_type, enum_values = nil, sub_properties = nil)
@@ -102,7 +102,7 @@ module Apipie
       end
 
       def [](key)
-        return self.send(key) if self.respond_to?(key.to_s)
+        self.send(key) if self.respond_to?(key.to_s)
       end
 
       def add_sub_property(prop_desc)

data/lib/apipie/static_dispatcher.rb

@@ -4,7 +4,13 @@ module Apipie
     def initialize(root)
       @root          = root.chomp('/')
       @compiled_root = /^#{Regexp.escape(root)}/
-      @file_server   = ::Rack::File.new(@root)
+      @file_server   = if defined?(::Rack::Files)
+                         ::Rack::Files.new(@root)
+                       else
+                         # Deprecated in Rack 3.0, kept
+                         # for backward compatibility
+                         ::Rack::File.new(@root)
+                       end
     end
 
     def match?(path)

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/lib/tasks/apipie.rake

@@ -186,11 +186,11 @@ namespace :apipie do
     av = renderer
     File.open(file_name, "w") do |f|
       variables.each do |var, val|
-        av.instance_variable_set("@#{var}", val)
+        av.instance_variable_set(:"@#{var}", val)
       end
       f.write av.render(
         :template => "#{template}",
-        :layout => (layout && "apipie/#{layout}"))
+        :layout => layout && "apipie/#{layout}")
     end
   end
 
@@ -259,7 +259,7 @@ namespace :apipie do
   end
 
   def generate_resource_pages(version, file_base, doc, include_json = false, lang = nil)
-    doc[:docs][:resources].each do |resource_id, _|
+    doc[:docs][:resources].each_key do |resource_id|
       resource_file_base = File.join(file_base, resource_id.to_s)
       FileUtils.mkdir_p(File.dirname(resource_file_base)) unless File.exist?(File.dirname(resource_file_base))
 

data/spec/dummy/app/controllers/pets_controller.rb

@@ -23,7 +23,7 @@ class PetsController < ApplicationController
   #-----------------------------------------------------------
   api :GET, "/pets/:id/as_properties", "Get a pet record"
   returns :code => 200 do
-    property :pet_name, String, :desc => "Name of pet", :required => false
+    property :pet_name, String, :desc => "Name of pet", :required => false, :example => 'mypet'
     property :animal_type, %w[dog cat iguana kangaroo], :desc => "Type of pet"   # required by default, because this is a 'property'
   end
   returns :code => 404 do

data/spec/lib/apipie/apipies_controller_spec.rb

@@ -57,8 +57,7 @@ describe Apipie::ApipiesController, type: :controller do
     end
 
     it "succeeds on method details with the default language" do
-      allow(Apipie.configuration).to receive(:default_locale).and_return("en")
-      allow(Apipie.configuration).to receive(:languages).and_return([])
+      allow(Apipie.configuration).to receive_messages(default_locale: "en", languages: [])
 
       get :index, :params => { :version => "2.0", :resource => "architectures", :method => "index.en" }
 

data/spec/lib/apipie/extractor_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe Apipie::Extractor do
   it 'handles routes without (.:format)' do
-    Apipie::Extractor.apis_from_routes.each do |(controller, action), apis|
+    Apipie::Extractor.apis_from_routes.each_value do |apis|
       apis.each { |api| expect(api[:path]).not_to be_nil }
     end
   end

data/spec/lib/apipie/generator/swagger/method_description/response_schema_service_spec.rb

@@ -19,8 +19,8 @@ describe Apipie::Generator::Swagger::MethodDescription::ResponseSchemaService do
 
   let(:response_description_dsl) do
     proc do
-      property :a_number, Integer
-      property :an_optional_number, Integer, required: false
+      property :a_number, Integer, example: 1
+      property :an_optional_number, Integer, required: false, example: 2
     end
   end
 
@@ -56,10 +56,10 @@ describe Apipie::Generator::Swagger::MethodDescription::ResponseSchemaService do
         expect(properties).to eq(
           {
             a_number: {
-              type: 'number', required: true
+              type: 'number', required: true, example: 1
             },
             an_optional_number: {
-              type: 'number'
+              type: 'number', example: 2
             }
           }
         )
@@ -72,10 +72,10 @@ describe Apipie::Generator::Swagger::MethodDescription::ResponseSchemaService do
           expect(properties).to eq(
             {
               a_number: {
-                type: %w[number null], required: true
+                type: %w[number null], required: true, example: 1
               },
               an_optional_number: {
-                type: %w[number null]
+                type: %w[number null], example: 2
               }
             }
           )

data/spec/lib/apipie/generator/swagger/param_description/builder_spec.rb

@@ -102,23 +102,49 @@ describe Apipie::Generator::Swagger::ParamDescription::Builder do
 
     subject { generated_block }
 
-    context 'when is not required' do
-      let(:base_param_description_options) { { required: false } }
+    context 'when required is true' do
+      let(:base_param_description_options) { { required: true } }
+
+      it 'does not output an option without default warning' do
+        expect { subject }.not_to output(
+          /is optional but default value is not specified/
+        ).to_stderr
+      end
+    end
 
-      context 'and no default is given' do
-        before { param_description_options.delete(:default) }
+    context 'when required is false' do
+      context 'when default_value is nil' do
+        let(:base_param_description_options) do
+          { required: false, default_value: nil }
+        end
 
-        it 'outputs an option without default warning' do
-          expect { subject }.to output(/is optional but default value is not specified/).to_stderr
+        it 'will not warn' do
+          expect { subject }.not_to output(
+            /is optional but default value is not specified/
+          ).to_stderr
         end
       end
-    end
 
-    context 'when is required' do
-      let(:base_param_description_options) { { required: true } }
+      context 'when default_value is 123' do
+        let(:base_param_description_options) do
+          { required: false, default_value: 123 }
+        end
 
-      it 'does not output an option without default warning' do
-        expect { subject }.not_to output(/is optional but default value is not specified/).to_stderr
+        it 'will not warn' do
+          expect { subject }.not_to output(
+            /is optional but default value is not specified/
+          ).to_stderr
+        end
+      end
+
+      context 'default_value not given' do
+        let(:base_param_description_options) { { required: false } }
+
+        it 'warns' do
+          expect { subject }.to output(
+            /is optional but default value is not specified/
+          ).to_stderr
+        end
       end
     end
   end
@@ -174,4 +200,16 @@ describe Apipie::Generator::Swagger::ParamDescription::Builder do
       it { is_expected.to be_present }
     end
   end
+
+  describe 'example' do
+    subject { generated_block[:example] }
+
+    it { is_expected.to be_blank }
+
+    context 'when example is assigned' do
+      let(:base_param_description_options) { { example: 'example' } }
+
+      it { is_expected.to eq('example') }
+    end
+  end
 end

data/spec/lib/apipie/generator/swagger/param_description/type_spec.rb

@@ -115,10 +115,15 @@ describe Apipie::Generator::Swagger::ParamDescription::Type do
           it 'returns the reference' do
             expect(subject).to eq({ '$ref' => reference })
           end
-
         end
       end
 
+      context 'of a Swagger type' do
+        let(:validator_options) { { of: Integer } }
+
+        it { is_expected.to eq({ type: 'integer' }) }
+      end
+
       describe 'enum' do
         subject { items[:enum] }
 

data/spec/lib/apipie/swagger_generator_spec.rb

@@ -7,7 +7,7 @@ describe Apipie::SwaggerGenerator do
 
     let(:response_description_dsl) do
       proc do
-        property :a_number, Integer
+        property :a_number, Integer, example: 1
         property :an_optional_number, Integer, required: false
       end
     end
@@ -61,7 +61,7 @@ describe Apipie::SwaggerGenerator do
           expect(properties).to eq(
             {
               a_number: {
-                type: 'number', required: true
+                type: 'number', required: true, example: 1
               },
               an_optional_number: {
                 type: 'number'

data/spec/lib/swagger/rake_swagger_spec.rb

@@ -82,6 +82,10 @@ describe 'rake tasks' do
       expect(param[field]).to eq(value)
     end
 
+    def expect_response_params_def(http_method, path, response_code, param_name, field, value)
+      param = apidoc_swagger["paths"][path][http_method]["responses"][response_code.to_s]["schema"]["properties"][param_name]
+      expect(param[field]).to eq(value)
+    end
 
     describe 'apipie:static_swagger_json[development,json,_tmp]' do
       it "generates static swagger files for the default version of apipie docs" do
@@ -105,6 +109,7 @@ describe 'rake tasks' do
                          %w[finance operations sales marketing HR])
 
         expect_tags_def("get", "/twitter_example/{id}/followers", %w[twitter_example following index search])
+        expect_response_params_def("get", "/pets/{id}/as_properties", 200, "pet_name", "example", "mypet")
       end
 
       it "generates a valid swagger file" do
@@ -146,7 +151,7 @@ describe 'rake tasks' do
 
     describe 'apipie:did_swagger_change[development,form_data,_tmp]' do
       it "keeps a reference file" do
-        expect(Pathname(ref_output).children.count).to eq(2)  # one file for each language
+        expect(Pathname(ref_output).children.count).to eq(2) # one file for each language
       end
     end
   end

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'bundler/setup'
 
 require 'simplecov'
-SimpleCov.minimum_coverage 89
+SimpleCov.minimum_coverage 91
 SimpleCov.start
 
 ENV["RAILS_ENV"] ||= 'test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-18 00:00:00.000000000 Z
+date: 2023-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -472,7 +472,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Rails REST API documentation tool