OpenAPITools/openapi-generator

Option to disable validation in the API clients

Open

#4,168 opened on Oct 16, 2019

View on GitHub
 (4 comments) (4 reactions) (0 assignees)Java (26,243 stars) (7,516 forks)batch import
Enhancement: FeatureHacktoberfesthelp wanted

Description

Description

Currently, there's no way to disable validation in the API clients and therefore we cannot use the API clients to perform integration tests with the RESTful backend (e.g. the API client cannot send requests with incorrect values as the client validation rule will fail the operation)

We'll introduce an option (e.g. client_side_validation in the configuration object)

Swagger-codegen version

Latest master

Swagger declaration file content or url
Related issues

To start with, we've added this feature to the Ruby API client.

Suggest a Fix

If anyone wants to work on the enhancement, please reply to let us know.

Contributor guide

Tech stack
rest apiruby
Domain
backendapitesting
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
OpenAPI Generator internalsRuby programmingClient side validation conceptsCode generation templates
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The issue requests adding a `client side validation` option to disable validation in all API clients. The implementation can follow the approach used for the Ruby API client, which has already been added. Relevant files include code generation templates for each target language. Contributors should examine the Ruby implementation and replicate the pattern for other languages, ensuring the option is properly exposed in the generated client configuration.