RicoSuter/NSwag

C# Code Generation doesn't validate patterns

Open

#3,145 opened on Nov 6, 2020

View on GitHub
 (7 comments) (0 reactions) (0 assignees)C# (1,189 forks)batch import
help wantedtype: enhancement

Repository metrics

Stars
 (6,291 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hi everyone,

I noticed that the C# code generation doesn't validate patterns (on the client side). If I annotate a parameter of type string with a pattern (e.g. "^v[1-9]$"), I expect the Api method to throw an ApiException when the supplied string doesn't match the pattern.

I'd be happy to open a PR. Is that something this project could use?

Contributor guide

Research direction
Look at the C# client code generation templates in NSwag to find where parameter patterns are handled (or not). Check if there is existing validation logic for other constraints like min/max length. Implement pattern validation in the generated client code.
Tech stack
csharp
Domain
backendapi
Issue type
Bug
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
C#NSwagOpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60