swagger-api/swagger-codegen

Capture spec version in client

Open

#1,462 opened on Oct 28, 2015

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

Description

It would be beneficial if there was a way to make sure a generated client is restricted to a server version.

Even if there is no restriction, I would like a way to capture the version of the spec that the client was generated against.

Contributor guide

Tech stack
None
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
OpenAPI specificationCode generation concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Investigate how swagger codegen currently processes the OpenAPI/Swagger spec during code generation. Look for existing metadata extraction in the codegen engine (e.g., io.swagger.codegen.DefaultCodegen). Consider adding a field to store the spec version (e.g., from the 'info.version' property) in the generated client's configuration or metadata class. Review similar features in other API client generators for reference.