swagger-api/swagger-codegen

[Suggestion] Remove timestamp from auto-generated code/documentation

Open

#3,084 opened on Jun 8, 2016

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

Description

In the coming major release 2.2.0, we want to remove {{generatedDate}} from the mustache template as this will introduce a lot of noise when it comes to reviewing the auto-generated code/documentation. Here is an example:

 package io.swagger.client;

 -@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2016-06-04T21:04:39.523+08:00")
 +@javax.annotation.Generated(value = "class io.swagger.codegen.languages.JavaClientCodegen", date = "2016-06-08T18:45:27.896+02:00")
  public class StringUtil {
    /**
     * Check if the given array contains the given value (with case-insensitive comparison).

If anyone has a good reason to keep it in the auto-generated timestamp, please reply to let us know.

Contributor guide

Tech stack
java
Domain
toolingdeveloper experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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.
clear
Prerequisites
Mustache template basicsswagger codegen repository navigation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Locate the Mustache templates in the swagger codegen repository that contain `{{generatedDate}}`. These are typically under `modules/swagger codegen/src/main/resources/`. Remove the variable from all template files, and verify that the generated code no longer includes the timestamp. Check the issue comments for any objections or alternative proposals, as this change is slated for a major release.
[Suggestion] Remove timestamp from auto-generated code/documentation · swagger-api/swagger-codegen#3084 | Good First Issue