swagger-api / swagger-api/swagger-codegen
[Suggestion] Remove timestamp from auto-generated code/documentation
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Mustache template that emits {{generatedDate}} and inspect an example of the generated code or documentation. Remove the timestamp output and verify that newly generated artifacts no longer contain the changing date while the remaining @Generated information is preserved.
Written by the indexing model from the issue text.
Assessment
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100