metosin/reitit

Option to disable only output validation, not all validation

Open

#602 opened on Mar 24, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Clojure (1,569 stars) (261 forks)batch import
enhancementhelp wanted

Description

If I go to reitit.coercion.malli and create my coercion middleware then I can pass :validate option which would enable the validation on input and output of the endpoints. But if I'd want to only disable it for output and still include it in the Swagger spec I can't do it.

I think it would be a good idea to have the :validate option to not use a boolean but instead have it as a map:

:validate {:encode true, :decode true}

What do you think?

It would also be good to expose it as a map from calling create function and not hacking through by copying the code.

Contributor guide

Tech stack
None
Domain
api
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Clojurereitit librarycoercion middleware
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Review the current implementation of the `:validate` option in `reitit.coercion.malli` and the `create` function. Understand how validation is applied to input and output. Consider modifying the option to accept a map with `:encode` and `:decode` keys, ensuring backward compatibility. Check existing tests and documentation for coherence.