enriching model annotation metadata with @JsonProperty and @jsonformat where appropriate

Author: bdgould

gitlab4j-models/src/main/java/org/gitlab4j/api/models/AbstractEpic.java

@@ -35,60 +35,117 @@ public String toString() {
         }
     }
 
+    /**
+     * The internal identifier of the parent epic.
+     */
     @JsonProperty("parent_iid")
     private Long parentIid;
 
+    /**
+     * The description of the epic.
+     */
     @JsonProperty("description")
     private String description;
 
+    /**
+     * The state of the epic (e.g., open, closed).
+     */
     @JsonProperty("state")
     private EpicState state;
 
+    /**
+     * The web URL of the epic.
+     */
     @JsonProperty("web_url")
     private String webUrl;
 
+    /**
+     * The references associated with the epic.
+     */
     @JsonProperty("references")
     private References references;
 
+    /**
+     * The author of the epic.
+     */
     @JsonProperty("author")
     private Author author;
 
+    /**
+     * The list of labels associated with the epic.
+     */
     @JsonProperty("labels")
     private List<String> labels;
 
+    /**
+     * The start date of the epic.
+     * Expected in format "yyyy-MM-dd".
+     */
     @JsonProperty("start_date")
     @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
     private Date startDate;
 
+    /**
+     * The due date of the epic.
+     * Expected in format "yyyy-MM-dd".
+     */
     @JsonProperty("due_date")
     @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
     private Date dueDate;
 
+    /**
+     * The end date of the epic.
+     * Expected in format "yyyy-MM-dd".
+     */
     @JsonProperty("end_date")
     @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
     private Date endDate;
 
+    /**
+     * The date when the epic was created.
+     * Expected in ISO 8601 format (2019-03-15T08:00:00Z).
+     */
     @JsonProperty("created_at")
     @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ssXXX")
     private Date createdAt;
 
+    /**
+     * The date when the epic was last updated.
+     * Expected in ISO 8601 format (2019-03-15T08:00:00Z).
+     */
     @JsonProperty("updated_at")
     @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ssXXX")
     private Date updatedAt;
 
+    /**
+     * The date when the epic was closed.
+     * Expected in ISO 8601 format (2019-03-15T08:00:00Z).
+     */
     @JsonProperty("closed_at")
     @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ssXXX")
     private Date closedAt;
 
+    /**
+     * The number of downvotes for the epic.
+     */
     @JsonProperty("downvotes")
     private Integer downvotes;
 
+    /**
+     * The number of upvotes for the epic.
+     */
     @JsonProperty("upvotes")
     private Integer upvotes;
 
+    /**
+     * The color associated with the epic.
+     */
     @JsonProperty("color")
     private String color;
 
+    /**
+     * The links associated with the epic.
+     */
     @JsonProperty("_links")
     private Map<String, String> links;
 

gitlab4j-models/src/main/java/org/gitlab4j/api/models/AbstractGroup.java

@@ -11,21 +11,39 @@
 public abstract class AbstractGroup<G extends AbstractGroup<G>> implements Serializable {
     private static final long serialVersionUID = 1L;
 
+    /**
+     * The unique identifier of the group.
+     */
     @JsonProperty("id")
     private Long id;
 
+    /**
+     * The name of the group.
+     */
     @JsonProperty("name")
     private String name;
 
+    /**
+     * The avatar URL associated with the group.
+     */
     @JsonProperty("avatar_url")
     private String avatarUrl;
 
+    /**
+     * The web URL of the group.
+     */
     @JsonProperty("web_url")
     private String webUrl;
 
+    /**
+     * The full name of the group.
+     */
     @JsonProperty("full_name")
     private String fullName;
 
+    /**
+     * The full path of the group.
+     */
     @JsonProperty("full_path")
     private String fullPath;
 

gitlab4j-models/src/main/java/org/gitlab4j/api/models/AbstractIssue.java

@@ -46,121 +46,239 @@ public String toString() {
         }
     }
 
+    /**
+     * The assignee associated with the issue.
+     */
     @JsonProperty("assignee")
     private Assignee assignee;
 
+    /**
+     * The list of assignees associated with the issue.
+     */
     @JsonProperty("assignees")
     private List<Assignee> assignees;
 
+    /**
+     * The author of the issue.
+     */
     @JsonProperty("author")
     private Author author;
 
+    /**
+     * Indicates whether the issue is confidential.
+     */
     @JsonProperty("confidential")
     private Boolean confidential;
 
+    /**
+     * The date when the issue was created.
+     * Expected in ISO 8601 format (2019-03-15T08:00:00Z).
+     */
     @JsonProperty("created_at")
     @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ssXXX")
     private Date createdAt;
 
+    /**
+     * The date when the issue was last updated.
+     * Expected in ISO 8601 format (2019-03-15T08:00:00Z).
+     */
     @JsonProperty("updated_at")
     @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ssXXX")
     private Date updatedAt;
 
+    /**
+     * The date when the issue was closed.
+     * Expected in ISO 8601 format (2019-03-15T08:00:00Z).
+     */
     @JsonProperty("closed_at")
     @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ssXXX")
     private Date closedAt;
 
+    /**
+     * The user who closed the issue.
+     */
     @JsonProperty("closed_by")
     private User closedBy;
 
+    /**
+     * The description of the issue.
+     */
     @JsonProperty("description")
     private String description;
 
+    /**
+     * The due date of the issue.
+     * Expected in format "yyyy-MM-dd".
+     */
     @JsonProperty("due_date")
     @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
     private Date dueDate;
 
+    /**
+     * The actual ID of the issue.
+     */
     @JsonProperty("id")
     private ValueNode actualId;
 
+    /**
+     * The external ID of the issue (ignored during serialization).
+     */
     @JsonIgnore
     private String externalId;
 
+    /**
+     * The internal ID of the issue (ignored during serialization).
+     */
     @JsonIgnore
     private Long id;
 
+    /**
+     * The internal identifier for the issue.
+     */
     @JsonProperty("iid")
     private Long iid;
 
+    /**
+     * The labels associated with the issue.
+     */
     @JsonProperty("labels")
     private List<String> labels;
 
+    /**
+     * The milestone associated with the issue.
+     */
     @JsonProperty("milestone")
     private Milestone milestone;
 
+    /**
+     * The project ID associated with the issue.
+     */
     @JsonProperty("project_id")
     private Long projectId;
 
+    /**
+     * The state of the issue (e.g., open, closed).
+     */
     @JsonProperty("state")
     private IssueState state;
 
+    /**
+     * The title of the issue.
+     */
     @JsonProperty("title")
     private String title;
 
+    /**
+     * The count of user notes on the issue.
+     */
     @JsonProperty("user_notes_count")
     private Integer userNotesCount;
 
+    /**
+     * The web URL of the issue.
+     */
     @JsonProperty("web_url")
     private String webUrl;
 
+    /**
+     * The references associated with the issue.
+     */
     @JsonProperty("references")
     private References references;
 
+    /**
+     * The weight of the issue.
+     */
     @JsonProperty("weight")
     private Integer weight;
 
+    /**
+     * Indicates whether discussions on the issue are locked.
+     */
     @JsonProperty("discussion_locked")
     private Boolean discussionLocked;
 
+    /**
+     * The time statistics associated with the issue.
+     */
     @JsonProperty("time_stats")
     private TimeStats timeStats;
 
+    /**
+     * The severity of the issue.
+     */
     @JsonProperty("severity")
     private String severity;
 
+    /**
+     * The type of the issue.
+     */
     @JsonProperty("issue_type")
     private String issueType;
 
+    /**
+     * The epic associated with the issue.
+     */
     @JsonProperty("epic")
     private IssueEpic epic;
 
+    /**
+     * The upvotes for the issue.
+     */
     @JsonProperty("upvotes")
     private Integer upvotes;
 
+    /**
+     * The downvotes for the issue.
+     */
     @JsonProperty("downvotes")
     private Integer downvotes;
 
+    /**
+     * The number of merge requests associated with the issue.
+     */
     @JsonProperty("merge_requests_count")
     private Integer mergeRequestsCount;
 
+    /**
+     * Indicates whether the issue has tasks.
+     */
     @JsonProperty("has_tasks")
     private Boolean hasTasks;
 
+    /**
+     * The task status associated with the issue.
+     */
     @JsonProperty("task_status")
     private String taskStatus;
 
+    /**
+     * Indicates whether the issue has been imported.
+     */
     @JsonProperty("imported")
     private Boolean imported;
 
+    /**
+     * The source from which the issue was imported.
+     */
     @JsonProperty("imported_from")
     private String importedFrom;
 
+    /**
+     * The iteration associated with the issue.
+     */
     @JsonProperty("iteration")
     private Iteration iteration;
 
+    /**
+     * The task completion status associated with the issue.
+     */
     @JsonProperty("task_completion_status")
     private TaskCompletionStatus taskCompletionStatus;
 
+    /**
+     * The health status associated with the issue.
+     */
     @JsonProperty("health_status")
     private String healthStatus;