Add support for refined #405
Conversation
| refineV[P](v) match { | ||
| case Right(refined) => DecodeResult.Value(refined) | ||
| //TODO: exploit error | ||
| case Left(_) => DecodeResult.InvalidValue(List()) |
There was a problem hiding this comment.
Is there a simple way to construct a validation error out of a String, I guess no.
I guess I will need to derive a validator out of P (predicate).
But can I have a validator on "V Refined P" before V get construct out of P?
There was a problem hiding this comment.
I think you can use the Validator.Custom, which allows an arbitrary message.
You could also probably define an implicit validator for refined types (where the logic of the validator would run the refined check).
So you would have an implicit custom validator - using refined (for nested refined types; this would be used when deriving codecs for complex datatypes), an an implicit codec for top-level refined types
There was a problem hiding this comment.
to create the custom validation message, maybe there's a way to Show the refined type constraints?
There was a problem hiding this comment.
So unfortunatly for the moment, given a validator[T, V] the only way to get a human description out of it is to have a concrete T value that does not respect it.
If I have time, I will try to make a PR to refined to add a description method on the validator trait, because I think it definitly make sense.
Meanwhile, in this PR I used several compromise:
- Use direct tapir validator when possible (for the moment I did it only for Regexp and NonEmptyString because I am lazy ;) )
- When no direct tapir validator mapping, generate a custom validator with error being the classname of the refined constraint. But when the "validation/refinition" fail, I replace this really bad errror message with the actual failure from refined.
There was a problem hiding this comment.
There was a problem hiding this comment.
Great! That way, this will also end up in the openapi docs. Maybe you could also add this for min/max numbers?
strokyl
force-pushed
the
add_codec_support_for_refined
branch
from
2e35679
to
580f9ea
Compare
|
One last thing would be the docs, similarly as in here: https://tapir-scala.readthedocs.io/en/latest/endpoint/customtypes.html#schema-for-cats-datatypes |
|
Ok so I added the doc. |
| `integration/refined/src/main/scala/sttp/tapir/codec/refined/TapirCodecRefined.scala`. | ||
| If you are not satisfied with the validator generated by `tapir-refined`, you can provide an implicit | ||
| `RefinedValidatorTranslation[T, P]` in scope using `RefinedValidator.fromPrimitiveValidator' to build it (do not | ||
| hesitate to contribute your work). |
|
Released in 0.12.20. Thanks! |
Hello,
I write this piece of code today.
If I improve it (need way to improve error message when decode fail), would you be interrested in merging it?