swagger-api / swagger-api/swagger-codegen

Add Swagger Codegen version to the auto-generated files

Open
#5,998 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: General
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

We want to add Swagger Codegen version (e.g. 2.2.3, 2.3.0-SNAPSHOT, etc) to the auto-generated files (source code, markdown doc, etc) so that developers can easily tell what version of Swagger Codegen was used to generate the files.

Swagger-codegen version

Latest master

Related issues

https://github.com/swagger-api/swagger-codegen/issues/5376

Suggest a Fix

We've already filed a couple PR to add Swagger Codegen version to the following generators:

  • Ruby
  • Java Spring

If anyone wants to contribute similar update for other langauges, please reply to let us know.

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

Start by reading related issue #5376 and reviewing the already-filed Ruby and Java Spring updates. Then compare the other language generators and their generated source or Markdown templates. Done means generated files identify the Swagger Codegen version consistently without duplicating the work already covered by those updates.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, ruby, spring
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.