Apiepie::ParamErrors Inconsistent interface

[wozza35]

Apiepie::ParamErrors Inconsistent interface

[mathieujobin]

I am thinking this might have happened due to a refactor. probably best to update the documentation, unless we're really missing out on something...

[davidwessman]

Might be related to my change with returning multiple errors, so either we need to reconsider that change or update the documentation.

#886

[mathieujobin]

@davidwessman Can you update the documentation ?

[davidwessman]

EDIT Now I realized the point about the different interfaces of param for ParamMissing vs ParamInvalid.
So my answer was probably not on point - sorry.

Previous answer

@mathieujobin I reviewed the README and find that it has been updated to this syntax: ```ruby # ParamError is superclass of ParamMissing, ParamInvalid rescue_from Apipie::ParamError do |e| render text: e.message, status: :unprocessable_entity end ```

using e.message instead of e.param.

---

@wozza35 Where did you find the e.param example?

---

This is my suggestion to handle all the errors, but I am not sure if it should be in the README or not.

rescue_from Apipie::ParamError do |e|
  errors = if e.is_a?(Apipie::ParamMultipleMissing)
    e.params.to_h {|p| [p.name, "has an error"]}
  else
    {e.param => "has an error"}
  end
  
  render json: errors, status: :unprocessable_entity
end

[davidwessman]

So it seems like these errors have always used different interfaces for the params.

ParamInvalid is initialized like:

apipie-rails/lib/apipie/validator.rb

Lines 75 to 77 in 7cc859e

	def error
	ParamInvalid.new(param_name, @error_value, description)
	end

ParamMissing is initialized like:

apipie-rails/lib/apipie/validator.rb

Lines 41 to 49 in 7cc859e

	def self.raise_if_missing_params
	missing_params = []
	yield missing_params
	if missing_params.size > 1
	raise ParamMultipleMissing.new(missing_params)
	elsif missing_params.size == 1
	raise ParamMissing.new(missing_params.first)
	end
	end

apipie-rails/lib/apipie/validator.rb

Lines 359 to 368 in 7cc859e

	BaseValidator.raise_if_missing_params do |missing|
	@hash_params&.each do |k, p|
	if Apipie.configuration.validate_presence?
	missing << p if p.required && !value.key?(k)
	end
	if Apipie.configuration.validate_value?
	p.validate(value[k]) if value.key?(k)
	end
	end
	end

So it seems like it would make sense the change the ParamInvalid error to receive the whole ParamDescription as well.
But that seems like breaking change :/

[mathieujobin]

Inconsistent interface isn't ideal, I convey, but considering the little audience of this gem. I'm not sure its worth fixing.

I guess if enough people vote that its worth it. otherwise, I think this is really minor. or at least, I don't see what exact problem is causes.