swagger-api / swagger-api/swagger-codegen

Option to disable validation in the API clients

Open
#5,530 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature Feature List: API clients help wanted
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

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

https://github.com/swagger-api/swagger-codegen/pull/5528 has been submitted for Ruby API client.

Suggest a Fix

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the API client generation templates and the related Ruby API client pull request at #5528. Determine how a configuration option such as client_side_validation should be exposed across generated clients, then verify that invalid request values can be sent when validation is disabled without changing the default behavior.

Written by the indexing model from the issue text.

Assessment

Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.