swagger-api/swagger-codegen

Capture spec version in client

Open

#1,462 opened on Oct 28, 2015

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)HTML (5,474 forks)batch import
Enhancement: Featurehelp wanted

Repository metrics

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

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

Research direction
Examine the Codegen class to understand how spec metadata is stored. Add a field for the spec version in the Codegen model and expose it in the default templates (e.g., mustache variables). Verify by generating a client and checking the output.
Tech stack
java
Domain
apibackendtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
JavaSwagger/OpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60