Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EPMRPP-90366 || Add descriptions for ActivityResource #24

Merged
merged 1 commit into from
May 22, 2024
Merged

EPMRPP-90366 || Add descriptions for ActivityResource #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions src/main/java/com/epam/reportportal/model/ActivityResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,46 +42,49 @@ public class ActivityResource {

@NotNull
@JsonProperty(value = "id", required = true)
@Schema(requiredMode = RequiredMode.REQUIRED)
@Schema(requiredMode = RequiredMode.REQUIRED, description = "The unique ID of the activity", example = "1")
private Long id;

@NotNull
@JsonProperty(value = "user", required = true)
@Schema(requiredMode = RequiredMode.REQUIRED)
@Schema(requiredMode = RequiredMode.REQUIRED, description = "The user who performed the activity", example = "user")
private String user;

@NotNull
@JsonProperty(value = "loggedObjectId", required = true)
@Schema(requiredMode = RequiredMode.REQUIRED)
@Schema(requiredMode = RequiredMode.REQUIRED, description = "The ID of the object on which activity was performed", example = "1")
private Long loggedObjectId;

@NotNull
@JsonProperty(value = "lastModified", required = true)
@Schema(requiredMode = RequiredMode.REQUIRED)
@Schema(requiredMode = RequiredMode.REQUIRED, description = "The time the activity was last modified", example = "2021-07-01T12:00:00Z")
private Instant lastModified;

@NotNull
@JsonProperty(value = "actionType", required = true)
@Schema(requiredMode = RequiredMode.REQUIRED)
@Schema(requiredMode = RequiredMode.REQUIRED, description = "The type of action performed", example = "startLaunch")
private String actionType;

@NotNull
@JsonProperty(value = "objectType", required = true)
@Schema(requiredMode = RequiredMode.REQUIRED)
@Schema(requiredMode = RequiredMode.REQUIRED, description = "The type of object on which the activity was performed", example = "LAUNCH")
private String objectType;

@NotNull
@JsonProperty(value = "projectId", required = true)
@Schema(requiredMode = RequiredMode.REQUIRED)
@Schema(requiredMode = RequiredMode.REQUIRED, description = "The ID of the project in which the activity was performed", example = "1")
private Long projectId;

@JsonProperty(value = "projectName")
@Schema(description = "The name of the project in which the activity was performed", example = "project")
private String projectName;

@JsonProperty(value = "details")
@Schema(description = "The details of the activity, for example history of value", example = "{\"history\": [{\"field\": \"status\", \"newValue\": \"FAILED\", \"oldValue\": \"PASSED\"}]}")
private Object details;

@JsonProperty(value = "objectName")
@Schema(description = "The name of the object on which the activity was performed", example = "Launch name")
private String objectName;

}
Loading