swagger-api / swagger-api/swagger-codegen

Capture spec version in client

Open
#1,462 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature help wanted
Dominant language
Mustache
Stars
17.8k
Forks
6k
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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by locating the generated-client flow and how the OpenAPI specification is represented during generation; clarify whether the goal is only to record the spec version or also enforce server-version compatibility. Done means the intended version behavior is defined and covered for generated clients.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.