swagger-api/swagger-codegen

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

Open

#3084 aperta il 8 giu 2016

Vedi su GitHub
 (18 commenti) (13 reazioni) (0 assegnatari)HTML (5474 fork)batch import
Enhancement: Featurehelp wanted

Metriche repository

Star
 (12.701 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Identifica i file template Mustache che contengono {{generatedDate}} e rimuovi la variabile e la logica associata dal template e da qualsiasi modello o codice correlato che la imposta.
Tech stack
java
Dominio
backend api design
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85