swagger-api/swagger-codegen

[JAVA] - Consider regex for path params (subresource operation)

Open

#6263 opened on Aug 8, 2017

View on GitHub
 (7 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: JavaEnhancement: Featurehelp wanted

Description

Description

I'm trying to generate resource endpoints which contain some sort of regex to validate the path params. Fox example: @Path(/resource/{res:[a-zA-z]})

Couldn't find a way to produce that kind of souce code. Does anyone know if this feature is already implemented?

Swagger-codegen version

2.2.2

Contributor guide

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.
4
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaSwagger codegen project setup
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
The issue asks for support of regex in path parameter definitions (e.g., @Path("/resource/{id:[a z]+}")). Reviewing the comments (7 total) might reveal discussion on feasibility or workarounds. The Java codegen templates (likely in modules/swagger codegen/src/main/resources/Java/...) would need modification to emit regex constraints. The OpenAPI spec does support regex patterns for parameters, so this requires mapping that property. Existing tests for path parameter generation can guide implementation. Maintainer input is recommended to confirm acceptance.