swagger-api/swagger-codegen

Add validation to parameter/property

Open

#2,663 opened on Apr 20, 2016

View on GitHub
 (11 comments) (4 reactions) (0 assignees)HTML (5,474 forks)batch import
Client: AndroidClient: C++Client: C-SharpClient: ClojureClient: DartClient: GoClient: HTMLClient: JavaClient: JavaScript/Node.jsClient: ObjcClient: PHPClient: PerlClient: PythonClient: RetrofitClient: RubyClient: ScalaClient: SwiftClient: TypeScriptEnhancement: Featurehelp wanted

Repository metrics

Stars
 (12,701 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We want to add validation (e.g. maximum, minimum, pattern, etc) to parameters and model properties.

If anyone is interested in adding the property/parameter validation to a particular language, please reply to let us know.

  • Android
  • C++
  • C#
  • Clojure
  • Dart
  • Flash
  • Go
  • Javascript
  • Java
  • ObjC
  • Perl
  • PHP (#2778, #2733)
  • Python (#2794)
  • Ruby (#2697, #2695)
  • Swift
  • Scala
  • TypeScript

Contributor guide

Research direction
Identify a language without validation support, study an existing implementation (e.g., Ruby or Python), and replicate the logic in the target language's template files.
Tech stack
java
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-2 days
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
Knowledge of swagger codegenTemplate language (mustache)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60