Sha256: 0bd020a5eab6a0da061d87d13eb100f98646c851bda060ef4d3bcb765e8b1535

Contents?: true

Size: 2 KB

Versions: 6

Compression:

Stored size: 2 KB

Contents

# frozen_string_literal: true
# author: Vadim Shaveiko <@vshaveyko>
# :nodoc:
class RailsApiDoc::Config::ValidateType

  #
  # @api_param_data - RailsApiDoc::Controller::Request::Param
  # @controller_param - ActionController::Parameter
  #
  # check validation of current type by given data
  #
  # type: check that param value is of requested type
  # Examples:
  #
  #   1. controller_param == '1'                                                , api_param_data[:type] == :integer                                  > ok
  #   2. controller_param == 'string'                                           , api_param_data[:type] == :integer                                  > not_ok
  #   3. controller_param == {a: 'b'}                                           , api_param_data[:type] == :object                                   > ok
  #   4. controller_param == [{a:'b'}, {c: 'd'}]                                , api_param_data[:type] == :ary_object                               > ok
  #   5. controller_param == "2016-11-26 13:55:30 +0200"(or any other singature , use DateTime.parse to check) , api_param_data[:type] == :datetime  > ok
  #   6. controller_param == 'true'                                             , api_param_data[:type] == :bool                                     > ok
  #   7. controller_param == true                                               , api_param_data[:type] == :bool                                     > ok
  #   8. controller_param == 'ok'                                               , api_param_data[:type] == :bool                                     > not_ok
  #   9. controller_param == ['1', '2', 3]                                      , api_param_data[:type] == :array                                    > ok
  #  10. controller_param == [{a:'b'}]                                          , api_param_data[:type] == :array                                    > not_ok
  #
  # TODO: write rspec for this cases and implement
  def valid?(_controller_param, _api_param_data)
    true
  end

end

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
rails_api_documentation-0.3.4 lib/rails_api_doc/config/validate_type.rb
rails_api_documentation-0.3.3 lib/rails_api_doc/config/validate_type.rb
rails_api_documentation-0.3.2 lib/rails_api_doc/config/validate_type.rb
rails_api_documentation-0.3.1 lib/rails_api_doc/config/validate_type.rb
rails_api_documentation-0.3.0 lib/rails_api_doc/config/validate_type.rb
rails_api_documentation-0.2.3 lib/rails_api_doc/config/validate_type.rb